diff --git a/README.md b/README.md index 61d3cfe..0d011a2 100644 --- a/README.md +++ b/README.md @@ -1,79 +1 @@ - - -# Zap for YunoHost - -[![Integration level](https://dash.yunohost.org/integration/zap.svg)](https://dash.yunohost.org/appci/app/zap) ![Working status](https://ci-apps.yunohost.org/ci/badges/zap.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/zap.maintain.svg) - -[![Install Zap with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=zap) - -*[Lire ce readme en français.](./README_fr.md)* - -> *This package allows you to install Zap quickly and simply on a YunoHost server. -If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* - -## Overview - -[Zap](https://zotlabs.com/zap/) is an an ethical alternative to Fediverse that provides powerful features for creating interconnected websites featuring a decentralized identity, communications, and permissions framework built using common webserver technology. - -Compatible with **Mastodon**, **Pleroma**, **Pixelfed**, **Friendica**, **Hubzilla**, **Funkwhale**, **Peertube**, **Plume**, **WriteFreely** and many, many more. - -## Unique Features of ZAP - -- **Groups** : public, private, and moderated. -- **Events** : Calendar and attendance; automatic birthday notifications for friends using this feature. -- **Cloud**storage : Built-in network file storage integrated with social networking access. -- **Editor** : Supports both markdown and bbcode. Use either or both - if you want. -- **Share**: Drag-and-drop a number of different things such as files, photos, webpages, maps, phone numbers to share- them. -- **Lists**: Sometimes referred to as circles or aspects, this lets you define your own groups of related friends and- communicate with them as a private group. -- **Extend** : Change or upgrade your software functionality as desired by installing additional features from addons and- the free app collection. - - -**Shipped version:** 21.11.28~ynh1 -## Disclaimers / important information - -## Installation - -Before installing, read the [Zap installation instructions](https://codeberg.org/zot/zap/src/branch/release/install/INSTALL.txt) for important information about: - -### Register a new domain and add it to YunoHost - -- Zap requires a dedicated domain, so obtain one and add it using the YunoHost admin panel. **Domains -> Add domain**. As Zap uses the full domain and is installed on the root, you can create a subdomain such as Zap.domain.tld. Don't forget to update your DNS if you manage them manually. - -## LDAP Admin user rights, logs and failed database updates - -- **For admin rights**: When installation is complete, you will need to visit your new hub's page and login with the **admin account username** which was entered at the time of installation process. You should then be able to create your first channel and have the **admin rights** for the hub. - -- **For normal YunoHost users :** Normal LDAP users can login through Ldap authentication and create there channels. - -- **Failing to get admin rights :** If the admin cannot access the admin settings at `https://zap.example.com/admin` or you want to grant admin rights to any other user(s) on the hub, then you have to **manually add 4096** to the **account_roles** under **accounts** for that user in the **database through phpMYAdmin**. - -- **For logs:** Go to **admin->logs** and enter the file name **php.log**. - -- **Failed Database after Upgrade:** Some times databse upgrade fails after version upgrade. You can go to hub eg. `https://zap.example.com/admin/dbsync/` and check the numbers of failled update. These updates will have to be ran manually by **phpMYAdmin**. - -## :red_circle: Antifeatures - -- **Upstream not maintained**: This software is not maintained anymore. Expect it to break down over time, be exposed to unfixed security breaches, etc. - -## Documentation and resources - -* Upstream app code repository: -* YunoHost documentation for this app: -* Report a bug: - -## Developer info - -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/zap_ynh/tree/testing). - -To try the testing branch, please proceed like that. - -``` bash -sudo yunohost app install https://github.com/YunoHost-Apps/zap_ynh/tree/testing --debug -or -sudo yunohost app upgrade zap -u https://github.com/YunoHost-Apps/zap_ynh/tree/testing --debug -``` - -**More info regarding app packaging:** +# Streams for YunoHost diff --git a/README_fr.md b/README_fr.md index bd83268..951fd52 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,79 +1 @@ - - -# Zap pour YunoHost - -[![Niveau d’intégration](https://dash.yunohost.org/integration/zap.svg)](https://dash.yunohost.org/appci/app/zap) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/zap.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/zap.maintain.svg) - -[![Installer Zap avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=zap) - -*[Read this readme in english.](./README.md)* - -> *Ce package vous permet d’installer Zap rapidement et simplement sur un serveur YunoHost. -Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l’installer et en profiter.* - -## Vue d’ensemble - -[Zap](https://zotlabs.com/zap/) is an an ethical alternative to Fediverse that provides powerful features for creating interconnected websites featuring a decentralized identity, communications, and permissions framework built using common webserver technology. - -Compatible with **Mastodon**, **Pleroma**, **Pixelfed**, **Friendica**, **Hubzilla**, **Funkwhale**, **Peertube**, **Plume**, **WriteFreely** and many, many more. - -## Unique Features of ZAP - -- **Groups** : public, private, and moderated. -- **Events** : Calendar and attendance; automatic birthday notifications for friends using this feature. -- **Cloud**storage : Built-in network file storage integrated with social networking access. -- **Editor** : Supports both markdown and bbcode. Use either or both - if you want. -- **Share**: Drag-and-drop a number of different things such as files, photos, webpages, maps, phone numbers to share- them. -- **Lists**: Sometimes referred to as circles or aspects, this lets you define your own groups of related friends and- communicate with them as a private group. -- **Extend** : Change or upgrade your software functionality as desired by installing additional features from addons and- the free app collection. - - -**Version incluse :** 21.11.28~ynh1 -## Avertissements / informations importantes - -## Installation - -Before installing, read the [Zap installation instructions](https://codeberg.org/zot/zap/src/branch/release/install/INSTALL.txt) for important information about: - -### Register a new domain and add it to YunoHost - -- Zap requires a dedicated domain, so obtain one and add it using the YunoHost admin panel. **Domains -> Add domain**. As Zap uses the full domain and is installed on the root, you can create a subdomain such as Zap.domain.tld. Don't forget to update your DNS if you manage them manually. - -## LDAP Admin user rights, logs and failed database updates - -- **For admin rights**: When installation is complete, you will need to visit your new hub's page and login with the **admin account username** which was entered at the time of installation process. You should then be able to create your first channel and have the **admin rights** for the hub. - -- **For normal YunoHost users :** Normal LDAP users can login through Ldap authentication and create there channels. - -- **Failing to get admin rights :** If the admin cannot access the admin settings at `https://zap.example.com/admin` or you want to grant admin rights to any other user(s) on the hub, then you have to **manually add 4096** to the **account_roles** under **accounts** for that user in the **database through phpMYAdmin**. - -- **For logs:** Go to **admin->logs** and enter the file name **php.log**. - -- **Failed Database after Upgrade:** Some times databse upgrade fails after version upgrade. You can go to hub eg. `https://zap.example.com/admin/dbsync/` and check the numbers of failled update. These updates will have to be ran manually by **phpMYAdmin**. - -## :red_circle: Fonctions indésirables - -- **Upstream not maintained**: This software is not maintained anymore. Expect it to break down over time, be exposed to unfixed security breaches, etc. - -## Documentations et ressources - -* Dépôt de code officiel de l’app : -* Documentation YunoHost pour cette app : -* Signaler un bug : - -## Informations pour les développeurs - -Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/zap_ynh/tree/testing). - -Pour essayer la branche testing, procédez comme suit. - -``` bash -sudo yunohost app install https://github.com/YunoHost-Apps/zap_ynh/tree/testing --debug -ou -sudo yunohost app upgrade zap -u https://github.com/YunoHost-Apps/zap_ynh/tree/testing --debug -``` - -**Plus d’infos sur le packaging d’applications :** \ No newline at end of file +# Streams pour YunoHost