ircd/README.md

![Oragono logo](docs/logo.png)

Oragono is a modern, experimental IRC server written in Go. It's designed to be simple to setup and use, and to provide the majority of features that IRC users expect today.

It includes features such as UTF-8 nicks and channel names, client accounts and SASL, and other assorted IRCv3 support.

Oragono is a fork of the [Ergonomadic](https://github.com/edmund-huber/ergonomadic) IRC daemon <3

Also see the [mammon](https://github.com/mammon-ircd/mammon) IRC daemon for a similar project written in Python instead.

---

[![Go Report Card](https://goreportcard.com/badge/github.com/DanielOaks/oragono)](https://goreportcard.com/report/github.com/DanielOaks/oragono)

---

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 with rfc7700
* [yaml](http://yaml.org/) configuration
* native TLS/SSL support
* server password (`PASS` command)
* channels with most standard modes
* IRC operators with an extensible privilege system
* ident lookups for usernames
* automated client connection limits
* rehashing (on-the-fly updating server config and TLS certificates)
* passwords stored in [bcrypt][go-crypto] format
* client accounts and SASL
* [IRCv3 support](http://ircv3.net/software/servers.html)

## Installation

```sh
go get
go install
cp oragono.yaml ircd.yaml
vim ircd.yaml  # modify the config file to your liking
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.

```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>
* Daniel Oakley, maintainer of Oragono, <https://github.com/DanielOaks>
* apologies to anyone I forgot.

[go-crypto]: https://godoc.org/golang.org/x/crypto
README: Add logo 2016-09-13 12:44:59 +00:00			`![Oragono logo](docs/logo.png)`
README: Cleanup a bit 2016-06-28 06:37:58 +00:00
README: Update to match the website wording 2016-10-16 10:39:02 +00:00			`Oragono is a modern, experimental IRC server written in Go. It's designed to be simple to setup and use, and to provide the majority of features that IRC users expect today.`

			`It includes features such as UTF-8 nicks and channel names, client accounts and SASL, and other assorted IRCv3 support.`

			`Oragono is a fork of the [Ergonomadic](https://github.com/edmund-huber/ergonomadic) IRC daemon <3`
readme: Improve language, add some more details 2016-08-14 04:27:33 +00:00
			`Also see the [mammon](https://github.com/mammon-ircd/mammon) IRC daemon for a similar project written in Python instead.`
readme 2012-04-18 04:23:12 +00:00
README: Cleanup a bit 2016-06-28 06:37:58 +00:00			`---`

			`[![Go Report Card](https://goreportcard.com/badge/github.com/DanielOaks/oragono)](https://goreportcard.com/report/github.com/DanielOaks/oragono)`

			`---`

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.`

README: Cleanup a bit 2016-06-28 06:37:58 +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
Update docs to match rfc7700 stuff 2016-10-11 13:54:13 +00:00			`* UTF-8 nick and channel names with rfc7700`
Use docopt for command-line processing and new YAML configuration format 2016-04-12 13:00:09 +00:00			`* [yaml](http://yaml.org/) configuration`
readme: Improve language, add some more details 2016-08-14 04:27:33 +00:00			`* native TLS/SSL support`
			* server password (`PASS` command)
cleanup README.md 2015-06-24 04:35:14 +00:00			`* channels with most standard modes`
README: Extend features 2016-10-23 15:07:04 +00:00			`* IRC operators with an extensible privilege system`
readme: Improve language, add some more details 2016-08-14 04:27:33 +00:00			`* ident lookups for usernames`
README: Extend features 2016-10-23 15:07:04 +00:00			`* automated client connection limits`
			`* rehashing (on-the-fly updating server config and TLS certificates)`
cleanup README.md 2015-06-24 04:35:14 +00:00			`* passwords stored in [bcrypt][go-crypto] format`
README: Add info on new SASL stuff 2016-09-07 11:35:43 +00:00			`* client accounts and SASL`
README: Extend features 2016-10-23 15:07:04 +00:00			`* [IRCv3 support](http://ircv3.net/software/servers.html)`
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
README: Cleanup a bit 2016-06-28 06:37:58 +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`
mkcerts: Clean up and rename to be nicer 2016-08-13 08:17:40 +00:00			`oragono mkcerts`
readme 2014-02-27 06:25:10 +00:00			```

readme: Improve language, add some more details 2016-08-14 04:27:33 +00:00			`Note: This installation will give you unsigned certificates only suitable for teting purposes.`
			`For real crets, look into [Let's Encrypt](https://letsencrypt.org/).`

README: Cleanup a bit 2016-06-28 06:37:58 +00:00			`## Configuration`
readme 2014-02-27 06:25:10 +00:00
README: Improve language around passwords 2016-06-18 23:58:23 +00:00			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.
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			```

README: Cleanup a bit 2016-06-28 06:37:58 +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
README: Cleanup a bit 2016-06-28 06:37:58 +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>`
Improve CHANGELOG, add myself to the Readme 2016-06-16 09:40:25 +00:00			`* Daniel Oakley, maintainer of Oragono, <https://github.com/DanielOaks>`
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`