| 1 |
Ergo init script for bsd-rc |
| 2 |
=== |
| 3 |
|
| 4 |
Written for and tested using FreeBSD. |
| 5 |
|
| 6 |
## Installation |
| 7 |
Copy the `ergo` file from this folder to `/etc/rc.d/ergo`, |
| 8 |
permissions should be `555`. |
| 9 |
|
| 10 |
You should create a system user for Ergo. |
| 11 |
This script defaults to running Ergo as a user named `ergo`, |
| 12 |
but that can be changed using `/etc/rc.conf`. |
| 13 |
|
| 14 |
Here are all `rc.conf` variables and their defaults: |
| 15 |
- `ergo_enable`, defaults to `NO`. Whether to run `ergo` at system start. |
| 16 |
- `ergo_user`, defaults to `ergo`. Run using this user. |
| 17 |
- `ergo_group`, defaults to `ergo`. Run using this group. |
| 18 |
- `ergo_chdir`, defaults to `/var/db/ergo`. Path to the working directory for the server. Should be writable for `ergo_user`. |
| 19 |
- `ergo_conf`, defaults to `/usr/local/etc/ergo/ircd.yaml`. Config file path. Make sure `ergo_user` can read it. |
| 20 |
|
| 21 |
This script assumes ergo to be installed at `/usr/local/bin/ergo`. |
| 22 |
|
| 23 |
## Usage |
| 24 |
|
| 25 |
```shell |
| 26 |
/etc/rc.d/ergo <command> |
| 27 |
``` |
| 28 |
In addition to the obvious `start` and `stop` commands, this |
| 29 |
script also has a `reload` command that sends `SIGHUP` to the Ergo process. |