GitHub/ergo
3
0
Fork 0
mirror of https://github.com/ergochat/ergo.git synced 2024-11-10 22:19:31 +01:00
Code Issues Projects Releases Wiki Activity

update manual references to TLS certificate filenames

Browse Source
This commit is contained in:
Shivaram Lingamneni 2020-05-25 07:58:21 -04:00
parent 9a555f6f30
commit 1f501eab9a
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/MANUAL.md
View File

@ -140,7 +140,7 @@ The recommended way to operate oragono as a service on Linux is via systemd. Thi
The only major distribution that currently packages Oragono is Arch Linux; the aforementioned AUR package includes a systemd unit file. However, it should be fairly straightforward to set up a productionized Oragono on any Linux distribution. Here's a quickstart guide for Debian/Ubuntu: The only major distribution that currently packages Oragono is Arch Linux; the aforementioned AUR package includes a systemd unit file. However, it should be fairly straightforward to set up a productionized Oragono on any Linux distribution. Here's a quickstart guide for Debian/Ubuntu:
1. Create a dedicated, unprivileged role user who will own the oragono process and all its associated files: `adduser --system --group oragono`. This user now has a home directory at `/home/oragono`. 1. Create a dedicated, unprivileged role user who will own the oragono process and all its associated files: `adduser --system --group oragono`. This user now has a home directory at `/home/oragono`.
1. Copy the executable binary `oragono`, the config file `ircd.yaml`, the database `ircd.db`, and the self-signed TLS certificate (`tls.crt` and `tls.key`) to `/home/oragono`. Ensure that they are all owned by the new oragono role user: `sudo chown oragono:oragono /home/oragono/*`. Ensure that the configuration file logs to stderr. 1. Copy the executable binary `oragono`, the config file `ircd.yaml`, the database `ircd.db`, and the self-signed TLS certificate (`fullchain.pem` and `privkey.pem`) to `/home/oragono`. Ensure that they are all owned by the new oragono role user: `sudo chown oragono:oragono /home/oragono/*`. Ensure that the configuration file logs to stderr.
1. Install our example [oragono.service](https://github.com/oragono/oragono/blob/master/distrib/systemd/oragono.service) file to `/etc/systemd/system/oragono.service`. 1. Install our example [oragono.service](https://github.com/oragono/oragono/blob/master/distrib/systemd/oragono.service) file to `/etc/systemd/system/oragono.service`.
1. Enable and start the new service with the following commands: 1. Enable and start the new service with the following commands:
1. `systemctl daemon-reload` 1. `systemctl daemon-reload`
@ -159,9 +159,9 @@ The other major hurdle for productionizing (but one well worth the effort) is ob
set -eu set -eu
umask 077 umask 077
cp /etc/letsencrypt/live/example.com/fullchain.pem /home/oragono/tls.crt cp /etc/letsencrypt/live/example.com/fullchain.pem /home/oragono/
cp /etc/letsencrypt/live/example.com/privkey.pem /home/oragono/tls.key cp /etc/letsencrypt/live/example.com/privkey.pem /home/oragono/
chown oragono:oragono /home/oragono/tls.* chown oragono:oragono /home/oragono/*.pem
# rehash oragono, which will reload the certificates: # rehash oragono, which will reload the certificates:
systemctl reload oragono.service systemctl reload oragono.service
```` ````
@ -428,8 +428,8 @@ Many clients do not have this support. However, you can designate port 6667 as a
":6697": ":6697":
tls: tls:
key: tls.key cert: fullchain.pem
cert: tls.crt key: privkey.pem
sts: sts:
enabled: true enabled: true