mirror of
				https://github.com/ergochat/ergo.git
				synced 2025-11-03 23:37:22 +01:00 
			
		
		
		
	
		
			
				
	
	
		
			63 lines
		
	
	
		
			2.3 KiB
		
	
	
	
		
			Plaintext
		
	
	
	
	
	
			
		
		
	
	
			63 lines
		
	
	
		
			2.3 KiB
		
	
	
	
		
			Plaintext
		
	
	
	
	
	
 | 
						|
                                 ▄▄▄   ▄▄▄·  ▄▄ •        ▐ ▄       
 | 
						|
                           ▪     ▀▄ █·▐█ ▀█ ▐█ ▀ ▪▪     •█▌▐█▪     
 | 
						|
                            ▄█▀▄ ▐▀▀▄ ▄█▀▀█ ▄█ ▀█▄ ▄█▀▄▪▐█▐▐▌ ▄█▀▄ 
 | 
						|
                           ▐█▌.▐▌▐█•█▌▐█ ▪▐▌▐█▄▪▐█▐█▌ ▐▌██▐█▌▐█▌.▐▌
 | 
						|
                            ▀█▄▀▪.▀  ▀ ▀  ▀ ·▀▀▀▀  ▀█▄▀ ▀▀ █▪ ▀█▄▀▪
 | 
						|
 | 
						|
-----------------------------------------------------------------------------------------------
 | 
						|
 | 
						|
Oragono is a modern 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 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 can run this command to upgrade it manually:
 | 
						|
 | 
						|
    $ oragono upgradedb
 | 
						|
 | 
						|
Otherwise, just starting the server will run an automagic backup and upgrade.
 | 
						|
 | 
						|
 | 
						|
=== Credits ===
 | 
						|
 | 
						|
* 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
 |