mirror of
https://github.com/YunoHost-Apps/outline_ynh.git
synced 2024-09-03 19:56:12 +02:00
Auto-update README
This commit is contained in:
Yunohost-Bot
Yunohost-Bot
parent
efcb9a3228
commit
c5bb759a75
2 changed files with 80 additions and 57 deletions
83
README.md
83
README.md
|
|
@ -1,41 +1,68 @@
|
||||||
|
<!--
|
||||||
|
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.
|
||||||
|
-->
|
||||||
|
|
||||||
# Outline wiki for Yunohost
|
# Outline wiki for YunoHost
|
||||||
[](https://dash.yunohost.org/appci/app/outline)
|
|
||||||
|
[](https://dash.yunohost.org/appci/app/outline)  
|
||||||
|
[](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."
|
||||||
|
|
||||||
|
|
||||||
<img width="1640" alt="110356468-26374600-7fef-11eb-9f6a-f2cc2c8c6590" src="https://user-images.githubusercontent.com/24638389/134176351-8a7ecaf8-628e-49af-99b4-493287b36a77.png">
|
**Shipped version:** 0.60.1~ynh1
|
||||||
|
|
||||||
# Important points to read before installation
|
|
||||||
|
|
||||||
## 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!)
|
* Other infos that people should be aware of, such as:
|
||||||
- [ ] Two domains free of any apps (one for Outline, one for MinIO, an object storage server required by Outline)
|
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
|
||||||
- [ ] A correctly configured "Slack app" and the value of its "Client ID" and "Signing Secret" (see below for details)
|
* 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 :
|
* Official app website: www.getoutline.com
|
||||||
1. Visit https://api.slack.com/apps
|
* Official user documentation: https://www.getoutline.com/about
|
||||||
2. Sign in into a Slack workspace
|
* Official admin documentation: https://www.getoutline.com/developers
|
||||||
3. Create a new app from scratch
|
* Upstream app code repository: https://github.com/outline/outline
|
||||||
4. Give it a name and associate it to your workspace
|
* YunoHost documentation for this app: https://yunohost.org/app_outline
|
||||||
|
* Report a bug: https://github.com/YunoHost-Apps/outline_ynh/issues
|
||||||
|
|
||||||
|
## 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
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/outline_ynh/tree/testing).
|
||||||
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)
|
|
||||||
|
|
||||||
## 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 :
|
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
||||||
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)
|
|
||||||
54
README_fr.md
54
README_fr.md
|
|
@ -1,32 +1,30 @@
|
||||||
# Example app pour YunoHost
|
# Outline wiki pour YunoHost
|
||||||
[](https://dash.yunohost.org/appci/app/outline)
|
|
||||||
|
|
||||||
|
[](https://dash.yunohost.org/appci/app/outline)  
|
||||||
[](https://dash.yunohost.org/appci/app/example)  
|
[](https://install-app.yunohost.org/?app=outline)
|
||||||
[](https://install-app.yunohost.org/?app=example)
|
|
||||||
|
|
||||||
*[Read this readme in english.](./README.md)*
|
*[Read this readme in english.](./README.md)*
|
||||||
*[Lire ce readme en français.](./README_fr.md)*
|
*[Lire ce readme en français.](./README_fr.md)*
|
||||||
|
|
||||||
> *This package allows you to install example quickly and simply on a YunoHost server.
|
> *Ce package vous permet d'installer Outline wiki rapidement et simplement sur un serveur YunoHost.
|
||||||
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
|
||||||
|
|
||||||
## Vue d'ensemble
|
## 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
|
- 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 ;
|
||||||
## Captures d'écran
|
- 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
|
## 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 ?
|
* upgrade process / specificities / things to be aware of ?
|
||||||
* security considerations ?
|
* security considerations ?
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Documentations et ressources
|
## Documentations et ressources
|
||||||
|
|
||||||
* Site official de l'app : https://example.com
|
* Site officiel de l'app : www.getoutline.com
|
||||||
* Documentation officielle utilisateur: https://yunohost.org/apps
|
* Documentation officielle utilisateur : https://www.getoutline.com/about
|
||||||
* Documentation officielle de l'admin: https://yunohost.org/packaging_apps
|
* Documentation officielle de l'admin : https://www.getoutline.com/developers
|
||||||
* Dépôt de code officiel de l'app: https://some.forge.com/example/example
|
* Dépôt de code officiel de l'app : https://github.com/outline/outline
|
||||||
* Documentation YunoHost pour cette app: https://yunohost.org/app_example
|
* Documentation YunoHost pour cette app : https://yunohost.org/app_outline
|
||||||
* Signaler un bug: https://github.com/YunoHost-Apps/example_ynh/issues
|
* Signaler un bug : https://github.com/YunoHost-Apps/outline_ynh/issues
|
||||||
|
|
||||||
## Informations pour les développeurs
|
## 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.
|
Pour essayer la branche testing, procédez comme suit.
|
||||||
```
|
```
|
||||||
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
sudo yunohost app install https://github.com/YunoHost-Apps/outline_ynh/tree/testing --debug
|
||||||
or
|
ou
|
||||||
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug
|
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
|
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
|
||||||
Loading…
Add table
Reference in a new issue