From f6a401ac6b4815995600818c9901df514b2dce6c Mon Sep 17 00:00:00 2001 From: Jack Kawell Date: Tue, 14 Dec 2021 00:08:08 -0700 Subject: [PATCH] Addressing PR comments --- .gitmodules | 1 + Docker.md | 23 ++++++++++++++--------- 2 files changed, 15 insertions(+), 9 deletions(-) diff --git a/.gitmodules b/.gitmodules index 7ed19969..e4db86cf 100644 --- a/.gitmodules +++ b/.gitmodules @@ -10,6 +10,7 @@ [submodule "thirdparty/libbcrypt"] path = thirdparty/libbcrypt url = https://github.com/trusch/libbcrypt.git +# TODO: Merge changes by TheNoim into lcdr's repo and use that [submodule "thirdparty/docker-utils"] path = thirdparty/docker-utils url = https://github.com/TheNoim/utils diff --git a/Docker.md b/Docker.md index b1069840..3dfc2a50 100644 --- a/Docker.md +++ b/Docker.md @@ -2,25 +2,30 @@ ## What you need -- Docker (Docker Desktop or on Linux normal Docker) -- Docker-Compose (Included in Docker Desktop) -- LEGO® Universe Client +- [Docker](https://docs.docker.com/get-docker/) (Docker Desktop or on Linux normal Docker) +- [Docker Compose](https://docs.docker.com/compose/install/) (Included in Docker Desktop) +- LEGO® Universe Client (packed or unpacked). Check the main [README](./README.md) for details on this. ## Run server inside Docker 1. Copy `.env.example` and save it as `.env` inside the root directory of this repository -2. Edit the `.env` file and add your path to your LEGO® Universe Client after `CLIENT_PATH=` -3. Update other values in the `.env` file as need (be sure to update passwords!) +2. Edit the `.env` file and add your path to the root directory of your LEGO® Universe Client after `CLIENT_PATH=` +3. Update other values in the `.env` file as needed (be sure to update passwords!) 4. Run `docker compose up -d --build` 5. Run `docker compose exec darkflame /app/MasterServer -a` and setup your admin account -6. Now you can see the output of the server with `docker compose logs -f --tail 100` or `docker compose logs -f --tail 100`. This can help you understand issues and there you can also see when the server finishes it's startup. -7. You're ready to connect your client! +6. Follow the directions [here](https://github.com/DarkflameUniverse/AccountManager) to setup regular user accounts. The server will be accessible at: `http://:5000` +7. Now you can see the output of the server with `docker compose logs -f --tail 100` or `docker compose logs -f --tail 100`. This can help you understand issues and there you can also see when the server finishes it's startup. +8. You're ready to connect your client! + +**NOTE #1**: If you're running an older version of Docker, you may need to use the command `docker-compose` instead of `docker compose`. + +**NOTE #2**: To stop the server simply run `docker compose down` and to restart it just run `docker compose up -d` again. No need to run all the steps above every time. ## Disable brickbuildfix If you don't need the http server running on port 80 do this: -1. Create a file with the name `docker-compose.override.yml` +1. Create a file with the name `docker-compose.override.yml` in the root of the repository 2. Paste this content: ```yml @@ -30,4 +35,4 @@ services: - donotstart ``` -3. Now run `docker compose up -d --build` or `docker-compose up -d --build` \ No newline at end of file +3. Now run `docker compose up -d` \ No newline at end of file