Browse Source

readme: Simplify and fold new sections into existing ones where possible

tags/v0.8.2
Daniel Oaks 7 years ago
parent
commit
b78b57bbf9
1 changed files with 6 additions and 27 deletions
  1. 6
    27
      README.md

+ 6
- 27
README.md View File

35
 
35
 
36
 ## Installation
36
 ## Installation
37
 
37
 
38
-Download the latest release from this page: https://github.com/oragono/oragono/releases/latest
38
+To go through the standard installation, download the latest release from this page: https://github.com/oragono/oragono/releases/latest
39
 
39
 
40
 Extract it into a folder, then run the following commands:
40
 Extract it into a folder, then run the following commands:
41
 
41
 
49
 **Note:** This installation will give you unsigned certificates suitable for testing purposes.
49
 **Note:** This installation will give you unsigned certificates suitable for testing purposes.
50
 For real certs, look into [Let's Encrypt](https://letsencrypt.org/)!
50
 For real certs, look into [Let's Encrypt](https://letsencrypt.org/)!
51
 
51
 
52
-### Platform Packaging
52
+### Platform Packages
53
 
53
 
54
-Some platforms may support a packaged/installation medium via a normal process for the platform. They are listed here:
54
+Some platforms/distros also have Oragono packages maintained for them:
55
 
55
 
56
-| Platform | Link | Maintainer(s) |
57
-| --- | --- | --- |
58
-| Arch Linux | [AUR](https://aur.archlinux.org/packages/oragono/) | [Sean Enck (enckse)](https://github.com/enckse) |
56
+* Arch Linux [AUR](https://aur.archlinux.org/packages/oragono/) - Maintained by [Sean Enck (@enckse)](https://github.com/enckse).
59
 
57
 
60
 ### From Source
58
 ### From Source
61
 
59
 
89
 
87
 
90
 The default config file [`oragono.yaml`](oragono.yaml) helps walk you through what each option means and changes. The configuration's intended to be sparse, so if there are options missing it's either because that feature isn't written/configurable yet or because we don't think it should be configurable.
88
 The default config file [`oragono.yaml`](oragono.yaml) helps walk you through what each option means and changes. The configuration's intended to be sparse, so if there are options missing it's either because that feature isn't written/configurable yet or because we don't think it should be configurable.
91
 
89
 
90
+You can use the `--conf` parameter when launching Oragono to control where it looks for the config file. For instance: `oragono run --conf /path/to/ircd.yaml`. The configuration file also stores where the log, database, certificate, and other files are opened. Normally, all these files use relative paths, but you can change them to be absolute (such as `/var/log/ircd.log`) when running Oragono as a service.
91
+
92
 ### Logs
92
 ### Logs
93
 
93
 
94
 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.
94
 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.
143
 oragono-web run
143
 oragono-web run
144
 ```-->
144
 ```-->
145
 
145
 
146
-### Configuration
147
-
148
-* Locations where oragono will read/write files can be configured in the `ircd.yaml` file. (**Note:** this applies to multiple options like database location and certificates as well)
149
-
150
-For example, to change the logging destination edit `ircd.yaml` and change this line:
151
-```
152
-    filename: ircd.log
153
-```
154
-
155
-To this:
156
-```
157
-    filename: /var/log/ircd.log
158
-```
159
-
160
-* When using oragono the `--conf` option can be used to change which/where the configuration file is read from.
161
-
162
-For example:
163
-```
164
-oragono run --conf /path/to/ircd.yaml
165
-```
166
-
167
 # Credits
146
 # Credits
168
 
147
 
169
 * Jeremy Latt, creator of Ergonomadic, <https://github.com/jlatt>
148
 * Jeremy Latt, creator of Ergonomadic, <https://github.com/jlatt>

Loading…
Cancel
Save