mirror of
https://github.com/ergochat/ergo.git
synced 2024-11-25 05:19:25 +01:00
67 lines
2.9 KiB
Plaintext
67 lines
2.9 KiB
Plaintext
|
|
▄▄▄ ▄▄▄· ▄▄ • ▐ ▄
|
|
▪ ▀▄ █·▐█ ▀█ ▐█ ▀ ▪▪ •█▌▐█▪
|
|
▄█▀▄ ▐▀▀▄ ▄█▀▀█ ▄█ ▀█▄ ▄█▀▄▪▐█▐▐▌ ▄█▀▄
|
|
▐█▌.▐▌▐█•█▌▐█ ▪▐▌▐█▄▪▐█▐█▌ ▐▌██▐█▌▐█▌.▐▌
|
|
▀█▄▀▪.▀ ▀ ▀ ▀ ·▀▀▀▀ ▀█▄▀ ▀▀ █▪ ▀█▄▀▪
|
|
|
|
-----------------------------------------------------------------------------------------------
|
|
|
|
Oragono is a modern, experimental IRC server written in Go. It's designed to be simple to setup
|
|
and use, and to provide the majority of features that IRC users expect today.
|
|
|
|
It includes features such as UTF-8 nicks and channel names, client accounts and SASL, and other
|
|
assorted IRCv3 support.
|
|
|
|
https://oragono.io/
|
|
https://github.com/oragono/oragono
|
|
|
|
-----------------------------------------------------------------------------------------------
|
|
|
|
|
|
=== Installing ===
|
|
|
|
Copy the example config file to ircd.yaml with a command like:
|
|
|
|
$ cp oragono.yaml ircd.yaml
|
|
|
|
Modify the config file as you like. In particular, the `connection-throttling` and
|
|
`connection-limits` sections are working looking over and tuning for your network's needs.
|
|
|
|
To generate passwords for opers and connect passwords, you can use this command:
|
|
|
|
$ oragono genpasswd
|
|
|
|
Run these commands in order -- these will setup each section of the server:
|
|
|
|
$ oragono initdb
|
|
$ oragono mkcerts
|
|
$ oragono run
|
|
|
|
And you should now be running Oragono!
|
|
|
|
|
|
=== Updating ===
|
|
|
|
If you're updating from a previous version of Oragono, checkout the CHANGELOG for a shortlist
|
|
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!
|
|
|
|
If there's been a database update, you'll also need to run this command:
|
|
|
|
$ oragono upgradedb
|
|
|
|
|
|
=== Credits ===
|
|
|
|
* Jeremy Latt, creator of Ergonomadic, <https://github.com/jlatt>
|
|
* Edmund Huber, maintainer of Ergonomadic, <https://github.com/edmund-huber>
|
|
* Niels Freier, added WebSocket support to Ergonomadic, <https://github.com/stumpyfr>
|
|
* Daniel Oakley, maintainer of Oragono, <https://github.com/DanielOaks>
|
|
* Euan Kemp, contributor to Oragono and lots of useful fixes, <https://github.com/euank>
|
|
* Shivaram Lingamneni, has contributed a ton of fixes, refactoring, and general improvements, <https://github.com/slingamn>
|
|
* James Mills, contributed Docker support, <https://github.com/prologic>
|
|
* Vegax, implementing some commands and helping when Oragono was just getting started, <https://github.com/vegax87>
|
|
* Sean Enck, transitioned us from using a custom script to a proper Makefile, <https://github.com/enckse>
|
|
* apologies to anyone I forgot.
|