Add instructions for setting up supervisor
This commit is contained in:
parent
95d6ac34a7
commit
e554bda3eb
|
@ -4,6 +4,8 @@ Provides an API to the web client and web server to serve tool data and authenti
|
|||
|
||||
## Setup
|
||||
|
||||
### Initial run
|
||||
|
||||
```
|
||||
$ sudo apt install python3 python3-pip python3-virtualenv # for Debian
|
||||
$ virtualenv -p python3 env
|
||||
|
@ -20,6 +22,29 @@ Once logged in, navigate to "Profiles" and make your Protospace user a lockout a
|
|||
|
||||
Now you have total control of the system and can make other users lockout admins though the API or web interface.
|
||||
|
||||
### Supervisor
|
||||
|
||||
Supervisor is used to keep the script always running.
|
||||
|
||||
```
|
||||
$ sudo apt install supervisor
|
||||
```
|
||||
|
||||
Create a file named /etc/supervisor/conf.d/authserver.conf and add:
|
||||
|
||||
```
|
||||
[program:authserver]
|
||||
user=tanner
|
||||
directory=/opt/pslockout/pslockout/authserver
|
||||
command=/bin/bash -c 'source env/bin/activate && python manage.py runserver 0.0.0.0:8000'
|
||||
autostart=true
|
||||
autorestart=true
|
||||
stderr_logfile=/var/log/authserver.log
|
||||
stderr_logfile_maxbytes=1MB
|
||||
stdout_logfile=/var/log/authserver.log
|
||||
stdout_logfile_maxbytes=1MB
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
The API is RESTful and returns hyperlinked json data. **URLs require a trailing slash.**
|
||||
|
|
28
webserver/README.md
Normal file
28
webserver/README.md
Normal file
|
@ -0,0 +1,28 @@
|
|||
# Protospace lockout socket server
|
||||
|
||||
Runs on a server. Connects to web clients over web sockets and receives updates from all lockouts.
|
||||
|
||||
## Setup
|
||||
|
||||
### Supervisor
|
||||
|
||||
Supervisor is used to keep the script always running.
|
||||
|
||||
```
|
||||
$ sudo apt install supervisor
|
||||
```
|
||||
|
||||
Create a file named /etc/supervisor/conf.d/webserver.conf and add:
|
||||
|
||||
```
|
||||
[program:webserver]
|
||||
user=tanner
|
||||
directory=/opt/pslockout/pslockout/webserver
|
||||
command=/bin/bash -c 'yarn start'
|
||||
autostart=true
|
||||
autorestart=true
|
||||
stderr_logfile=/var/log/webserver.log
|
||||
stderr_logfile_maxbytes=1MB
|
||||
stdout_logfile=/var/log/webserver.log
|
||||
stdout_logfile_maxbytes=1MB
|
||||
```
|
Loading…
Reference in New Issue
Block a user