Addressing PR comments

This commit is contained in:
Jack Kawell 2021-12-14 00:08:08 -07:00
parent 0bad9d7186
commit f6a401ac6b
2 changed files with 15 additions and 9 deletions

1
.gitmodules vendored
View File

@ -10,6 +10,7 @@
[submodule "thirdparty/libbcrypt"] [submodule "thirdparty/libbcrypt"]
path = thirdparty/libbcrypt path = thirdparty/libbcrypt
url = https://github.com/trusch/libbcrypt.git url = https://github.com/trusch/libbcrypt.git
# TODO: Merge changes by TheNoim into lcdr's repo and use that
[submodule "thirdparty/docker-utils"] [submodule "thirdparty/docker-utils"]
path = thirdparty/docker-utils path = thirdparty/docker-utils
url = https://github.com/TheNoim/utils url = https://github.com/TheNoim/utils

View File

@ -2,25 +2,30 @@
## What you need ## What you need
- Docker (Docker Desktop or on Linux normal Docker) - [Docker](https://docs.docker.com/get-docker/) (Docker Desktop or on Linux normal Docker)
- Docker-Compose (Included in Docker Desktop) - [Docker Compose](https://docs.docker.com/compose/install/) (Included in Docker Desktop)
- LEGO® Universe Client - LEGO® Universe Client (packed or unpacked). Check the main [README](./README.md) for details on this.
## Run server inside Docker ## Run server inside Docker
1. Copy `.env.example` and save it as `.env` inside the root directory of this repository 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=` 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 need (be sure to update passwords!) 3. Update other values in the `.env` file as needed (be sure to update passwords!)
4. Run `docker compose up -d --build` 4. Run `docker compose up -d --build`
5. Run `docker compose exec darkflame /app/MasterServer -a` and setup your admin account 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. 6. Follow the directions [here](https://github.com/DarkflameUniverse/AccountManager) to setup regular user accounts. The server will be accessible at: `http://<EXTERNAL_IP>:5000`
7. You're ready to connect your client! 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 ## Disable brickbuildfix
If you don't need the http server running on port 80 do this: 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: 2. Paste this content:
```yml ```yml
@ -30,4 +35,4 @@ services:
- donotstart - donotstart
``` ```
3. Now run `docker compose up -d --build` or `docker-compose up -d --build` 3. Now run `docker compose up -d`