GitHub/ergo
3
0
Fork 0
mirror of https://github.com/ergochat/ergo.git synced 2024-11-22 03:49:27 +01:00
Code Issues Projects Releases Wiki Activity
https://github.com/ergochat/ergo
922 Commits 22 Branches 70 Tags 46 MiB
Go 96.7%
Python 2.7%
Shell 0.4%
Dockerfile 0.1%
095e71b2fe
Go to file
Daniel Oaks 095e71b2fe readme: Add some more credits
2017-10-08 09:45:34 +10:00
docs readme: Add some more credits 2017-10-08 09:45:34 +10:00
irc caps: Test Add, Remove and String 2017-10-08 09:26:01 +10:00
mkcerts Fix dates at top of source files 2017-03-27 22:15:02 +10:00
vendor@d67be04788 vendor: Updated submodules 2017-09-25 10:54:31 +10:00
.gitignore ignore vim swapfiles 2017-09-06 17:29:09 -04:00
.gitmodules vendor: Updated packages 2017-06-14 12:12:17 -06:00
.travis.yml travis: Also run Go tests where they exist, when running through Travis 2017-07-26 08:04:23 +10:00
CHANGELOG.md changelog: Update with new items 2017-10-01 15:27:47 +10:00
DEVELOPING.md developing: Link to dep tool, not old vendetta one 2017-04-30 13:25:35 +10:00
Gopkg.lock vendor: Updated submodules 2017-09-25 10:54:31 +10:00
Gopkg.toml vendor: Updated submodules 2017-04-30 13:09:36 +10:00
LICENSE MIT license 2014-02-25 09:54:14 -08:00
Makefile add go vet to make test 2017-10-05 21:09:04 +10:00
oragono.go Split passwd into its' own subpackage 2017-10-06 00:03:53 +10:00
oragono.motd motd: Betterise logo 2016-04-13 11:42:52 +10:00
oragono.yaml Rip out REST API and web interface. 2017-10-05 17:14:16 +10:00
README.md readme: Add some more credits 2017-10-08 09:45:34 +10:00

README.md

Oragono logo

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

Go Report Card Build Status Download Latest Release Freenode #oragono

darwin.network is 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
  • 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 initdb
oragono mkcerts

Note: This installation will give you unsigned certificates suitable for testing purposes. For real certs, look into Let’s Encrypt!

Platform Packages

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

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. 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.

Building

Build Status

Clone the appropriate branch. From the root folder, run make to generate all release files for all of our target OSes:

make

You can also only build the release files for a specific system:

# for windows
make windows

# for linux
make linux

# for osx
make osx

# for arm6
make 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.

Configuration

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.

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 /quote ACC REGISTER <username> * passphrase :<password>
  2. Join the channel with /join #channel
  3. Register the channel with /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.

Credits