3
0
mirror of https://github.com/ergochat/ergo.git synced 2024-11-10 22:19:31 +01:00
Go to file
2019-02-02 21:15:41 -05:00
docs remove explicit initdb instructions from the docs 2018-12-31 01:44:31 -05:00
irc unify "startup", "rehash", and "shutdown" log categories as "server" 2019-02-02 21:13:01 -05:00
languages Correct language code for Norsk 2018-04-16 13:23:33 +10:00
vendor@77ddc3dbc1 bump vendor to remove stackimpact 2018-08-15 08:12:24 -04:00
.check-gofmt.sh add gofmt check to make test 2018-05-04 04:28:01 -04:00
.gitignore Start making builds with goreleaser 2018-01-07 12:40:26 +10:00
.gitmodules vendor: Updated packages 2017-06-14 12:12:17 -06:00
.goreleaser.yml Remove deprecated line from goreleaser config 2019-02-03 05:50:23 +10:00
.travis.yml upgrade travis to golang 1.11 2018-08-28 19:28:49 -04:00
CHANGELOG.md Release v0.12.0 2018-10-15 12:18:23 +10:00
DEVELOPING.md update developing documentation 2018-04-19 03:22:45 -04:00
gencapdefs.py draft/resume-0.2 implementation, message history support 2018-11-26 05:23:27 -05:00
Gopkg.lock vendor: Updated submodules 2018-10-15 11:51:55 +10:00
Gopkg.toml vendor: Updated submodules 2018-10-15 11:51:55 +10:00
LICENSE Update license 2018-04-09 23:26:34 +10:00
Makefile add support for login throttling 2019-01-02 10:15:59 -05:00
oragono.go exit 1 if startup fails 2019-02-02 21:15:41 -05:00
oragono.motd Add colour charts to the default MOTD, including 16-98 extended colours 2018-04-01 00:35:41 +10:00
oragono.yaml unify "startup", "rehash", and "shutdown" log categories as "server" 2019-02-02 21:13:01 -05:00
README remove explicit initdb instructions from the docs 2018-12-31 01:44:31 -05:00
README.md Marker docker section as BETA 2019-01-29 23:36:32 +00:00
updatetranslations.py Fix translation script for weird OS encodings 2018-04-01 18:31:45 +10:00

Oragono logo

Oragono is a modern, experimental IRC server written in Go. Its designed to be simple to setup and use, and it includes features such as UTF-8 nicks / channel names, client accounts with SASL, and other assorted IRCv3 support.

Oragono is a fork of the Ergonomadic IRC daemon <3


Go Report Card Build Status Download Latest Release Freenode #oragono Crowdin

darwin.network and testnet.oragono.io are running Oragono in production if you want to take a look.


Features

  • UTF-8 nick and channel names with rfc7613 (PRECIS)
  • yaml 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 (client account passwords also salted)
  • banning ips/nets and masks with KLINE and DLINE
  • supports multiple languages (you can also set a default language for your network)
  • IRCv3 support
  • a heavy focus on developing with specifications

Installation

To go through the standard installation, download the latest release from this page: https://github.com/oragono/oragono/releases/latest

Extract it into a folder, then run the following commands:

cp oragono.yaml ircd.yaml
vim ircd.yaml  # modify the config file to your liking
oragono mkcerts

Note: For setting up proper Lets Encrypt certificates, weve got this manual entry.

Platform Packages

Some platforms/distros also have Oragono packages maintained for them:

Using Docker (BETA)

A Dockerfile and docker-compose recipe are available in the oragono-docker repository.

From Source

You can also install this repo and use that instead! However, keep some things in mind if you go that way:

devel branches are intentionally unstable, containing fixes that may not work, and they may be rebased or reworked extensively.

The master branch should usually be stable, but may contain database changes that either have not been finalised or not had database upgrade code written yet. Dont run master on a live production network.

The stable branch contains the latest release. You can run this for a production version without any trouble.

Building

Clone the appropriate branch. You should also run this command to set up vendored dependencies:

git submodule update --init

From the root folder, you can run make, using GoReleaser to generate all of our release binaries in /dist:

make

However, when just developing I instead just use this command to rebuild and run Oragono on the fly with the latest changes:

go run oragono.go

Configuration

The default config file oragono.yaml helps walk you through what each option means and changes. The configurations intended to be sparse, so if there are options missing its either because that feature isnt written/configurable yet or because we dont think it should be configurable.

You can use the --conf parameter when launching Oragono to control where it looks for the config file. For instance: oragono run --conf /path/to/ircd.yaml. The configuration file also stores where the log, database, certificate, and other files are opened. Normally, all these files use relative paths, but you can change them to be absolute (such as /var/log/ircd.log) when running Oragono as a service.

Logs

By default, logs are stored in the file ircd.log. The configuration format of logs is designed to be easily pluggable, and is inspired by the logging config provided by InspIRCd.

Passwords

Passwords (for both PASS and oper logins) are stored using bcrypt. To generate encrypted strings for use in the config, use the genpasswd subcommand as such:

oragono genpasswd

With this, you receive a blob of text which you can plug into your configuration file.

Running

After this, running the server is easy! Simply run the below command and you should see the relevant startup information pop up.

oragono run

How to register a channel

  1. Register your account with /NS REGISTER <username> <email> <password>
  2. Join the channel with /join #channel
  3. Register the channel with /CS REGISTER #channel

After this, your channel will remember the fact that youre the owner, the topic, and any modes set on it!

Make sure to setup SASL in your client to automatically login to your account when you next join the server.

Credits