Headless Server Software/Docker: Difference between revisions

From Resonite Wiki
No edit summary
No edit summary
Line 6: Line 6:
#* Configuration files including JSON familiarity
#* Configuration files including JSON familiarity
#* Docker & Docker Compose
#* Docker & Docker Compose
#* Git
# A Patreon linked Resonite account that has access to the Headless Beta Code
# A Patreon linked Resonite account that has access to the Headless Beta Code
#* You only need ONE account to get the code.
#* You only need ONE account to get the code.
Line 15: Line 16:
# Use a separate Resonite account - A separate account causes less issues in the long term.
# Use a separate Resonite account - A separate account causes less issues in the long term.


== Install Docker ==
== Install Docker & Docker Compose ==
# Visit [https://docs.docker.com/get-docker/ Docker's Get Docker] page
# Visit [https://docs.docker.com/get-docker/ Docker's Get Docker] page
# Follow instructions for your operating system
# 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 [https://docs.docker.com/compose/install/ 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 <code>docker run hello-world</code>
#* If all goes well, you'll see a pleasant message from Docker telling you that everything worked.
#* Run <code>docker compose version</code> to verify that you also have Docker Compose, you should see the Docker Compose version printed.

Revision as of 05:57, 13 March 2024

This article or section is a Stub. You can help the Resonite Wiki by expanding it.


Prerequisites

  1. Basic familiarity with:
    • Command Line Systems
    • Configuration files including JSON familiarity
    • Docker & Docker Compose
    • Git
  2. 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:

  1. 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.
  2. 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.
  3. Use a separate Resonite account - A separate account causes less issues in the long term.

Install Docker & Docker Compose

  1. Visit Docker's Get Docker page
  2. Follow instructions for your operating system
  3. 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:

  1. Open a terminal window
  2. 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.