GitHub/ergo
3
0
Fork 0
mirror of https://github.com/ergochat/ergo.git synced 2024-11-10 22:19:31 +01:00
Code Issues Projects Releases Wiki Activity

README: Cleanup a bit

Browse Source
This commit is contained in:
Daniel Oaks 2016-06-28 16:37:58 +10:00
parent 4ded121e5b
commit a4236fcddd
1 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,10 +1,18 @@
# Oragono
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. 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.
---
[![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. 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.
*NOTE: Things are probably very broken right now. The `THEATER` command does not work, and I'm currently most of the way through rearchitecting the command handling. It should be finished apart from the `THEATER` command, but things are probably still broken.* *NOTE: Things are probably very broken right now. The `THEATER` command does not work, and I'm currently most of the way through rearchitecting the command handling. It should be finished apart from the `THEATER` command, but things are probably still broken.*
# Features ## Features
* UTF-8 nick and channel names * UTF-8 nick and channel names
* [yaml](http://yaml.org/) configuration * [yaml](http://yaml.org/) configuration
@ -15,7 +23,7 @@ This project adheres to [Semantic Versioning](http://semver.org/). For the purpo
* channels that [persist][go-sqlite] between restarts (+P) * channels that [persist][go-sqlite] between restarts (+P)
* messages are queued in the same order to all connected clients * messages are queued in the same order to all connected clients
# What about SSL/TLS? ### What about SSL/TLS?
There is inbuilt TLS support using the Go TLS implementation. However, There is inbuilt TLS support using the Go TLS implementation. However,
[stunnel](https://www.stunnel.org/index.html) version 4.56 with haproxy's [stunnel](https://www.stunnel.org/index.html) version 4.56 with haproxy's
@ -23,7 +31,7 @@ There is inbuilt TLS support using the Go TLS implementation. However,
may also be used. This will allow the server to get the client's original may also be used. This will allow the server to get the client's original
addresses for hostname lookups. addresses for hostname lookups.
# Installation ## Installation
```sh ```sh
go get go get
@ -34,7 +42,7 @@ oragono initdb
oragono createcerts oragono createcerts
``` ```
# Configuration ## 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. 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.
@ -42,13 +50,13 @@ See the example [`oragono.yaml`](oragono.yaml). Passwords are stored using bcryp
oragono genpasswd oragono genpasswd
``` ```
# Running the server ## Running the server
```sh ```sh
oragono run oragono run
``` ```
# Credits ## Credits
* Jeremy Latt, creator of Ergonomadic, <https://github.com/jlatt> * Jeremy Latt, creator of Ergonomadic, <https://github.com/jlatt>
* Edmund Huber, maintainer of Ergonomadic, <https://github.com/edmund-huber> * Edmund Huber, maintainer of Ergonomadic, <https://github.com/edmund-huber>