Mirrored_Repos/DarkflameServer
1
0
Fork 0
mirror of https://github.com/DarkflameUniverse/DarkflameServer.git synced 2024-11-08 17:28:20 +00:00
Code Issues Packages Projects Releases Wiki Activity
b1134b340f
DarkflameServer/Docker_Windows.md
David Markowitz bad3845d83
Address Docker issues and remove need to extract cdclient.fdb (#895) 
* Implement a server res directory

* Only convert if neither exist

* Remove unzip, Update RegEx

* readme updates

Run setup after setting working dir

Address several docker issues

Revert "Run setup after setting working dir"

This reverts commit fd2fb9228e82a350204c1ef61f7ba059479bb12f.

Fix docker

* Remove extra submodules

* Rework logic

* Switch if block

* Remove need to extract fdb from client

* Change log name

* Update FdbToSqlite.cpp
2023-01-06 23:04:20 -06:00

4.3 KiB
Raw Blame History

Installation under Windows

First Run

  1. Navigate to the Docker download page and download docker.

    Docker Download Page

  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

  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

  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 Dashboard Autostart

  8. Install Git for Windows. 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".

  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.

  14. Change the text after CLIENT_PATH= to the location of your client. This folder must contain either a folder client or legouniverse.exe.

    If you need the extra performance, place the client files in \\wsl$\<your linux OS>\... to avoid working across file systems, see Docker Best Practices and WSL documentation.

  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.

  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

  20. In the new window, paste (with right click) or type docker compose up -d --build and confirm with enter.

  21. Once you see the blinking cursor and the path again, setup has finished and the server is already running.

    setup done

  22. Create an admin account by pasting docker compose exec darkflame /app/MasterServer -a and following the prompts.

    admin account creation

  23. 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

  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