Name: oragono
Owner: Oragono
Description: A modern IRC server written in Go.
Created: 2016-04-11 14:44:46.0
Updated: 2018-01-14 06:41:56.0
Pushed: 2018-01-07 08:43:43.0
Homepage: https://oragono.io/
Size: 5238
Language: Go
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
Oragono is a modern, experimental IRC server written in Go. It's 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
darwin.network and testnet.oragono.io are running Oragono in production if you want to take a look.
PASS
command)KLINE
and DLINE
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:
ragono.yaml ircd.yaml
ircd.yaml # modify the config file to your liking
ono initdb
ono mkcerts
Note: This installation will give you unsigned certificates suitable for testing purposes. For real certs, look into Let's Encrypt!
Some platforms/distros also have Oragono packages maintained for them:
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. Don't 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.
Clone the appropriate branch. If necessary, do git submodule update --init
to set up vendored dependencies. From the root folder, run make
to generate all release files for all of our target OSes:
You can also only build the release files for a specific system:
r windows
windows
r linux
linux
r osx
osx
r arm6
arm6
Once you have made the release files, you can find them in the build
directory. Uncompress these to an empty directory and continue as usual.
The default config file oragono.yaml
helps walk you through what each option means and changes. The configuration's intended to be sparse, so if there are options missing it's either because that feature isn't written/configurable yet or because we don't 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.
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 (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:
ono genpasswd
With this, you receive a blob of text which you can plug into your configuration file.
After this, running the server is easy! Simply run the below command and you should see the relevant startup information pop up.
ono run
/quote ACC REGISTER <username> * passphrase :<password>
/join #channel
/msg ChanServ REGISTER #channel
After this, your channel will remember the fact that you're 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.