mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-11-06 11:18:54 -05:00
4637ff78c0
* Upgrade sphinx version to 1.7+ * Fix title overlines/underlines in autostart_systemd.rst * Skip trying to document a method from discord.py * Add escaped space after backtick * Escape underscores (sphinx tries to interpret a hyperlink) * Use fully qualified reference for class * Fix reference in tunnel.py * Remove python syntax highlighting in data_converter.py For some reason sphinx couldn't lex these as python. Removing the highlighting seems like the logical solution for now, since if it wasn't being lexed, it wouldn't highlight anyway. * Comment out static path since we're not using it right now * Update sphinx version in docs requirements too Would rather remove this duplication but RTD is a special snowflake
53 lines
1.5 KiB
ReStructuredText
53 lines
1.5 KiB
ReStructuredText
.. systemd service guide
|
||
|
||
==============================================
|
||
Setting up auto-restart using systemd on Linux
|
||
==============================================
|
||
|
||
-------------------------
|
||
Creating the service file
|
||
-------------------------
|
||
|
||
Create the new service file:
|
||
|
||
:code:`sudo nano /etc/systemd/system/red@.service`
|
||
|
||
Paste the following and replace all instances of :code:`username` with the username your bot is running under (hopefully not root):
|
||
|
||
.. code-block:: none
|
||
|
||
[Unit]
|
||
Description=%I redbot
|
||
After=multi-user.target
|
||
|
||
[Service]
|
||
ExecStart=/home/username/.local/bin/redbot %I --no-prompt
|
||
User=username
|
||
Group=username
|
||
Type=idle
|
||
Restart=always
|
||
RestartSec=15
|
||
|
||
[Install]
|
||
WantedBy=multi-user.target
|
||
|
||
Save and exit :code:`ctrl + O; enter; ctrl + x`
|
||
|
||
---------------------------------
|
||
Starting and enabling the service
|
||
---------------------------------
|
||
|
||
.. note:: This same file can be used to start as many instances of the bot as you wish, without creating more service files, just start and enable more services and add any bot instance name after the **@**
|
||
|
||
To start the bot, run the service and add the instance name after the **@**:
|
||
|
||
:code:`sudo systemctl start red@instancename`
|
||
|
||
To set the bot to start on boot, you must enable the service, again adding the instance name after the **@**:
|
||
|
||
:code:`sudo systemctl enable red@instancename`
|
||
|
||
To view Red’s log, you can acccess through journalctl:
|
||
|
||
:code:`sudo journalctl -u red@instancename`
|