mirror of
https://github.com/ergochat/ergo.git
synced 2024-11-13 07:29:30 +01:00
readme: Improve language, add some more details
This commit is contained in:
parent
2ab8d4cb6e
commit
31757a64d7
17
README.md
17
README.md
@ -1,6 +1,8 @@
|
||||
# Oragono
|
||||
|
||||
Oragono is a very early, extremely experimental fork of the [Ergonomadic](https://github.com/edmund-huber/ergonomadic) IRC daemon. Ergonomadic looks cool, and this is something I can experiment on. Hopefully most of the stuff I do in this can be merged back into Ergonomadic! Also see the [mammon](https://github.com/mammon-ircd/mammon) IRC daemon for something similar written in Python.
|
||||
Oragono is an IRC daemon written in Go. It's an early, experimental fork of the [Ergonomadic](https://github.com/edmund-huber/ergonomadic) IRC daemon.
|
||||
|
||||
Also see the [mammon](https://github.com/mammon-ircd/mammon) IRC daemon for a similar project written in Python instead.
|
||||
|
||||
---
|
||||
|
||||
@ -16,14 +18,16 @@ This project adheres to [Semantic Versioning](http://semver.org/). For the purpo
|
||||
|
||||
* UTF-8 nick and channel names
|
||||
* [yaml](http://yaml.org/) configuration
|
||||
* server password (PASS command)
|
||||
* native TLS/SSL support
|
||||
* server password (`PASS` command)
|
||||
* channels with most standard modes
|
||||
* IRC operators (OPER command)
|
||||
* IRC operators
|
||||
* ident lookups for usernames
|
||||
* passwords stored in [bcrypt][go-crypto] format
|
||||
* channels that [persist][go-sqlite] between restarts (+P)
|
||||
* messages are queued in the same order to all connected clients
|
||||
* IRCv3 support
|
||||
|
||||
### What about SSL/TLS?
|
||||
### What about TLS/SSL?
|
||||
|
||||
There is inbuilt TLS support using the Go TLS implementation. However,
|
||||
[stunnel](https://www.stunnel.org/index.html) version 4.56 with haproxy's
|
||||
@ -42,6 +46,9 @@ oragono initdb
|
||||
oragono mkcerts
|
||||
```
|
||||
|
||||
**Note:** This installation will give you unsigned certificates only suitable for teting purposes.
|
||||
For real crets, look into [Let's Encrypt](https://letsencrypt.org/).
|
||||
|
||||
## Configuration
|
||||
|
||||
See the example [`oragono.yaml`](oragono.yaml). Passwords are stored using bcrypt. You can generate encrypted password strings for use in the config with the `genpasswd` subcommand.
|
||||
|
Loading…
Reference in New Issue
Block a user