Document assorted files that are useful for running RhinoReminds as a system service

This commit is contained in:
Starbeamrainbowlabs 2019-02-12 19:28:31 +00:00
parent a4d996fb3d
commit 09669d9acf
Signed by: sbrl
GPG key ID: 1BE5172E637709C2
2 changed files with 8 additions and 1 deletions

2
.gitignore vendored
View file

@ -1,4 +1,4 @@
*.backup
# Created by https://www.gitignore.io/api/monodevelop,visualstudio,csharp,git
# Edit at https://www.gitignore.io/?templates=monodevelop,visualstudio,csharp,git

View file

@ -39,6 +39,13 @@ mono [--debug] RhinoReminds.exe [--help]
RhinoReminds.exe [--help]
```
### Setting up RhinoReminds as a system service
Some helpful template files are located in this repository to aid in setting _RhinoReminds_ up as a system service.
- [`start_service.sh`](https://git.starbeamrainbowlabs.com/sbrl/RhinoReminds/src/branch/master/start_service.sh) Contains a script that reads in CLI variables from a file, sets up a PID file directory with the appropriate permissions, and then executes _RhinoReminds_ as an unprivileged user.
- [`rhinoreminds.service`](https://git.starbeamrainbowlabs.com/sbrl/RhinoReminds/src/branch/master/rhinoreminds.service) Contains a systemd service file compatible with `start_service.sh`
- [`rhinoreminds-rsyslog.conf`](https://git.starbeamrainbowlabs.com/sbrl/RhinoReminds/src/branch/master/rhinoreminds-rsyslog.conf) Contains an Rsyslog definition file compatible with the systemd service file defined above. When put in `/etc/rsyslog.d` (don't forget to restart the `rsyslog` service!), it will write and auto-rotate log files of the standard output and standard error of the main _RhinoReminds_ process to a subfolder fo `/var/log` automatically.
## Usage
The bot operates on natural language instructions. It picks what to do from the first word in the sentence, but the rest is parsed via AI.