GitHub/ergo
3
0
Fork 0
mirror of https://github.com/ergochat/ergo.git synced 2024-11-25 13:29:27 +01:00
Code Issues Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Daniel Oaks 2017-06-27 08:35:58 +10:00
parent aa80045580
commit b78b57bbf9
1 changed files with 6 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -35,7 +35,7 @@ This project adheres to [Semantic Versioning](http://semver.org/). For the purpo
## Installation ## Installation
Download the latest release from this page: https://github.com/oragono/oragono/releases/latest To go through the standard installation, download the latest release from this page: https://github.com/oragono/oragono/releases/latest
Extract it into a folder, then run the following commands: Extract it into a folder, then run the following commands:
@ -49,13 +49,11 @@ oragono mkcerts
**Note:** This installation will give you unsigned certificates suitable for testing purposes. **Note:** This installation will give you unsigned certificates suitable for testing purposes.
For real certs, look into [Let's Encrypt](https://letsencrypt.org/)! For real certs, look into [Let's Encrypt](https://letsencrypt.org/)!
### Platform Packaging ### Platform Packages
Some platforms may support a packaged/installation medium via a normal process for the platform. They are listed here: Some platforms/distros also have Oragono packages maintained for them:
| Platform | Link | Maintainer(s) | * Arch Linux [AUR](https://aur.archlinux.org/packages/oragono/) - Maintained by [Sean Enck (@enckse)](https://github.com/enckse).
| --- | --- | --- |
| Arch Linux | [AUR](https://aur.archlinux.org/packages/oragono/) | [Sean Enck (enckse)](https://github.com/enckse) |
### From Source ### From Source
@ -89,6 +87,8 @@ make arm6
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. 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.
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.
### Logs ### Logs
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. 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,27 +143,6 @@ oragono-web mkcerts
oragono-web run oragono-web run
```--> ```-->
### Configuration
* 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)
For example, to change the logging destination edit `ircd.yaml` and change this line:
```
filename: ircd.log
```
To this:
```
filename: /var/log/ircd.log
```
* When using oragono the `--conf` option can be used to change which/where the configuration file is read from.
For example:
```
oragono run --conf /path/to/ircd.yaml
```
# Credits # Credits
* Jeremy Latt, creator of Ergonomadic, <https://github.com/jlatt> * Jeremy Latt, creator of Ergonomadic, <https://github.com/jlatt>