This article or section is a Stub. You can help the Resonite Wiki by expanding it.
Prerequisites
- Basic familiarity with:
- Command Line Systems
- Configuration files including JSON familiarity
- Docker & Docker Compose
- Git
- A Patreon linked Resonite account that has access to the Headless Beta Code
- You only need ONE account to get the code.
Recommendations
Before you get started here are some recommendations:
- Use a non-windows machine - While this setup works for Windows, Docker on windows can break depending on your CPU, Operating System setup and even sometimes the motherboard. For less issues, stay off windows.
- Use a separate machine - It is not recommended to run a headless on the same machine that you run Resonite on. This could lead to performance issues for both clients if you run them both at the same time.
- Use a separate Resonite account - A separate account causes less issues in the long term.
Install Docker & Docker Compose
- Visit Docker's Get Docker page
- Follow instructions for your operating system
- Ensure you also have Docker Compose. Depending on your setup, this may be included already but if not there's a Docker documentation page which has the details.
Test Docker Setup
To verify that docker is setup on your machine and working correctly:
- Open a terminal window
- Enter
docker run hello-world
- If all goes well, you'll see a pleasant message from Docker telling you that everything worked.
- Run
docker compose version
to verify that you also have Docker Compose, you should see the Docker Compose version printed.