2021-11-15 06:56:16 +01:00
<!--
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.
-->
2021-09-21 00:25:53 +02:00
2021-11-15 06:56:16 +01:00
# Outline wiki for YunoHost
2021-11-11 04:24:15 +01:00
2021-11-15 06:56:16 +01:00
[](https://dash.yunohost.org/appci/app/outline)  
[](https://install-app.yunohost.org/?app=outline)
2021-11-11 04:24:15 +01:00
2021-11-15 06:56:16 +01:00
*[Lire ce readme en français.](./README_fr.md)*
2021-09-23 19:17:31 +02:00
2021-11-15 06:56:16 +01:00
> *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.*
2021-09-24 13:43:57 +02:00
2021-11-15 06:56:16 +01:00
## Overview
2021-09-24 13:43:57 +02:00
2021-11-17 06:16:56 +01:00
The fastest wiki and knowledge base for growing teams. Beautiful, feature rich, and markdown compatible.
2021-11-09 20:01:34 +01:00
2021-11-15 06:56:16 +01:00
### Features
2021-11-09 20:01:34 +01:00
2021-11-17 06:16:56 +01:00
- Fully working installation of Outline wiki
- Including a MinIO server for avatars and picture object storage
- Setup using Yunohost's built-in SMTP server for notifications
2021-09-24 13:45:41 +02:00
2021-09-24 13:41:32 +02:00
2022-03-01 18:17:56 +01:00
**Shipped version:** 0.62.0~ynh1
2021-09-24 13:41:32 +02:00
2021-11-15 06:56:16 +01:00
**Demo:** https://app.getoutline.com/create
2021-11-09 20:01:34 +01:00
2021-11-17 06:16:56 +01:00
## Screenshots
2021-11-15 06:56:16 +01:00
## Disclaimers / important information
2021-11-09 20:01:34 +01:00
2021-11-17 06:16:56 +01:00
### Known limitations
2021-11-17 06:23:18 +01:00
1. Because this app can't yet run in the CI server, its integration level is unkonwn at the moment and standard Yunohost packages testing couldn't run yet. **Please don't use it on a prod server**
2. The app requires MinIO app to be installed (MinIO installation is automatic, though)
2022-03-24 16:26:12 +01:00
3. The app is requiring three domains including two fully dedicated (one for MinIO server, one for Dex, one for Outline)
2021-11-17 06:23:18 +01:00
4. ARM architectures are not supported (and may never be as Outline was built for AMD64)
6. Because it's built from sources, the app requires an important amount of RAM, disk and time to install properly
2021-11-17 06:16:56 +01:00
2022-03-24 16:26:12 +01:00
### How to create an admin user
2021-11-17 06:16:56 +01:00
2022-03-24 16:26:12 +01:00
The first user to login will automatically be granted admin rights
You can then change the user rights by default and/or change the admin user afterwards from the Outline settings page
2021-11-15 06:56:16 +01:00
## Documentation and resources
* 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
## Developer info
Please send your pull request to the [testing branch ](https://github.com/YunoHost-Apps/outline_ynh/tree/testing ).
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
```
**More info regarding app packaging:** https://yunohost.org/packaging_apps
