diff --git a/README.md b/README.md index 8cbd26b..2040c8e 100644 --- a/README.md +++ b/README.md @@ -1 +1,83 @@ -# rogueserver \ No newline at end of file +# rogueserver + +# Hosting in Docker +It is advised that you host this in a docker container as it will be much easier to manage. +There is a sample docker-compose file for setting up a docker container to setup this server. + +# Self Hosting outside of Docker: +## Required Tools: +- Golang +- Node: **18.3.0** +- npm: [how to install](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) + +## Installation: +The docker compose file should automatically implement a container with mariadb with an empty database and the default user and password combo of pokerogue:pokerogue + +### src/utils.ts:224-225 (in pokerogue) +Replace both URLs (one on each line) with the local API server address from rogueserver.go (0.0.0.0:8001) (or whatever port you picked) + +# If you are on Windows + +Now that all of the files are configured: start up powershell as administrator: +``` +cd C:\api\server\location\ +go build . +.\rogueserver.exe --debug --dbuser yourusername --dbpass yourpassword +``` +The other available flags are located in rogueserver.go:34-43. + +Then in another run this the first time then run `npm run start` from the rogueserver location from then on: +``` +powershell -ep bypass +cd C:\server\location\ +npm install +npm run start +``` +You will need to allow the port youre running the API (8001) on and port 8000 to accept inbound connections through the [Windows Advanced Firewall](https://www.youtube.com/watch?v=9llH5_CON-Y). + +# If you are on Linux +In whatever shell you prefer, run the following: +``` +cd /api/server/location/ +go build . +./rogueserver --debug --dbuser yourusername --dbpass yourpassword & + +cd /server/location/ +npm run start +``` + +If you have a firewall running such as ufw on your linux machine, make sure to allow inbound connections on the ports youre running the API and the pokerogue server (8000,8001). +An example to allow incoming connections using UFW: +``` +sudo ufw allow 8000,8001/tcp +``` + +This should allow you to reach the game from other computers on the same network. + +## Tying to a Domain + +If you want to tie it to a domain like I did and make it publicly accessible, there is some extra work to be done. + +I setup caddy and would recommend using it as a reverse proxy. +[caddy installation](https://caddyserver.com/docs/install) +once its installed setup a config file for caddy: + +``` +pokerogue.exampledomain.com { + reverse_proxy localhost:8000 +} +pokeapi.exampledomain.com { + reverse_proxy localhost:8001 +} +``` +Preferably set up caddy as a service from [here.](https://caddyserver.com/docs/running) + +Once this is good to go, take your API url (https://pokeapi.exampledomain.com) and paste it on +### src/utils.ts:224-225 +in place of the previous 0.0.0.0:8001 address + +Make sure that both 8000 and 8001 are portforwarded on your router. + +Test that the server's game and game authentication works from other machines both in and outside of the network. Once this is complete, enjoy! + +