Merge pull request #1685 from slingamn/next
set up new development version
|1 day ago|
|.github/workflows||2 weeks ago|
|distrib||5 days ago|
|docs||2 weeks ago|
|irc||1 day ago|
|irctest @ a7d7436929||2 weeks ago|
|languages||2 weeks ago|
|vendor||2 weeks ago|
|.check-gofmt.sh||2 weeks ago|
|.gitattributes||1 year ago|
|.gitignore||5 days ago|
|.gitmodules||8 months ago|
|.goreleaser.yml||2 weeks ago|
|CHANGELOG.md||6 days ago|
|DEVELOPING.md||2 weeks ago|
|Dockerfile||5 days ago|
|LICENSE||1 year ago|
|Makefile||2 weeks ago|
|README||2 weeks ago|
|README.md||5 days ago|
|crowdin.yml||2 years ago|
|default.yaml||1 week ago|
|ergo.go||2 weeks ago|
|ergo.motd||2 weeks ago|
|gencapdefs.py||3 weeks ago|
|go.mod||2 weeks ago|
|go.sum||2 weeks ago|
|traditional.yaml||1 week ago|
|updatetranslations.py||1 year ago|
Ergo (formerly known as Oragono) is a modern IRC server written in Go. Its core design principles are:
Ergo is a fork of the Ergonomadic IRC daemon <3
If you want to take a look at a running Ergo instance or test some client code, feel free to play with testnet.ergo.chat (TLS on port 6697 or plaintext on port 6667).
UBAN, a unified ban system that can target IPs, networks, masks, and registered accounts (
DLINEare also supported)
Download the latest release from this page: https://github.com/ergochat/ergo/releases/latest
Extract it into a folder, then run the following commands:
cp default.yaml ircd.yaml vim ircd.yaml # modify the config file to your liking ergo mkcerts ergo run # server should be ready to go!
Note: See the productionizing guide in our manual for recommendations on how to run a production network, including obtaining valid TLS certificates.
Some platforms/distros also have Ergo packages maintained for them:
A Dockerfile and example docker-compose recipe are available in the
distrib/docker directory. Ergo is automatically published
to Docker Hub at ergochat/ergo. For more information, see the distrib/docker
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.
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.
stable branch contains the latest release. You can run this for a production version without any trouble.
You’ll need an up-to-date distribution of the Go language for your OS and architecture. Once you have that, just clone the repository and run
make build. If everything goes well, you should now have an executable named
ergo in the base directory of the project.
The default config file
default.yaml helps walk you through what each option means and changes.
You can use the
--conf parameter when launching Ergo to control where it looks for the config file. For instance:
ergo 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 Ergo as a service.
By default, logs go to stderr only. They can be configured to go to a file, or you can use systemd to direct the stderr to the system journal (see the manual for details). 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:
With this, you receive a blob of text which you can plug into your configuration file.
Ergo relies heavily on user accounts to enable its distinctive features (such as allowing multiple clients per nickname). As a user, you can register your current nickname as an account using
/msg NickServ register <password>. Once you have done so, you should enable SASL in your clients, ensuring that you will be automatically logged into your account on each connection. This will prevent problems claiming your registered nickname.
Once you have registered your nickname, you can use it to register channels:
/CS REGISTER #channel
After this, your channel will remember the fact that you’re the owner, the topic, and any modes set on it!