Ver código fonte

make systemd and letsencrypt two separate manual sections

tags/v2.6.0-rc1
Shivaram Lingamneni 3 anos atrás
pai
commit
72f41f6b3f
1 arquivos alterados com 9 adições e 4 exclusões
  1. 9
    4
      docs/MANUAL.md

+ 9
- 4
docs/MANUAL.md Ver arquivo

@@ -26,7 +26,8 @@ _Copyright © Daniel Oaks <daniel@danieloaks.net>, Shivaram Lingamneni <slingamn
26 26
     - [Becoming an operator](#becoming-an-operator)
27 27
     - [Rehashing](#rehashing)
28 28
     - [Environment variables](#environment-variables)
29
-    - [Productionizing](#productionizing)
29
+    - [Productionizing with systemd](#productionizing-with-systemd)
30
+    - [Using valid TLS certificates](#using-valid-tls-certificates)
30 31
     - [Upgrading to a new version of Oragono](#upgrading-to-a-new-version-of-oragono)
31 32
 - [Features](#features)
32 33
     - [User Accounts](#user-accounts)
@@ -174,7 +175,7 @@ Oragono can also be configured using environment variables, using the following
174 175
 However, settings that were overridden using this technique cannot be rehashed --- changing them will require restarting the server.
175 176
 
176 177
 
177
-## Productionizing
178
+## Productionizing with systemd
178 179
 
179 180
 The recommended way to operate oragono as a service on Linux is via systemd. This provides a standard interface for starting, stopping, and rehashing (via `systemctl reload`) the service. It also captures oragono's loglines (sent to stderr in the default configuration) and writes them to the system journal.
180 181
 
@@ -189,6 +190,12 @@ The only major distribution that currently packages Oragono is Arch Linux; the a
189 190
     1. `systemctl start oragono.service`
190 191
     1. Confirm that the service started correctly with `systemctl status oragono.service`
191 192
 
193
+
194
+On a non-systemd system, oragono can be configured to log to a file and used [logrotate(8)](https://linux.die.net/man/8/logrotate), since it will reopen its log files (as well as rehashing the config file) upon receiving a SIGHUP. To rehash manually outside the context of log rotation, you can use `killall -HUP oragono` or `pkill -HUP oragono`.
195
+
196
+
197
+## Using valid TLS certificates
198
+
192 199
 The other major hurdle for productionizing (but one well worth the effort) is obtaining valid TLS certificates for your domain, if you haven't already done so:
193 200
 
194 201
 1. The simplest way to get valid TLS certificates is from [Let's Encrypt](https://letsencrypt.org/) with [Certbot](https://certbot.eff.org/). The correct procedure will depend on whether you are already running a web server on port 80. If you are, follow the guides on the Certbot website; if you aren't, you can use `certbot certonly --standalone --preferred-challenges http -d example.com` (replace `example.com` with your domain).
@@ -211,8 +218,6 @@ Executing this script manually will install the certificates for the first time
211 218
 
212 219
 If you are using Certbot 0.29.0 or higher, you can also change the ownership of the files under `/etc/letsencrypt` so that the oragono user can read them, as described in the [UnrealIRCd documentation](https://www.unrealircd.org/docs/Setting_up_certbot_for_use_with_UnrealIRCd#Tweaking_permissions_on_the_key_file).
213 220
 
214
-On a non-systemd system, oragono can be configured to log to a file and used [logrotate(8)](https://linux.die.net/man/8/logrotate), since it will reopen its log files (as well as rehashing the config file) upon receiving a SIGHUP. To rehash manually outside the context of log rotation, you can use `killall -HUP oragono` or `pkill -HUP oragono`.
215
-
216 221
 
217 222
 ## Upgrading to a new version of Oragono
218 223
 

Carregando…
Cancelar
Salvar