ergo/docs

                                 ▄▄▄   ▄▄▄·  ▄▄ •        ▐ ▄       
                           ▪     ▀▄ █·▐█ ▀█ ▐█ ▀ ▪▪     •█▌▐█▪     
                            ▄█▀▄ ▐▀▀▄ ▄█▀▀█ ▄█ ▀█▄ ▄█▀▄▪▐█▐▐▌ ▄█▀▄ 
                           ▐█▌.▐▌▐█•█▌▐█ ▪▐▌▐█▄▪▐█▐█▌ ▐▌██▐█▌▐█▌.▐▌
                            ▀█▄▀▪.▀  ▀ ▀  ▀ ·▀▀▀▀  ▀█▄▀ ▀▀ █▪ ▀█▄▀▪

-----------------------------------------------------------------------------------------------

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.

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