1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/gotify_ynh.git synced 2024-09-03 20:36:26 +02:00
gotify_ynh/README.md

57 lines
1.9 KiB
Markdown
Raw Normal View History

2019-02-17 21:24:39 +01:00
# Gotify for YunoHost
2019-02-16 15:00:20 +01:00
2020-06-08 17:04:22 +02:00
[![Integration level](https://dash.yunohost.org/integration/gotify.svg)](https://dash.yunohost.org/appci/app/gotify) ![](https://ci-apps.yunohost.org/ci/badges/gotify.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/gotify.maintain.svg)
2019-03-10 17:39:30 +01:00
[![Install Gotify with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=gotify)
2019-02-16 15:00:20 +01:00
2019-03-10 17:39:30 +01:00
*[Lire ce readme en français.](./README_fr.md)*
2020-06-08 17:04:22 +02:00
2019-02-16 15:00:20 +01:00
> *This package allow you to install Gotify quickly and simply on a YunoHost server.
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
## Overview
Gotify is a simple server for sending and receiving messages in real-time per web socket. (Includes a sleek web-ui)
2021-04-17 10:24:53 +02:00
**Shipped version:** 2.0.22
2019-02-16 15:00:20 +01:00
## Screenshots
[![Screenshot](https://raw.githubusercontent.com/gotify/server/master/ui.png)](https://github.com/gotify/server)
## Configuration
How to configure this app:
2020-11-22 15:27:37 +01:00
> Edit `config.yml` file via SSH.
2019-02-16 15:00:20 +01:00
## Documentation
2020-06-08 17:04:22 +02:00
* Official documentation: https://gotify.net/docs/index
* YunoHost documentation: https://yunohost.org/#/app_gotify
2019-02-16 15:00:20 +01:00
#### Multi-users support
2020-06-08 17:04:22 +02:00
LDAP is not supported (blocked until Gotify core upstream implements it).
2019-02-16 15:00:20 +01:00
## Limitations
2020-11-22 15:27:37 +01:00
* Require dedicated domain like `gotify.domain.tld`
2019-02-16 15:00:20 +01:00
## Links
* Report a bug: https://github.com/YunoHost-Apps/gotify_ynh/issues
* App website: https://gotify.net/
2020-06-08 17:04:22 +02:00
* Upstream app repository: https://github.com/gotify/server
2019-02-16 15:00:20 +01:00
* YunoHost website: https://yunohost.org/
---
2019-03-10 17:39:30 +01:00
2020-11-22 15:27:37 +01:00
## Developers info
2019-03-10 17:39:30 +01:00
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/gotify_ynh/tree/testing).
To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/gotify_ynh/tree/testing --debug
or
2019-05-30 18:58:20 +02:00
sudo yunohost app upgrade gotify -u https://github.com/YunoHost-Apps/gotify_ynh/tree/testing --debug
2019-03-10 17:39:30 +01:00
```