Browse Source

info: Go over rehashing and the REST API

tags/v0.9.0
Daniel Oaks 6 years ago
parent
commit
ba8c708318
1 changed files with 30 additions and 0 deletions
  1. 30
    0
      docs/INFO.md

+ 30
- 0
docs/INFO.md View File

@@ -42,6 +42,36 @@ linking properly. If anyone is interested in server protocols and wants to look
42 42
 me, please feel free to reach out!
43 43
 
44 44
 
45
+## Rehashing
46
+
47
+Rehashing is reloading the config files and TLS certificates. Of course, you can rehash the
48
+server by connect, opering-up and using the `/REHASH` command. However, similar to other
49
+IRCds, you can also make the server rehash by sending an appropriate signal to it!
50
+
51
+To make the server rehash from the command line, send it a `SIGHUP` signal. In *nix and OSX,
52
+you can do this by performing the following command:
53
+
54
+    killall -HUP oragono
55
+
56
+This will make the server rehash its configuration files and TLS certificates, and so can be
57
+useful if you're automatically updating your TLS certs!
58
+
59
+
60
+## REST API
61
+
62
+Oragono contains a draft, very early REST API implementation. My plans for this is to allow
63
+external web interfaces or other automated programs to monitor what's going on with the
64
+server, apply/remove bans, and to essentially allow administration of the server without
65
+being connected to it and opered-up. This sort of API mimics InspIRCd and Anope, which
66
+contain similar APIs.
67
+
68
+I'm not sure exactly how it's going to continue to be developed, and I'm sure there'll be
69
+lots of changes around appropriately restricting access to the API, which is why it's
70
+disabled for now and not exposed in our Docker builds. As well, while it's very unstable,
71
+the REST API doesn't count for our SemVer versioning. When this feature is more developed
72
+and I'm happy with where it's at, I'll provide proper support and documentation for the API.
73
+
74
+
45 75
 ## Rejected Features
46 76
 
47 77
 'Rejected' sounds harsh, but basically these are features I've decided I'm not gonna

Loading…
Cancel
Save