diff --git a/README.md b/README.md index 4884be6..33b908f 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,22 @@ Self-hosted pixel battle written in NodeJS -For now self hosting requires changes in code (in html/logic.js you must change WS configuration to connect) +# Deploying + +To deploy this pixelbattle, you need to: + +1. Clone this repo: + `git clone https://git.foxarmy.org/leca/pixelbattle` +2. Install node deps: + `npm update` +3. Run: + `npm run prod` + +That's it! + +# Tips & tricks + +1. Server settings are located in `./settings.json`, you need to change serverAddress in order to deploy + +2. When catches SIGUSR1, server will save a board with name read from settings file. SIGINT (CTRL + C) does the same but exit server when board is saved +