3
0
mirror of https://github.com/ergochat/ergo.git synced 2024-11-10 22:19:31 +01:00
ergo/README.md

59 lines
2.0 KiB
Markdown
Raw Normal View History

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.
2012-04-18 06:23:12 +02:00
This project adheres to [Semantic Versioning](http://semver.org/). For the purposes of versioning, we consider the "public API" to refer to the configuration files, CLI interface and database format.
2015-06-24 06:35:14 +02:00
# Features
2015-06-24 06:35:14 +02:00
* UTF-8 nick and channel names
* [yaml](http://yaml.org/) configuration
2015-06-24 06:35:14 +02:00
* server password (PASS command)
* channels with most standard modes
* IRC operators (OPER command)
* 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
# What about SSL/TLS?
2014-03-01 23:45:23 +01:00
There is inbuilt TLS support using the Go TLS implementation. However,
2015-06-24 06:35:14 +02:00
[stunnel](https://www.stunnel.org/index.html) version 4.56 with haproxy's
[PROXY protocol](http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt)
may also be used. This will allow the server to get the client's original
addresses for hostname lookups.
2014-03-18 23:29:31 +01:00
2015-06-24 06:35:14 +02:00
# Installation
2014-02-10 00:15:02 +01:00
```sh
go get
2014-02-10 00:15:02 +01:00
go install
cp oragono.yaml ircd.yaml
vim ircd.yaml # modify the config file to your liking
oragono initdb
2016-06-15 11:31:39 +02:00
oragono createcerts
2014-02-27 07:25:10 +01:00
```
2015-06-24 06:35:14 +02:00
# Configuration
2014-02-27 07:25:10 +01:00
See the example [`oragono.yaml`](oragono.yaml). Passwords are base64-encoded bcrypted byte
2014-03-18 23:29:31 +01:00
strings. You can generate them with the `genpasswd` subcommand.
2014-02-27 07:25:10 +01:00
```sh
oragono genpasswd
2014-02-27 07:25:10 +01:00
```
2015-06-24 06:35:14 +02:00
# Running the server
2014-02-27 07:25:10 +01:00
```sh
oragono run
```
2014-02-27 20:07:21 +01:00
2015-06-24 06:35:14 +02:00
# Credits
2014-03-18 23:29:31 +01:00
* Jeremy Latt, creator of Ergonomadic, <https://github.com/jlatt>
* Edmund Huber, maintainer of Ergonomadic, <https://github.com/edmund-huber>
* Niels Freier, added WebSocket support to Ergonomadic, <https://github.com/stumpyfr>
2015-06-24 06:35:14 +02:00
* apologies to anyone I forgot.
2014-03-18 23:29:31 +01:00
[go-crypto]: https://godoc.org/golang.org/x/crypto
2014-03-18 23:45:51 +01:00
[go-sqlite]: https://github.com/mattn/go-sqlite3