mirror of https://github.com/YunoHost-Apps/ergo_ynh.git synced 2024-09-03 18:26:31 +02:00

Ergo (IRC server) package for YunoHost

Find a file

navanchauhan fc65f16bb3 fix default plaintext listener		2022-05-31 16:46:59 -06:00
conf	fix default plaintext listener	2022-05-31 16:46:59 -06:00
doc	First commit	2022-04-18 11:09:01 +02:00
scripts	close firewall on uninstall	2022-05-31 16:13:50 -06:00
sources	First commit	2022-04-18 11:09:01 +02:00
check_process	First commit	2022-04-18 11:09:01 +02:00
config_panel.toml.example	First commit	2022-04-18 11:09:01 +02:00
LICENSE	Update LICENSE	2022-04-18 11:16:52 +02:00
manifest.json	bump version	2022-05-31 15:41:22 -06:00
README.md	Auto-update README	2022-04-18 09:09:06 +00:00
README_fr.md	Auto-update README	2022-04-18 09:09:06 +00:00

README.md

Ergo for YunoHost

Lire ce readme en français.

This package allows you to install Ergo quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

Ergo (formerly known as Oragono) is a modern IRC server written in Go. Its core design

Features

Being simple to set up and use
Combining the features of an ircd, a services framework, and a bouncer (integrated account management, history storage, and bouncer functionality)
Bleeding-edge IRCv3 support, suitable for use as an IRCv3 reference implementation
High customizability via a rehashable (i.e., reloadable at runtime) YAML config

Shipped version: 2.9.1~ynh1

Demo: https://testnet.ergo.chat/

Screenshots

Disclaimers / important information

Any known limitations, constrains or stuff not working, such as (but not limited to):
- requiring a full dedicated domain ?
- architectures not supported ?
- not-working single-sign on or LDAP integration ?
- the app requires an important amount of RAM / disk / .. to install or to work properly
- etc...
Other infos that people should be aware of, such as:
- any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
- how to configure / administrate the application if it ain't obvious
- upgrade process / specificities / things to be aware of ?
- security considerations ?

Documentation and resources

Official app website: https://ergo.chat/
Official user documentation: https://github.com/ergochat/ergo/blob/stable/docs/USERGUIDE.md
Official admin documentation: https://github.com/ergochat/ergo/blob/stable/docs/MANUAL.md
Upstream app code repository: https://github.com/ergochat/ergo
YunoHost documentation for this app: https://yunohost.org/app_ergo
Report a bug: https://github.com/YunoHost-Apps/ergo_ynh/issues

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

sudo yunohost app install https://github.com/YunoHost-Apps/ergo_ynh/tree/testing --debug
or
sudo yunohost app upgrade ergo -u https://github.com/YunoHost-Apps/ergo_ynh/tree/testing --debug

More info regarding app packaging: https://yunohost.org/packaging_apps