GitHub/ergo
3
0
Fork 0
mirror of https://github.com/ergochat/ergo.git synced 2024-11-10 22:19:31 +01:00
Code Issues Projects Releases Wiki Activity

readme

Browse Source
This commit is contained in:
Jeremy Latt 2014-03-18 15:45:51 -07:00
parent a4f4e4df9c
commit e014ff958a
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -5,14 +5,14 @@ issues are welcome. Discuss it here or on Freenode in [#ergonomadic][irc].
## Some Features ## Some Features
- follows the RFC where possible - follows the RFCs where possible
- gcfg gitconfig-style configuration - [gcfg][gcfg] gitconfig-style configuration
- server password (PASS command) - server password (PASS command)
- channels with most standard modes - channels with most standard modes
- IRC operators (OPER command) - IRC operators (OPER command)
- haproxy [PROXY protocol][proxy-proto] header for hostname setting - haproxy [PROXY protocol][proxy-proto] header for hostname setting
- passwords stored in bcrypt format - passwords stored in [bcrypt][go-crypto] format
- channels that persist between restarts (+P) - channels that [persist][go-sqlite] between restarts (+P)
## Why? ## Why?
@ -46,7 +46,7 @@ ergonomadic initdb -conf ergonomadic.conf
## Configuration ## Configuration
See the example `ergonomadic.conf`. Passwords are base64-encoded bcrypted byte See the example [`ergonomadic.conf`][conf]. Passwords are base64-encoded bcrypted byte
strings. You can generate them with the `genpasswd` subcommand. strings. You can generate them with the `genpasswd` subcommand.
```sh ```sh
@ -68,6 +68,10 @@ ergonomadic run -conf ergonomadic.conf
- [IRC/2 Numeric List](https://www.alien.net.au/irc/irc2numerics.html) - [IRC/2 Numeric List](https://www.alien.net.au/irc/irc2numerics.html)
[proxy-proto]: http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt [conf]: blob/master/ergonomadic.conf
[gcfg]: https://code.google.com/p/gcfg/
[go-crypto]: http://godoc.org/code.google.com/p/go.crypto
[go-sqlite]: https://github.com/mattn/go-sqlite3
[irc]: irc://chat.freenode.net/#ergonomadic [irc]: irc://chat.freenode.net/#ergonomadic
[proxy-proto]: http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt
[stunnel]: https://www.stunnel.org/index.html [stunnel]: https://www.stunnel.org/index.html