ircd/README.md

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.

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.

# Features

* UTF-8 nick and channel names
* [yaml](http://yaml.org/) configuration
* 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?

There is inbuilt TLS support using the Go TLS implementation. However,
[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.

# Installation

```sh
go get
go install
cp oragono.yaml ircd.yaml
vim ircd.yaml  # modify the config file to your liking
oragono initdb
oragono createcerts
```

# Configuration

See the example [`oragono.yaml`](oragono.yaml). Passwords are base64-encoded bcrypted byte
strings. You can generate them with the `genpasswd` subcommand.

```sh
oragono genpasswd
```

# Running the server

```sh
oragono run
```

# Credits

* 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>
* apologies to anyone I forgot.

[go-crypto]: https://godoc.org/golang.org/x/crypto
[go-sqlite]: https://github.com/mattn/go-sqlite3
ergonomadic -> oragono. I'm making lots of changes and this is AN EXPERIMENT. I want to differentiate this from Ergonomadic proper 2016-04-12 22:55:37 +00:00			`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.`
readme 2012-04-18 04:23:12 +00:00
version: Clarify semantic versioning "public API" and reset ver number on Oragono 2016-04-14 05:31:51 +00: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.`

cleanup README.md 2015-06-24 04:35:14 +00:00			`# Features`
many changes - load config sub files relative to config file dir - load config file by name - expect bcrypt for passwords - -genpasswd for generating config-file-safe passwords - block client thread while checking passwords (PASS and OPER) 2014-02-24 17:41:09 +00:00
cleanup README.md 2015-06-24 04:35:14 +00:00			`* UTF-8 nick and channel names`
Use docopt for command-line processing and new YAML configuration format 2016-04-12 13:00:09 +00:00			`* [yaml](http://yaml.org/) configuration`
cleanup README.md 2015-06-24 04:35:14 +00: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`
many changes - load config sub files relative to config file dir - load config file by name - expect bcrypt for passwords - -genpasswd for generating config-file-safe passwords - block client thread while checking passwords (PASS and OPER) 2014-02-24 17:41:09 +00:00
Add native SSL/TLS listener support from @enmand for our new config 2016-04-13 10:45:09 +00:00			`# What about SSL/TLS?`
update readme 2014-03-01 22:45:23 +00:00
Add native SSL/TLS listener support from @enmand for our new config 2016-04-13 10:45:09 +00:00			`There is inbuilt TLS support using the Go TLS implementation. However,`
cleanup README.md 2015-06-24 04:35:14 +00:00			`[stunnel](https://www.stunnel.org/index.html) version 4.56 with haproxy's`
Add native SSL/TLS listener support from @enmand for our new config 2016-04-13 10:45:09 +00:00			`[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.`
readme 2014-03-18 22:29:31 +00:00
cleanup README.md 2015-06-24 04:35:14 +00:00			`# Installation`
readme 2014-02-09 23:15:02 +00:00
			```sh
many changes - load config sub files relative to config file dir - load config file by name - expect bcrypt for passwords - -genpasswd for generating config-file-safe passwords - block client thread while checking passwords (PASS and OPER) 2014-02-24 17:41:09 +00:00			`go get`
readme 2014-02-09 23:15:02 +00:00			`go install`
ergonomadic -> oragono. I'm making lots of changes and this is AN EXPERIMENT. I want to differentiate this from Ergonomadic proper 2016-04-12 22:55:37 +00:00			`cp oragono.yaml ircd.yaml`
Use docopt for command-line processing and new YAML configuration format 2016-04-12 13:00:09 +00:00			`vim ircd.yaml # modify the config file to your liking`
ergonomadic -> oragono. I'm making lots of changes and this is AN EXPERIMENT. I want to differentiate this from Ergonomadic proper 2016-04-12 22:55:37 +00:00			`oragono initdb`
Add ability to generate certs 2016-06-15 09:31:39 +00:00			`oragono createcerts`
readme 2014-02-27 06:25:10 +00:00			```

cleanup README.md 2015-06-24 04:35:14 +00:00			`# Configuration`
readme 2014-02-27 06:25:10 +00:00
ergonomadic -> oragono. I'm making lots of changes and this is AN EXPERIMENT. I want to differentiate this from Ergonomadic proper 2016-04-12 22:55:37 +00:00			See the example [`oragono.yaml`](oragono.yaml). Passwords are base64-encoded bcrypted byte
readme 2014-03-18 22:29:31 +00:00			strings. You can generate them with the `genpasswd` subcommand.
readme 2014-02-27 06:25:10 +00:00
			```sh
ergonomadic -> oragono. I'm making lots of changes and this is AN EXPERIMENT. I want to differentiate this from Ergonomadic proper 2016-04-12 22:55:37 +00:00			`oragono genpasswd`
readme 2014-02-27 06:25:10 +00:00			```

cleanup README.md 2015-06-24 04:35:14 +00:00			`# Running the server`
readme 2014-02-27 06:25:10 +00:00
			```sh
ergonomadic -> oragono. I'm making lots of changes and this is AN EXPERIMENT. I want to differentiate this from Ergonomadic proper 2016-04-12 22:55:37 +00:00			`oragono run`
Encapsulate SQL statements and refactor Save functions as transactionable. 2013-05-25 04:39:53 +00:00			```
readme 2014-02-27 19:07:21 +00:00
cleanup README.md 2015-06-24 04:35:14 +00:00			`# Credits`
readme 2014-03-18 22:29:31 +00:00
ergonomadic -> oragono. I'm making lots of changes and this is AN EXPERIMENT. I want to differentiate this from Ergonomadic proper 2016-04-12 22:55:37 +00: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>`
cleanup README.md 2015-06-24 04:35:14 +00:00			`* apologies to anyone I forgot.`
readme 2014-03-18 22:29:31 +00:00
irc: Switch to golang.org versions, not google code versions of dependencies. This has a few advantages: * the google code versions are no longer maintained * the google code versions are using mercurial (which I don't have installed) 2015-07-02 12:10:19 +00:00			`[go-crypto]: https://godoc.org/golang.org/x/crypto`
readme 2014-03-18 22:45:51 +00:00			`[go-sqlite]: https://github.com/mattn/go-sqlite3`