2021-05-27 00:01:11 +02:00
|
|
|
___ _ __ __ _ ___
|
|
|
|
|
/ _ \ '__/ _` |/ _ \
|
|
|
|
|
| __/ | | (_| | (_) |
|
|
|
|
|
\___|_| \__, |\___/
|
|
|
|
|
__/ |
|
|
|
|
|
|___/
|
2016-10-16 13:01:53 +02:00
|
|
|
-----------------------------------------------------------------------------------------------
|
|
|
|
|
|
2021-05-25 06:34:38 +02:00
|
|
|
Ergo is a modern IRC server written in Go. Its core design principles are:
|
2016-10-16 13:01:53 +02:00
|
|
|
|
2021-01-31 04:07:51 +01:00
|
|
|
* Being simple to set up and use
|
|
|
|
|
* Combining the features of an ircd, a services framework, and a bouncer:
|
|
|
|
|
* Integrated account management
|
|
|
|
|
* History storage
|
|
|
|
|
* Bouncer functionality
|
|
|
|
|
* Bleeding-edge IRCv3 support
|
|
|
|
|
* Highly customizable via a rehashable (runtime-reloadable) YAML config
|
2016-10-16 13:01:53 +02:00
|
|
|
|
2021-05-25 06:34:38 +02:00
|
|
|
https://ergo.chat/
|
|
|
|
|
https://github.com/ergochat/ergo
|
|
|
|
|
#ergo on irc.ergo.chat or irc.libera.chat
|
2016-10-16 13:01:53 +02:00
|
|
|
|
|
|
|
|
-----------------------------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
=== Installing ===
|
|
|
|
|
|
|
|
|
|
Copy the example config file to ircd.yaml with a command like:
|
|
|
|
|
|
2020-06-15 00:54:36 +02:00
|
|
|
$ cp default.yaml ircd.yaml
|
2016-10-16 13:01:53 +02:00
|
|
|
|
2021-01-31 04:07:51 +01:00
|
|
|
Modify the config file as needed (the recommendations at the top may be helpful).
|
2016-10-16 13:01:53 +02:00
|
|
|
|
2017-03-24 03:43:55 +01:00
|
|
|
To generate passwords for opers and connect passwords, you can use this command:
|
|
|
|
|
|
2021-05-25 06:34:38 +02:00
|
|
|
$ ergo genpasswd
|
2017-03-24 03:43:55 +01:00
|
|
|
|
2021-01-31 04:07:51 +01:00
|
|
|
If you need to generate self-signed TLS certificates, use this command:
|
2016-10-16 13:01:53 +02:00
|
|
|
|
2021-05-25 06:34:38 +02:00
|
|
|
$ ergo mkcerts
|
2016-10-16 13:01:53 +02:00
|
|
|
|
2021-05-25 06:34:38 +02:00
|
|
|
You are now ready to start Ergo!
|
2021-01-31 04:07:51 +01:00
|
|
|
|
2021-05-25 06:34:38 +02:00
|
|
|
$ ergo run
|
2017-03-24 03:43:55 +01:00
|
|
|
|
2021-01-31 04:07:51 +01:00
|
|
|
For further instructions, consult the manual. A copy of the manual should be
|
|
|
|
|
included in your release under `docs/MANUAL.md`. Or you can view it on the
|
2021-05-25 06:34:38 +02:00
|
|
|
Web: https://ergo.chat/manual.html
|
2017-03-24 03:43:55 +01:00
|
|
|
|
|
|
|
|
=== Updating ===
|
|
|
|
|
|
2021-05-25 06:34:38 +02:00
|
|
|
If you're updating from a previous version of Ergo, check out the CHANGELOG for a list
|
2017-03-24 03:43:55 +01:00
|
|
|
of important changes you'll want to take a look at. The change log details config changes,
|
|
|
|
|
fixes, new features and anything else you'll want to be aware of!
|
|
|
|
|
|
2017-10-08 01:45:34 +02:00
|
|
|
=== Credits ===
|
|
|
|
|
|
2020-02-26 08:39:37 +01:00
|
|
|
* Jeremy Latt (2012-2014)
|
|
|
|
|
* Edmund Huber (2014-2015)
|
|
|
|
|
* Daniel Oaks (2016-present)
|
|
|
|
|
* Shivaram Lingamneni (2017-present)
|
|
|
|
|
* Many other contributors and friends of the project <3
|
