diff --git a/README.md b/README.md index 32ac30b..65ca3e3 100644 --- a/README.md +++ b/README.md @@ -1,82 +1,57 @@ -# Standard Notes Syncing Server for YunoHost +# Standard Notes Server pour YunoHost -[![Integration level](https://dash.yunohost.org/integration/snserver.svg)](https://dash.yunohost.org/appci/app/snserver) -![Status](https://ci-apps.yunohost.org/ci/badges/snserver.status.svg) -![Maintained](https://ci-apps.yunohost.org/ci/badges/snserver.maintain.svg) +[![Niveau d'intégration](https://dash.yunohost.org/integration/snserver.svg)](https://dash.yunohost.org/appci/app/snserver) ![](https://ci-apps.yunohost.org/ci/badges/snserver.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/snserver.maintain.svg) +[![Installer snserver avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=snserver) -[![Install SNServer with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=snserver) +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* -> *This package allow you to install snserver 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.* +> *This package allows you to install snserver 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 - -Standard Notes syncing server - -You can run your own Standard Notes server and use it with any Standard Notes app. This allows you to have 100% control of your data. - -**Shipped version:** 3.22.8 -* Apps available for free. https://standardnotes.org/ -* Desktop (Windows, Mac, Linux) -* Mobile (Android and iOS) -* Web https://app.standardnotes.org/ -* Self-Hosted Yunohost - Web-App https://github.com/YunoHost-Apps/snweb_ynh -> Change Sync Server Domain during Registation and Sign in - -## Screenshots - -![](https://camo.githubusercontent.com/ca3744729c6c33f2f42d7917a4e7167c12a786615e14d1719f7d1ec6ed77aae8/68747470733a2f2f7374616e646172646e6f7465732e6f72672f6173736574732f686f6d65706167652d6865726f2e706e67) -Extensions, Editors, Themes: https://standardnotes.org/extensions +## Vue d'ensemble -## Demo -* [Official demo - Web App](https://standardnotes.org/demo) +**Version incluse:** 3.22.8~ynh2 -## Configuration +**Démo:** https://standardnotes.org/demo -How to configure this app: -* The config-file is stored under "/opt/yunohost/$app/live/.env" -* You can find additional config features under https://your-domain.tld/yunohost/admin/#/apps/$app/config-panel -## Documentation - * Official documentation: https://docs.standardnotes.org -## YunoHost specific features +## Avertissements / informations importantes -#### Multi-users support +* Any known limitations, constrains or stuff not working, such as (but not limited to): + * No single-sign on or LDAP integration + * The app requires up 600MB of RAM to install + * The app requires at least 110MB of RAM to work properly. And will increase with use. -* Are LDAP and HTTP auth supported? LDAP=No HTTP=Yes -* Can the app be used by multiple users? Yes +* Other infos that people should be aware of, such as: + * The config-file is stored under "/opt/yunohost/$app/live/.env" + * You can find additional config features under https://your-domain.tld/yunohost/admin/#/apps/$app/config-panel + * You can change the url of this app, but than all useres have to reinstall the extensions. -#### Supported architectures -* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/snserver.svg)](https://ci-apps.yunohost.org/ci/apps/snserver/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/snserver.svg)](https://ci-apps-arm.yunohost.org/ci/apps/snserver/) -## Limitations +## Documentations et ressources -* If users have installed the extensions included in this package. The URL of the server should not be changed anymore. Otherwise the users will have to reinstall the extensions. +* Site official de l'app : https://standardnotes.org/ +* Documentation officielle utilisateur: https://docs.standardnotes.org/ +* Documentation officielle de l'admin: https://docs.standardnotes.org/ +* Dépôt de code officiel de l'app: https://github.com/standardnotes/syncing-server +* Documentation YunoHost pour cette app: https://yunohost.org/app_snserver +* Signaler un bug: https://github.com/YunoHost-Apps/snserver_ynh/issues -## Links +## Informations pour les développeurs - * Report a bug: https://github.com/YunoHost-Apps/snserver_ynh/issues - * App website: https://standardnotes.org/ - * Upstream app repository: https://github.com/standardnotes/syncing-server - * YunoHost website: https://yunohost.org/ +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/snserver_ynh/tree/testing). ---- - -Developers info ----------------- - -**Only if you want to use a testing branch for coding, instead of merging directly into master.** -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/snserver_ynh/tree/testing). - -To try the testing branch, please proceed like that. +Pour essayer la branche testing, procédez comme suit. ``` sudo yunohost app install https://github.com/YunoHost-Apps/snserver_ynh/tree/testing --debug or sudo yunohost app upgrade snserver -u https://github.com/YunoHost-Apps/snserver_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..65ca3e3 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,57 @@ +# Standard Notes Server pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/snserver.svg)](https://dash.yunohost.org/appci/app/snserver) ![](https://ci-apps.yunohost.org/ci/badges/snserver.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/snserver.maintain.svg) +[![Installer snserver avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=snserver) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install snserver 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.* + +## Vue d'ensemble + + + +**Version incluse:** 3.22.8~ynh2 + +**Démo:** https://standardnotes.org/demo + + + + +## Avertissements / informations importantes + +* Any known limitations, constrains or stuff not working, such as (but not limited to): + * No single-sign on or LDAP integration + * The app requires up 600MB of RAM to install + * The app requires at least 110MB of RAM to work properly. And will increase with use. + +* Other infos that people should be aware of, such as: + * The config-file is stored under "/opt/yunohost/$app/live/.env" + * You can find additional config features under https://your-domain.tld/yunohost/admin/#/apps/$app/config-panel + * You can change the url of this app, but than all useres have to reinstall the extensions. + + + +## Documentations et ressources + +* Site official de l'app : https://standardnotes.org/ +* Documentation officielle utilisateur: https://docs.standardnotes.org/ +* Documentation officielle de l'admin: https://docs.standardnotes.org/ +* Dépôt de code officiel de l'app: https://github.com/standardnotes/syncing-server +* Documentation YunoHost pour cette app: https://yunohost.org/app_snserver +* Signaler un bug: https://github.com/YunoHost-Apps/snserver_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/snserver_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/snserver_ynh/tree/testing --debug +or +sudo yunohost app upgrade snserver -u https://github.com/YunoHost-Apps/snserver_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/doc/.gitkeep b/doc/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md new file mode 100644 index 0000000..b1b5a02 --- /dev/null +++ b/doc/DISCLAIMER.md @@ -0,0 +1,9 @@ +* Any known limitations, constrains or stuff not working, such as (but not limited to): + * No single-sign on or LDAP integration + * The app requires up 600MB of RAM to install + * The app requires at least 110MB of RAM to work properly. And will increase with use. + +* Other infos that people should be aware of, such as: + * The config-file is stored under "/opt/yunohost/$app/live/.env" + * You can find additional config features under https://your-domain.tld/yunohost/admin/#/apps/$app/config-panel + * You can change the url of this app, but than all useres have to reinstall the extensions. diff --git a/doc/screenshots/.gitkeep b/doc/screenshots/.gitkeep new file mode 100644 index 0000000..e69de29