Bladeren bron

add a manual entry for rehash

tags/v2.5.0-rc1
Shivaram Lingamneni 3 jaren geleden
bovenliggende
commit
15406e0844
1 gewijzigde bestanden met toevoegingen van 19 en 6 verwijderingen
  1. 19
    6
      docs/MANUAL.md

+ 19
- 6
docs/MANUAL.md Bestand weergeven

@@ -23,8 +23,9 @@ _Copyright © Daniel Oaks <daniel@danieloaks.net>, Shivaram Lingamneni <slingamn
23 23
     - [Windows](#windows)
24 24
     - [macOS / Linux / Raspberry Pi](#macos--linux--raspberry-pi)
25 25
     - [Docker](#docker)
26
-    - [Environment variables](#environment-variables)
27 26
     - [Becoming an operator](#becoming-an-operator)
27
+    - [Rehashing](#rehashing)
28
+    - [Environment variables](#environment-variables)
28 29
     - [Productionizing](#productionizing)
29 30
     - [Upgrading to a new version of Oragono](#upgrading-to-a-new-version-of-oragono)
30 31
 - [Features](#features)
@@ -139,7 +140,22 @@ If you're using Arch Linux, you can also install the [`oragono` package](https:/
139 140
 For further information and a sample docker-compose file see the separate [Docker documentation](https://github.com/oragono/oragono/blob/master/distrib/docker/README.md).
140 141
 
141 142
 
142
-# Environment variables
143
+## Becoming an operator
144
+
145
+Many administrative actions on an IRC server are performed "in-band" as IRC commands sent from a client. The client in question must be an IRC operator ("oper", "ircop"). The easiest way to become an operator on your new Oragono instance is first to pick a strong, secure password, then "hash" it using the `oragono genpasswd` command (run `oragono genpasswd` from the command line, then enter your password twice), then copy the resulting hash into the `opers` section of your `ircd.yaml` file. Then you can become an operator by issuing the IRC command: `/oper admin mysecretpassword`.
146
+
147
+
148
+## Rehashing
149
+
150
+The primary way of configuring Oragono is by modifying the configuration file. Most changes to the configuration file can be applied at runtime by "rehashing", i.e., reloading the configuration file without restarting the server process. This has the advantage of not disconnecting users. There are two ways to rehash Oragono:
151
+
152
+1. If you are an operator with the `rehash` capability, you can issue the `/REHASH` command (you may have to `/quote rehash`, depending on your client)
153
+1. You can send the `SIGHUP` signal to Oragono, e.g., via `killall -HUP oragono`
154
+
155
+Rehashing also reloads TLS certificates and the MOTD. Some configuration settings cannot be altered by rehash. You can monitor either the response to the `/REHASH` command, or the server logs, to see if your rehash was successful.
156
+
157
+
158
+## Environment variables
143 159
 
144 160
 Oragono can also be configured using environment variables, using the following technique:
145 161
 
@@ -148,10 +164,7 @@ Oragono can also be configured using environment variables, using the following
148 164
 1. Prepend `ORAGONO` to the components, then join them all together using `__` as the separator, e.g., `ORAGONO__SERVER__WEBSOCKETS__ALLOWED_ORIGINS`.
149 165
 1. Set the environment variable of this name to a JSON (or YAML) value that will be deserialized into this config field, e.g., `export ORAGONO__SERVER__WEBSOCKETS__ALLOWED_ORIGINS='["https://irc.example.com", "https://chat.example.com"]'`
150 166
 
151
-
152
-## Becoming an operator
153
-
154
-Many administrative actions on an IRC server are performed "in-band" as IRC commands sent from a client. The client in question must be an IRC operator ("oper", "ircop"). The easiest way to become an operator on your new Oragono instance is first to pick a strong, secure password, then "hash" it using the `oragono genpasswd` command (run `oragono genpasswd` from the command line, then enter your password twice), then copy the resulting hash into the `opers` section of your `ircd.yaml` file. Then you can become an operator by issuing the IRC command: `/oper admin mysecretpassword`.
167
+However, settings that were overridden using this technique cannot be rehashed --- changing them will require restarting the server.
155 168
 
156 169
 
157 170
 ## Productionizing

Laden…
Annuleren
Opslaan