2022-04-18 11:09:01 +02:00
|
|
|
<!--
|
|
|
|
|
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
|
|
|
|
It shall NOT be edited by hand.
|
|
|
|
|
-->
|
|
|
|
|
|
2022-04-18 11:09:06 +02:00
|
|
|
# Ergo for YunoHost
|
2022-04-18 11:09:01 +02:00
|
|
|
|
2023-02-04 16:31:06 +01:00
|
|
|
[](https://dash.yunohost.org/appci/app/ergo)  
|
2023-06-06 20:35:59 +02:00
|
|
|
|
2022-04-18 11:09:06 +02:00
|
|
|
[](https://install-app.yunohost.org/?app=ergo)
|
2022-04-18 11:09:01 +02:00
|
|
|
|
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
|
|
2022-04-18 11:09:06 +02:00
|
|
|
> *This package allows you to install Ergo quickly and simply on a YunoHost server.
|
2022-04-18 11:09:01 +02:00
|
|
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
|
|
|
|
|
|
|
|
|
## Overview
|
|
|
|
|
|
2022-04-18 11:09:06 +02:00
|
|
|
Ergo (formerly known as Oragono) is a modern IRC server written in Go. Its core design
|
2022-04-18 11:09:01 +02:00
|
|
|
|
2022-04-18 11:09:06 +02:00
|
|
|
### Features
|
2022-04-18 11:09:01 +02:00
|
|
|
|
2022-04-18 11:09:06 +02:00
|
|
|
- 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
|
2022-04-18 11:09:01 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2024-01-28 21:31:06 +01:00
|
|
|
**Shipped version:** 2.13.0~ynh1
|
2022-04-18 11:09:01 +02:00
|
|
|
|
2022-04-18 11:09:06 +02:00
|
|
|
**Demo:** https://testnet.ergo.chat/
|
2022-07-10 08:21:10 +02:00
|
|
|
|
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2022-04-18 11:09:01 +02:00
|
|
|
## Documentation and resources
|
|
|
|
|
|
2022-07-06 19:18:23 +02:00
|
|
|
* 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>
|
2023-10-31 15:09:17 +01:00
|
|
|
* YunoHost Store: <https://apps.yunohost.org/app/ergo>
|
2022-07-06 19:18:23 +02:00
|
|
|
* Report a bug: <https://github.com/YunoHost-Apps/ergo_ynh/issues>
|
2022-04-18 11:09:01 +02:00
|
|
|
|
|
|
|
|
## Developer info
|
|
|
|
|
|
2022-04-18 11:09:06 +02:00
|
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/ergo_ynh/tree/testing).
|
2022-04-18 11:09:01 +02:00
|
|
|
|
|
|
|
|
To try the testing branch, please proceed like that.
|
2022-07-06 19:18:23 +02:00
|
|
|
|
|
|
|
|
``` bash
|
2022-04-18 11:09:06 +02:00
|
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/ergo_ynh/tree/testing --debug
|
2022-04-18 11:09:01 +02:00
|
|
|
or
|
2022-04-18 11:09:06 +02:00
|
|
|
sudo yunohost app upgrade ergo -u https://github.com/YunoHost-Apps/ergo_ynh/tree/testing --debug
|
2022-04-18 11:09:01 +02:00
|
|
|
```
|
|
|
|
|
|
2022-07-06 19:18:23 +02:00
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|
