Переглянути джерело

document logging methods

tags/v1.0.0-rc1
Shivaram Lingamneni 5 роки тому
джерело
коміт
44a0770215
2 змінених файлів з 10 додано та 3 видалено
  1. 1
    1
      README.md
  2. 9
    2
      docs/MANUAL.md

+ 1
- 1
README.md Переглянути файл

@@ -94,7 +94,7 @@ You can use the `--conf` parameter when launching Oragono to control where it lo
94 94
 
95 95
 ### Logs
96 96
 
97
-By default, logs are stored in the file `ircd.log`. The configuration format of logs is designed to be easily pluggable, and is inspired by the logging config provided by InspIRCd.
97
+By default, logs go to stderr only. They can be configured to go to a file, or you can use systemd to direct the stderr to the system journal (see the manual for details). The configuration format of logs is designed to be easily pluggable, and is inspired by the logging config provided by InspIRCd.
98 98
 
99 99
 ### Passwords
100 100
 

+ 9
- 2
docs/MANUAL.md Переглянути файл

@@ -103,9 +103,16 @@ To get started with Oragono on macOS, Linux, or on a Raspberry Pi:
103 103
 
104 104
 To start the server, type `./oragono run` and hit enter, and the server should be ready to use!
105 105
 
106
-If you're using Arch Linux, you can also install the [`oragono` package](https://aur.archlinux.org/packages/oragono/) from the AUR. This lets you bypass the above process and bundles a systemd service file for easily starting the server.
106
+If you're using Arch Linux, you can also install the [`oragono` package](https://aur.archlinux.org/packages/oragono/) from the AUR.
107 107
 
108
-If you're rolling your own deployment, here's another [example](https://github.com/darwin-network/slash/blob/master/etc/systemd/system/ircd.service) of a systemd unit file that can be used to run Oragono as an unprivileged role user.
108
+
109
+## Running oragono as a service on Linux
110
+
111
+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.
112
+
113
+If you're using Arch, the abovementioned AUR package bundles a systemd file for starting and stopping the server. If you're rolling your own deployment, here's an [example](https://github.com/darwin-network/slash/blob/master/etc/systemd/system/ircd.service) of a systemd unit file that can be used to run Oragono as an unprivileged role user.
114
+
115
+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.
109 116
 
110 117
 
111 118
 --------------------------------------------------------------------------------------------

Завантаження…
Відмінити
Зберегти