Skip to content

Commit

Permalink
Create instructions.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KTRosenberg authored May 2, 2024
1 parent c286edd commit e275b4d
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
### Instructions

* In order to start the backend, you need to execute 'run' or 'run.bat' depending on your OS
* Otherwise, you can call `pm2 stop all` / `pm2 restart all` should you encounter critical errors
* Specify which branch you want to update for submodule in .gitmodules and update it with
```git submodule update --remote```

* Helpful commands
```$./run```
```$./stop```

* * To then restart the server again, type:
```$pm2 reload all```

* * If you want to bring the server logs back on-line to check them after hitting control-c, type:
```$pm2 logs all```

* * If you want the server to run on system startup (tested on Unix based OS) type:
```$./persist```

* * Make sure the submodule is up-to-date
```$git submodule foreach git pull origin master```

Note: the server keys do not work / security is not compromised via these stale keys.

0 comments on commit e275b4d

Please sign in to comment.