Merge pull request #5 from VBMCBoy/readme-improvements

Readme: link to Docker Desktop and on stopping the server

Docker.md

@@ -2,7 +2,7 @@
 
 ## What you need
 
-- Docker (Docker Desktop or on Linux normal Docker)
+- Docker ([Docker Desktop](https://hub.docker.com/editions/community/docker-ce-desktop-mac/) or on Linux normal Docker)
 - Docker-Compose (Included in Docker Desktop)
 - LEGO® Universe Client
 
@@ -13,8 +13,9 @@
 3. Update other values in the `.env` file as need (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.
+6. Now you can see the output of the server with `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. Exit this with Ctrl+C.
 7. You're ready to connect your client!
+8. You can stop the server with `docker compose stop` and start it again with `docker compose up -d`
 
 ## Disable brickbuildfix
 
@@ -30,4 +31,4 @@ services:
       - donotstart
 ```
 
-3. Now run `docker compose up -d --build` or `docker-compose up -d --build`
+3. Now run `docker compose up -d --build`.

Docker_Windows.md

@@ -0,0 +1,53 @@
+# Installation under Windows
+## First Run
+1. Navigate to the [Docker download page](https://hub.docker.com/editions/community/docker-ce-desktop-mac/) and download docker.
+
+![Docker Download Page](docker/images/Docker_Download_Page.png)
+
+2. Once the file has finished downloading, run it and proceed through the installation. Make sure, "Install required Windows components for WSL 2" is checked.
+
+![Docker Desktop Installer Configuration](docker/images/Docker_Desktop_Installer_Configuration.png)
+
+3. If necessary, restart your computer.
+4. After the restart, Docker Desktop will automatically open. If it does not, simply start it like any other program.
+5. If a window "WSL 2 Installation is incomplete." pops up, follow the link and click "WSL2 Linux kernel update package for x64 machines". Run the downloaded file and once that finishes, click "Restart" in the Docker Desktop window.
+
+![WSL 2 download](docker/images/WSL_2_download.png)
+
+6. Wait until Docker Desktop has started. You may skip the tutorial.
+7. You may want to disable "OpenDocker Dashboard at startup" in _Settings_ -> _General_
+
+![Disable Autostart](docker/images/DD_General_Settings.png)
+
+8. Download the DarkflameServer repository and extract it to a location of your choice.
+9. Inside the extracted folder, copy `.env.example` and name the copy `.env`
+10. Open `.env` with notepad by right-clicking it and selecting _Open With_ -> _More apps_ -> _Notepad_.
+11. Change the text after `CLIENT_PATH=` to the location of your client. The folder you are pointing to must contain a folder called `client` which should contain the client files. Use `/` instead of `\`. For example, if you have `legouniverse.exe` at `C:\Users\someone\Downloads\LU\client\legouniverse.exe`, enter `C:/Users/someone/Downloads/LU`
+12. Optionally, you can change the number after `BUILD_THREADS=` to the number of cores / threads your processor has. If your computer crashes while building, you can try to reduce this value.
+13. After `ACCOUNT_MANAGER_SECRET=` paste a "SHA 256-bit Key" from https://keygen.io/
+14. If you are not only hosting a local server, change the value after `EXTERNAL_IP=` to the external IP address of your computer.
+15. Change the two values `SECRET_VALUE_CHANGE_ME` to passwords only you know. Save and close the file.
+16. In the extracted folder hit Shift+Right Click and select "Open PowerShell window here".
+
+![Open PowerShell](docker/images/Open_Powershell.png)
+
+17. In the new window, paste (with right click) or type `docker-compose up -d --build` and confirm with enter.
+18. Once you see the blinking cursor and the path again, setup has finished and the server is already running.
+
+![setup done](docker/images/setup_finished.png)
+
+19. Create an admin account by pasting `docker-compose exec darkflame /app/MasterServer -a` and following the prompts.
+
+![admin account creation](docker/images/Account_Creation.png)
+
+20. You can now login with these credentials at `http://your_ip:5000` (replace your_ip with your external IP). There you can create your account for playing as well as generate keys for other people to join; use these at `http://your_ip:5000/activate`
+
+## Normal Use
+1. In Docker Desktop you should now see an entry `darkflameserver-main` and when you click on it all containers but `DarkflameSetup` should eventually be green. That means the server is running.
+
+![server running](docker/images/Docker_Compose_Finished.png)
+
+2. For troubleshooting, you can check the logs of the various parts by clicking their entry.
+3. You can start and stop the server with the corresponding buttons. Once all containers are grey, the server has shut down, and when all containers but `DarkflameSetup` are green, the server is running. Note that starting and stopping takes some time, please be patient.
+
+![start stop buttons](docker/images/DD_Server_Startstop.png)