Shivaram Lingamneni 5b317d4846 fix #1751 | 3 年之前 | |
---|---|---|
.github/workflows | 3 年之前 | |
distrib | 3 年之前 | |
docs | 3 年之前 | |
irc | 3 年之前 | |
irctest @ a29b7c5631 | 3 年之前 | |
languages | 3 年之前 | |
vendor | 3 年之前 | |
.check-gofmt.sh | 3 年之前 | |
.gitattributes | 4 年之前 | |
.gitignore | 3 年之前 | |
.gitmodules | 3 年之前 | |
.goreleaser.yml | 3 年之前 | |
CHANGELOG.md | 3 年之前 | |
DEVELOPING.md | 3 年之前 | |
Dockerfile | 3 年之前 | |
LICENSE | 4 年之前 | |
Makefile | 3 年之前 | |
README | 3 年之前 | |
README.md | 3 年之前 | |
crowdin.yml | 5 年之前 | |
default.yaml | 3 年之前 | |
ergo.go | 3 年之前 | |
ergo.motd | 3 年之前 | |
gencapdefs.py | 3 年之前 | |
go.mod | 3 年之前 | |
go.sum | 3 年之前 | |
traditional.yaml | 3 年之前 | |
updatetranslations.py | 4 年之前 |
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 (KLINE
and DLINE
are also supported)For more detailed information on Ergo’s functionality, see:
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
README file.
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.
The 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.
The stable
branch contains the latest release, suitable for use in production.
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:
ergo genpasswd
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:
/join #channel
/CS REGISTER #channel
After this, your channel will remember the fact that you’re the owner, the topic, and any modes set on it!