Skip to content

Latest commit

 

History

History
35 lines (26 loc) · 1.75 KB

README.md

File metadata and controls

35 lines (26 loc) · 1.75 KB
Raw

BasicDockerHeadlessSetup

A very simple docker setup for a Headless Resonite Session, it uses Shadow Panther's Docker Image.

Setup

Recommended for Beginners

If you're new to Docker, Docker Compose or git, we'd recommend you use our wiki guide on how to use this repo.

Quick Instructions

  1. Setup Docker & Docker Compose on your target machine.
  2. git clone.
  3. Create an .env file.
  4. Add a line: RES_HEADLESS_CODE=<Headless Code> where <Headless Code> is replaced by the code you get from the Resonite Bot.
  5. Add a line: RES_STEAM_LOGIN=<Steam Username> <Steam Password> where <Steam Username> and <Steam Password> are replaced with the username and password of a valid Steam account.
    • We recommend using a separate Steam account from the one you use to play Resonite.
    • It does not need to own any games.
    • It does not need to also be a Patreon on Resonite.
  6. Run docker compose up.

Goals for this Repository

This repository is designed to be as stable and simple as possible when it comes to headless operations:

  • It is meant to be used for a "Try This" style approach.
  • It is not meant for a "Production" headless setup.

To that end, before contributing keep in mind our goals:

  1. Keep it simple.
  2. Keep it stable.
  3. Avoid any additional software.
  4. Avoid any additional credentials.

Where to go Next?

It is likely we'll create other repositories with more complex setups in the future, we'll link to them from here when we do. Until then remember to check our wiki's page on Headless Servers.