mirror of
https://github.com/ergochat/ergo.git
synced 2024-11-13 07:29:30 +01:00
ergonomadic -> oragono. I'm making lots of changes and this is AN EXPERIMENT. I want to differentiate this from Ergonomadic proper
This commit is contained in:
parent
29d80366a6
commit
c0c16c72f0
33
README.md
33
README.md
@ -1,20 +1,12 @@
|
||||
Ergonomadic (anagram of "go IRC daemon") is an IRC daemon written from scratch
|
||||
in Go. Pull requests and issues are welcome.
|
||||
|
||||
Discussion at:
|
||||
* host/port: irc.skub.club:6697, use SSL
|
||||
* password: smellyoulater
|
||||
* #darwin
|
||||
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.
|
||||
|
||||
# Features
|
||||
|
||||
* follows the RFCs where possible
|
||||
* UTF-8 nick and channel names
|
||||
* [yaml](http://yaml.org/) configuration
|
||||
* server password (PASS command)
|
||||
* channels with most standard modes
|
||||
* IRC operators (OPER command)
|
||||
* haproxy [PROXY protocol][proxy-proto] header for hostname setting
|
||||
* 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
|
||||
@ -28,44 +20,37 @@ protect traffic, I recommend using
|
||||
[PROXY protocol][proxy-proto]. This will allow the server to get the client's
|
||||
original addresses for hostname lookups.
|
||||
|
||||
# What about federation?
|
||||
|
||||
IRC federation solves a problem that was more likely to occur on the internet of
|
||||
1991 than today. We are exploring alternatives to federation that avoid nickname
|
||||
and channel sync issues created during netsplits.
|
||||
|
||||
# Installation
|
||||
|
||||
```sh
|
||||
go get
|
||||
go install
|
||||
cp ergonomadic.yaml ircd.yaml
|
||||
cp oragono.yaml ircd.yaml
|
||||
vim ircd.yaml # modify the config file to your liking
|
||||
ergonomadic initdb
|
||||
oragono initdb
|
||||
```
|
||||
|
||||
# Configuration
|
||||
|
||||
See the example [`ergonomadic.yaml`](ergonomadic.yaml). Passwords are base64-encoded bcrypted byte
|
||||
See the example [`oragono.yaml`](oragono.yaml). Passwords are base64-encoded bcrypted byte
|
||||
strings. You can generate them with the `genpasswd` subcommand.
|
||||
|
||||
```sh
|
||||
ergonomadic genpasswd
|
||||
oragono genpasswd
|
||||
```
|
||||
|
||||
# Running the server
|
||||
|
||||
```sh
|
||||
ergonomadic run
|
||||
oragono run
|
||||
```
|
||||
|
||||
# Credits
|
||||
|
||||
* Jeremy Latt, creator, <https://github.com/jlatt>
|
||||
* Edmund Huber, maintainer, <https://github.com/edmund-huber>
|
||||
* Niels Freier, added WebSocket support, <https://github.com/stumpyfr>
|
||||
* 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
|
||||
[proxy-proto]: http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt
|
||||
|
@ -1,7 +1,7 @@
|
||||
package irc
|
||||
|
||||
const (
|
||||
SEM_VER = "ergonomadic-1.4.4"
|
||||
SEM_VER = "oragono-1.4.4"
|
||||
CRLF = "\r\n"
|
||||
MAX_REPLY_LEN = 512 - len(CRLF)
|
||||
|
||||
|
@ -5,21 +5,21 @@ import (
|
||||
"log"
|
||||
"syscall"
|
||||
|
||||
"github.com/DanielOaks/oragono/irc"
|
||||
"github.com/docopt/docopt-go"
|
||||
"github.com/edmund-huber/ergonomadic/irc"
|
||||
"golang.org/x/crypto/ssh/terminal"
|
||||
)
|
||||
|
||||
func main() {
|
||||
version := irc.SEM_VER
|
||||
usage := `ergonomadic.
|
||||
usage := `oragono.
|
||||
Usage:
|
||||
ergonomadic initdb [--conf <filename>]
|
||||
ergonomadic upgradedb [--conf <filename>]
|
||||
ergonomadic genpasswd [--conf <filename>]
|
||||
ergonomadic run [--conf <filename>]
|
||||
ergonomadic -h | --help
|
||||
ergonomadic --version
|
||||
oragono initdb [--conf <filename>]
|
||||
oragono upgradedb [--conf <filename>]
|
||||
oragono genpasswd [--conf <filename>]
|
||||
oragono run [--conf <filename>]
|
||||
oragono -h | --help
|
||||
oragono --version
|
||||
Options:
|
||||
--conf <filename> Configuration file to use [default: ircd.yaml].
|
||||
-h --help Show this screen.
|
@ -1,7 +1,7 @@
|
||||
# ergonomadic IRCd config
|
||||
# oragono IRCd config
|
||||
server:
|
||||
# server name
|
||||
name: ergonomadic.test
|
||||
name: oragono.test
|
||||
|
||||
# database filename (sqlite db)
|
||||
database: ircd.db
|
||||
@ -16,7 +16,7 @@ server:
|
||||
wslisten: ":8080"
|
||||
|
||||
# password to login to the server
|
||||
# generated using "ergonomadic genpasswd"
|
||||
# generated using "oragono genpasswd"
|
||||
#password: ""
|
||||
|
||||
# log level, one of error, warn, info, debug
|
||||
@ -30,5 +30,5 @@ operator:
|
||||
# operator named 'dan'
|
||||
dan:
|
||||
# password to login with /OPER command
|
||||
# generated using "ergonomadic genpasswd"
|
||||
# generated using "oragono genpasswd"
|
||||
password: JDJhJDA0JE1vZmwxZC9YTXBhZ3RWT2xBbkNwZnV3R2N6VFUwQUI0RUJRVXRBRHliZVVoa0VYMnlIaGsu
|
Loading…
Reference in New Issue
Block a user