mirror of
https://github.com/ergochat/ergo.git
synced 2024-11-10 22:19:31 +01:00
92 lines
3.0 KiB
Markdown
92 lines
3.0 KiB
Markdown
|
|
|
|
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.
|
|
|
|
---
|
|
|
|
[](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.
|
|
|
|
# Oragono
|
|
|
|
## Features
|
|
|
|
* UTF-8 nick and channel names with rfc7700
|
|
* [yaml](http://yaml.org/) configuration
|
|
* native TLS/SSL support
|
|
* server password (`PASS` command)
|
|
* an extensible privilege system for IRC operators
|
|
* ident lookups for usernames
|
|
* automated client connection limits
|
|
* on-the-fly updating server config and TLS certificates (rehashing)
|
|
* client accounts and SASL
|
|
* passwords stored with [bcrypt](https://godoc.org/golang.org/x/crypto) (client account passwords also salted)
|
|
* [IRCv3 support](http://ircv3.net/software/servers.html)
|
|
* a heavy focus on developing with [specifications](http://oragono.io/specs.html)
|
|
* integrated (alpha) REST API and web interface
|
|
|
|
## Installation
|
|
|
|
```sh
|
|
go build oragono.go
|
|
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 testing 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
|
|
|
|
```sh
|
|
oragono run
|
|
```
|
|
|
|
# Web interface
|
|
|
|
Oragono also includes a web interface, which works with the REST API to provide a way to manage user accounts and bans.
|
|
|
|
This interface is an early alpha, is in no way secure and will not be in a final release for a while. Requires the alpha REST API to be enabled (check your server config to enable that if you really want to).
|
|
|
|
## Installation
|
|
|
|
```sh
|
|
go build oragono-web.go
|
|
cp oragono-web.yaml web.yaml
|
|
vim web.yaml # modify the config file to your liking
|
|
oragono-web mkcerts
|
|
```
|
|
|
|
## Running
|
|
|
|
```sh
|
|
oragono-web 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.
|