ergo/README.md

# Ergonomadic

Ergonomadic is an IRC daemon written from scratch in Go.

## Some Features

- follows the RFC where possible
- JSON-based configuration
- server password
- channels with many standard modes
- IRC operators
- TLS support (but better to use stunnel with proxy protocol)
- haproxy PROXY protocol header for hostname setting
- passwords stored in bcrypt format
- channels that persist between restarts (+P)

## Why?

I wanted to learn Go.

## What's with the name?

"Ergonomadic" is an anagram of "Go IRC Daemon".

## Helpful Documentation

- [RFC 1459: Internet Relay Chat Protocol](http://tools.ietf.org/html/rfc1459)
- [RFC 2811: IRC Channel Management](http://tools.ietf.org/html/rfc2811)
- [RFC 2812: IRC Client Protocol](http://tools.ietf.org/html/rfc2812)
- [RFC 2813: IRC Server Protocol](http://tools.ietf.org/html/rfc2813)
- [IRC/2 Numeric List](https://www.alien.net.au/irc/irc2numerics.html)

## Running the Server

See the example `config.json`. Passwords are base64-encoded bcrypted
byte strings. You can generate them with e.g. `ergonomadic -genpasswd
'hunter21!'`.

### from your GOPATH

```sh
go get
go install
ergonomadic -conf '/path/to/config.json' -initdb
ergonomadic -conf '/path/to/config.json'
```
readme 2012-04-18 06:24:26 +02:00			`# Ergonomadic`
readme 2012-04-18 06:23:12 +02:00
update readme 2014-02-22 03:51:50 +01:00			`Ergonomadic is an IRC daemon written from scratch in Go.`
readme 2012-04-18 06:23:12 +02:00
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 18:41:09 +01:00			`## Some Features`

			`- follows the RFC where possible`
			`- JSON-based configuration`
			`- server password`
			`- channels with many standard modes`
			`- IRC operators`
			`- TLS support (but better to use stunnel with proxy protocol)`
			`- haproxy PROXY protocol header for hostname setting`
			`- passwords stored in bcrypt format`
readme 2014-02-26 01:48:12 +01:00			`- channels that persist between restarts (+P)`
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 18:41:09 +01:00
Encapsulate SQL statements and refactor Save functions as transactionable. 2013-05-25 06:39:53 +02:00			`## Why?`
readme 2012-04-18 06:58:26 +02:00
			`I wanted to learn Go.`

Encapsulate SQL statements and refactor Save functions as transactionable. 2013-05-25 06:39:53 +02:00			`## What's with the name?`
readme 2012-04-18 06:58:26 +02:00
			`"Ergonomadic" is an anagram of "Go IRC Daemon".`
cleanup and reorganization 2012-12-09 21:51:50 +01:00
Encapsulate SQL statements and refactor Save functions as transactionable. 2013-05-25 06:39:53 +02:00			`## Helpful Documentation`

implement join/quit and channel messages properly 2014-02-09 02:10:04 +01:00			`- [RFC 1459: Internet Relay Chat Protocol](http://tools.ietf.org/html/rfc1459)`
Encapsulate SQL statements and refactor Save functions as transactionable. 2013-05-25 06:39:53 +02:00			`- [RFC 2811: IRC Channel Management](http://tools.ietf.org/html/rfc2811)`
			`- [RFC 2812: IRC Client Protocol](http://tools.ietf.org/html/rfc2812)`
			`- [RFC 2813: IRC Server Protocol](http://tools.ietf.org/html/rfc2813)`
fix race conditions 2014-02-14 08:16:07 +01:00			`- [IRC/2 Numeric List](https://www.alien.net.au/irc/irc2numerics.html)`
Encapsulate SQL statements and refactor Save functions as transactionable. 2013-05-25 06:39:53 +02:00
			`## Running the Server`
cleanup and reorganization 2012-12-09 21:51:50 +01:00
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 18:41:09 +01:00			See the example `config.json`. Passwords are base64-encoded bcrypted
			byte strings. You can generate them with e.g. `ergonomadic -genpasswd
			'hunter21!'`.
readme 2014-02-10 00:15:02 +01:00
			`### from your GOPATH`

			```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 18:41:09 +01:00			`go get`
readme 2014-02-10 00:15:02 +01:00			`go install`
persistent channels persisted to a sqlite db 2014-02-25 20:11:34 +01:00			`ergonomadic -conf '/path/to/config.json' -initdb`
minor cleanup 2014-02-25 02:45:04 +01:00			`ergonomadic -conf '/path/to/config.json'`
Encapsulate SQL statements and refactor Save functions as transactionable. 2013-05-25 06:39:53 +02:00			```