When it comes time to deploy your bot to a server, we recommend using gunicorn and nginx. The following information will help you run the bot under gunicorn with nginx as its reverse proxy.
This information is adapted from the Deploying Gunicorn document, you may wish to head to it for more advanced setups.
Before starting, it is important to have nginx and the appropriate Python 3 packages installed.
sudo apt install nginx python3 python3-pip python3-virtualenvCreate a virtualenv for SparkBot with the required packages. This will keep system-level Python packages separate from your SparkBot packages.
It's a good idea to create a new service account with the bare minimum permissions for Sparkbot:
sudo useradd --system --create-home sparkbotNow, log in to the sparkbot user so we can install the virtualenv:
sudo -Hu sparkbot /bin/bashFinally, create the virtualenv and install SparkBot into it:
python3 -m virtualenv --python=python3 /home/sparkbot/sparkbotenv
source /home/sparkbot/sparkbotenv/bin/activate
pip install git+https://github.com/universalsuperbox/SparkBot.git gunicorn
deactivate
exitThis guide assumes that your SparkBot script is called run.py and is placed at /home/sparkbot/run.py. If your script is named differently, change run in run:bot.receiver in the ExecStart entry to the script's name (without .py). If your script is located in a different directory, change the WorkingDirectory.
We'll use nginx to proxy requests to the bot. You may use this configuration as a template for your reverse proxy for the bot's webhook receiver:
/_static/sparkbot-nginx.conf
Remember to set the server_name property to the FQDN of your server.
It is highly recommended to use HTTPS for this reverse proxy, but setting that up is outside of the scope of this guide.
First, we'll add a unit file for the Gunicorn socket. This goes at /etc/systemd/system/sparkbot.socket:
/_static/sparkbot.socket
Next, create the file /etc/systemd/system/sparkbot.service with the following content. Once finished, save and close the file then run systemctl daemon-reload:
/_static/sparkbot.service
Next, run systemctl edit sparkbot.service and enter the following, changing the options in curly brackets to match your desired settings:
/_static/sparkbot.service.edit
The values should be the same as the ones you used when you followed the Quickstart guide </quickstart>.
Once that's finished, run the following to enable the bot on startup:
sudo systemctl daemon-reload
sudo systemctl enable sparkbot.socket
sudo systemctl enable sparkbot.service
sudo systemctl start sparkbot.socket
sudo systemctl start sparkbot.service