From be008ca4392c19480490bbecbc2cb21ace0205e6 Mon Sep 17 00:00:00 2001 From: Kay Kaprolat Date: Thu, 30 Dec 2021 17:11:25 +0100 Subject: [PATCH 1/9] Indent all images --- Docker_Windows.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/Docker_Windows.md b/Docker_Windows.md index dbc10824..4d81c76c 100644 --- a/Docker_Windows.md +++ b/Docker_Windows.md @@ -2,22 +2,22 @@ ## 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) + ![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) + ![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) + ![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) + ![Disable Autostart](docker/images/DD_General_Settings.png) 8. Install [Git for Windows](https://git-scm.com/download/win). During the installation, simply confirming the defaults is sufficient. 9. In the folder you wish to save the Server, right click and select "Git Bash Here". @@ -32,25 +32,25 @@ 18. Change the two values `SECRET_VALUE_CHANGE_ME` to passwords only you know. Save and close the file. 19. In the extracted folder hit Shift+Right Click and select "Open PowerShell window here". -![Open PowerShell](docker/images/Open_Powershell.png) + ![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) + ![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) + ![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) + ![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) + ![start stop buttons](docker/images/DD_Server_Startstop.png) From 8af1c92effbb012e6f31233075c27ab983cfba26 Mon Sep 17 00:00:00 2001 From: Kay Kaprolat Date: Thu, 30 Dec 2021 17:13:07 +0100 Subject: [PATCH 2/9] Fix typo in step 7 --- Docker_Windows.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Docker_Windows.md b/Docker_Windows.md index 4d81c76c..cc7531e6 100644 --- a/Docker_Windows.md +++ b/Docker_Windows.md @@ -15,7 +15,7 @@ ![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_ +7. You may want to disable "Open Docker Dashboard at startup" in _Settings_ -> _General_ ![Disable Autostart](docker/images/DD_General_Settings.png) From da0be9f2267e5b8ca2be9b2c10ec382542655d6f Mon Sep 17 00:00:00 2001 From: Kay Kaprolat Date: Thu, 30 Dec 2021 17:13:37 +0100 Subject: [PATCH 3/9] Clarify alt-text of step 7 --- Docker_Windows.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Docker_Windows.md b/Docker_Windows.md index cc7531e6..4e7cdee9 100644 --- a/Docker_Windows.md +++ b/Docker_Windows.md @@ -17,7 +17,7 @@ 6. Wait until Docker Desktop has started. You may skip the tutorial. 7. You may want to disable "Open Docker Dashboard at startup" in _Settings_ -> _General_ - ![Disable Autostart](docker/images/DD_General_Settings.png) + ![Disable Dashboard Autostart](docker/images/DD_General_Settings.png) 8. Install [Git for Windows](https://git-scm.com/download/win). During the installation, simply confirming the defaults is sufficient. 9. In the folder you wish to save the Server, right click and select "Git Bash Here". From 1e7a2febea4b09c10285415fbf2dc8910e614b49 Mon Sep 17 00:00:00 2001 From: Kay Kaprolat Date: Thu, 30 Dec 2021 19:19:27 +0100 Subject: [PATCH 4/9] Fix Docker Desktop download link --- Docker_Windows.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Docker_Windows.md b/Docker_Windows.md index 4e7cdee9..8c627b49 100644 --- a/Docker_Windows.md +++ b/Docker_Windows.md @@ -1,6 +1,6 @@ # 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. +1. Navigate to the [Docker download page](https://www.docker.com/products/docker-desktop) and download docker. ![Docker Download Page](docker/images/Docker_Download_Page.png) From 64edb88d36ebfca542b5c4ed3cb78551e58c93d5 Mon Sep 17 00:00:00 2001 From: Kay Kaprolat Date: Thu, 30 Dec 2021 19:21:53 +0100 Subject: [PATCH 5/9] Changed docker-compose to docker compose --- Docker_Windows.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Docker_Windows.md b/Docker_Windows.md index 8c627b49..5a4017a6 100644 --- a/Docker_Windows.md +++ b/Docker_Windows.md @@ -34,12 +34,12 @@ ![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. +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. +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) From 0a737eaa0d03d7c98144cbc37dbefded7a777955 Mon Sep 17 00:00:00 2001 From: Kay Kaprolat Date: Thu, 30 Dec 2021 19:35:06 +0100 Subject: [PATCH 6/9] Add note about client files and linux performance --- Docker_Windows.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Docker_Windows.md b/Docker_Windows.md index 5a4017a6..62802560 100644 --- a/Docker_Windows.md +++ b/Docker_Windows.md @@ -26,6 +26,8 @@ 12. Inside the downloaded folder, copy `.env.example` and name the copy `.env` 13. Open `.env` with notepad by right-clicking it and selecting _Open With_ -> _More apps_ -> _Notepad_. 14. 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` + > If you need the extra performance, place the client files in `\\wsl$\` + 15. 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. 16. After `ACCOUNT_MANAGER_SECRET=` paste a "SHA 256-bit Key" from https://keygen.io/ 17. If you are not only hosting a local server, change the value after `EXTERNAL_IP=` to the external IP address of your computer. From 0bf03cb66e8ae28aaf088cb333f475428158e449 Mon Sep 17 00:00:00 2001 From: Nils Bergmann Date: Fri, 31 Dec 2021 13:57:53 +0100 Subject: [PATCH 7/9] Update Docker_Windows.md Co-authored-by: Marcono1234 --- Docker_Windows.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Docker_Windows.md b/Docker_Windows.md index 62802560..966f0dc9 100644 --- a/Docker_Windows.md +++ b/Docker_Windows.md @@ -26,7 +26,7 @@ 12. Inside the downloaded folder, copy `.env.example` and name the copy `.env` 13. Open `.env` with notepad by right-clicking it and selecting _Open With_ -> _More apps_ -> _Notepad_. 14. 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` - > If you need the extra performance, place the client files in `\\wsl$\` + > If you need the extra performance, place the client files in `\\wsl$\\...` to avoid working across file systems, see [Docker Best Practices](https://docs.docker.com/desktop/windows/wsl/#best-practices) and [WSL documentation](https://docs.microsoft.com/en-us/windows/wsl/filesystems#file-storage-and-performance-across-file-systems). 15. 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. 16. After `ACCOUNT_MANAGER_SECRET=` paste a "SHA 256-bit Key" from https://keygen.io/ From bb1c7095d7526cb4ef902d5ecd9b95a22d5d4f17 Mon Sep 17 00:00:00 2001 From: Nils Bergmann Date: Fri, 31 Dec 2021 13:58:09 +0100 Subject: [PATCH 8/9] Update Docker_Windows.md Co-authored-by: Marcono1234 --- Docker_Windows.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Docker_Windows.md b/Docker_Windows.md index 966f0dc9..25f1f964 100644 --- a/Docker_Windows.md +++ b/Docker_Windows.md @@ -24,7 +24,7 @@ 10. Type `git clone --recursive https://github.com/DarkflameUniverse/DarkflameServer` 11. Once the command has completed (you can see you path again and can enter commands), close the window. 12. Inside the downloaded folder, copy `.env.example` and name the copy `.env` -13. Open `.env` with notepad by right-clicking it and selecting _Open With_ -> _More apps_ -> _Notepad_. +13. Open `.env` with Notepad by right-clicking it and selecting _Open With_ -> _More apps_ -> _Notepad_. 14. 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` > If you need the extra performance, place the client files in `\\wsl$\\...` to avoid working across file systems, see [Docker Best Practices](https://docs.docker.com/desktop/windows/wsl/#best-practices) and [WSL documentation](https://docs.microsoft.com/en-us/windows/wsl/filesystems#file-storage-and-performance-across-file-systems). From 4198379aa899e6db4569f116dd81b802240ee5c8 Mon Sep 17 00:00:00 2001 From: Kay Kaprolat Date: Sun, 2 Jan 2022 10:24:01 +0100 Subject: [PATCH 9/9] Removed unnecessary note about slashes --- Docker_Windows.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Docker_Windows.md b/Docker_Windows.md index 25f1f964..1cc633cc 100644 --- a/Docker_Windows.md +++ b/Docker_Windows.md @@ -25,7 +25,7 @@ 11. Once the command has completed (you can see you path again and can enter commands), close the window. 12. Inside the downloaded folder, copy `.env.example` and name the copy `.env` 13. Open `.env` with Notepad by right-clicking it and selecting _Open With_ -> _More apps_ -> _Notepad_. -14. 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` +14. 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. > If you need the extra performance, place the client files in `\\wsl$\\...` to avoid working across file systems, see [Docker Best Practices](https://docs.docker.com/desktop/windows/wsl/#best-practices) and [WSL documentation](https://docs.microsoft.com/en-us/windows/wsl/filesystems#file-storage-and-performance-across-file-systems). 15. 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.