diff --git a/README.md b/README.md index cb7bb62..b59ccab 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,68 @@ + -# Outline wiki for Yunohost -[![Integration level](https://dash.yunohost.org/integration/outline.svg)](https://dash.yunohost.org/appci/app/outline) +# Outline wiki for YunoHost + +[![Integration level](https://dash.yunohost.org/integration/outline.svg)](https://dash.yunohost.org/appci/app/outline) ![](https://ci-apps.yunohost.org/ci/badges/outline.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/outline.maintain.svg) +[![Install Outline wiki with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=outline) + +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install Outline wiki 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 + +Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. + +### Features + +- Ut enim ad minim veniam, quis nostrud exercitation ullamco ; +- Laboris nisi ut aliquip ex ea commodo consequat ; +- Duis aute irure dolor in reprehenderit in voluptate ; +- Velit esse cillum dolore eu fugiat nulla pariatur ; +- Excepteur sint occaecat cupidatat non proident, sunt in culpa." - 110356468-26374600-7fef-11eb-9f6a-f2cc2c8c6590 - -# Important points to read before installation +**Shipped version:** 0.60.1~ynh1 -## This is a Yunohost package +**Demo:** https://app.getoutline.com/create -YunoHost is an operating system aiming to simplify as much as possible the administration of a server. You can visit yunohost.org or forum.yunohost.org for more information or help. +## Disclaimers / important information -## What you will need for installation +* 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... -- [ ] A testing Yunohost server (please don't install this on a production server yet!) -- [ ] Two domains free of any apps (one for Outline, one for MinIO, an object storage server required by Outline) -- [ ] A correctly configured "Slack app" and the value of its "Client ID" and "Signing Secret" (see below for details) +* 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 ? -## How to create a "Slack app" and get your "Client ID" and "Signing Secret" +## Documentation and resources -You should perform all below steps before starting the package installation on Yunohost : -1. Visit https://api.slack.com/apps -2. Sign in into a Slack workspace -3. Create a new app from scratch -4. Give it a name and associate it to your workspace +* Official app website: www.getoutline.com +* Official user documentation: https://www.getoutline.com/about +* Official admin documentation: https://www.getoutline.com/developers +* Upstream app code repository: https://github.com/outline/outline +* YunoHost documentation for this app: https://yunohost.org/app_outline +* Report a bug: https://github.com/YunoHost-Apps/outline_ynh/issues -![image](https://user-images.githubusercontent.com/24638389/134668089-3b1a73f2-dbca-47c4-8e57-1ee26d1c034a.png) +## Developer info -6. In the basic information tab, you'll find a "Client ID" and a "Signing Secret" - keep both as you'll need them to run the package installation -7. Go to "Features" then "OAuth & Permissions" -8. Add a new redirect URL. Use https://example.mydomain.fr/auth/slack.callback (assuming https://example.mydomain.fr is the domain on which you will install outline package) +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/outline_ynh/tree/testing). -## How to launch installation +To try the testing branch, please proceed like that. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/outline_ynh/tree/testing --debug +or +sudo yunohost app upgrade outline -u https://github.com/YunoHost-Apps/outline_ynh/tree/testing --debug +``` -That app is not yet on the official Yunohost-Apps repo, so you'll need to follow the below steps : -1. Log in your webadmin -2. Go to Applications > Install -3. Scroll to the bottom and copy paste `https://github.com/Limezy/outline_ynh/tree/v0.3 into the "Install custom app" box4. -4. Fill in all fields and validate -5. Be patient as the installation can take up to 15 minutes ! (There is package building involved) +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md index 739e0a4..e111e50 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,32 +1,30 @@ -# Example app pour YunoHost -[![Integration level](https://dash.yunohost.org/integration/outline.svg)](https://dash.yunohost.org/appci/app/outline) +# Outline wiki pour YunoHost - -[![Niveau d'intégration](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) -[![Installer example avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example) +[![Niveau d'intégration](https://dash.yunohost.org/integration/outline.svg)](https://dash.yunohost.org/appci/app/outline) ![](https://ci-apps.yunohost.org/ci/badges/outline.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/outline.maintain.svg) +[![Installer Outline wiki avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=outline) *[Read this readme in english.](./README.md)* *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install example 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.* +> *Ce package vous permet d'installer Outline wiki 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 -Expliquez en *quelques* (10~15) mots l'utilité de l'app ou ce qu'elle fait (l'objectif est de donner une idée grossière pour des utilisateurs qui naviguent dans un catalogue de 100+ apps) +Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. -**Version incluse:** 1.0~ynh1 +### Features -**Démo:** https://demo.example.com - - -## Captures d'écran - - - ![](./doc/screenshots/example.jpg) +- Ut enim ad minim veniam, quis nostrud exercitation ullamco ; +- Laboris nisi ut aliquip ex ea commodo consequat ; +- Duis aute irure dolor in reprehenderit in voluptate ; +- Velit esse cillum dolore eu fugiat nulla pariatur ; +- Excepteur sint occaecat cupidatat non proident, sunt in culpa." +**Version incluse :** 0.60.1~ynh1 +**Démo :** https://app.getoutline.com/create ## Avertissements / informations importantes @@ -43,26 +41,24 @@ Expliquez en *quelques* (10~15) mots l'utilité de l'app ou ce qu'elle fait (l'o * upgrade process / specificities / things to be aware of ? * security considerations ? - - ## Documentations et ressources -* Site official de l'app : https://example.com -* Documentation officielle utilisateur: https://yunohost.org/apps -* Documentation officielle de l'admin: https://yunohost.org/packaging_apps -* Dépôt de code officiel de l'app: https://some.forge.com/example/example -* Documentation YunoHost pour cette app: https://yunohost.org/app_example -* Signaler un bug: https://github.com/YunoHost-Apps/example_ynh/issues +* Site officiel de l'app : www.getoutline.com +* Documentation officielle utilisateur : https://www.getoutline.com/about +* Documentation officielle de l'admin : https://www.getoutline.com/developers +* Dépôt de code officiel de l'app : https://github.com/outline/outline +* Documentation YunoHost pour cette app : https://yunohost.org/app_outline +* Signaler un bug : https://github.com/YunoHost-Apps/outline_ynh/issues ## Informations pour les développeurs -Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/example_ynh/tree/testing). +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/outline_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. ``` -sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug -or -sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug +sudo yunohost app install https://github.com/YunoHost-Apps/outline_ynh/tree/testing --debug +ou +sudo yunohost app upgrade outline -u https://github.com/YunoHost-Apps/outline_ynh/tree/testing --debug ``` -**Plus d'infos sur le packaging d'applications:** https://yunohost.org/packaging_apps \ No newline at end of file +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file