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
2022-05-24 17:07:03 +02:00
# Outline for YunoHost
2021-11-11 04:24:15 +01:00
2023-01-29 02:38:04 +01:00
[![Integration level ](https://dash.yunohost.org/integration/outline.svg )](https://dash.yunohost.org/appci/app/outline) ![Working status ](https://ci-apps.yunohost.org/ci/badges/outline.status.svg ) ![Maintenance status ](https://ci-apps.yunohost.org/ci/badges/outline.maintain.svg )
2022-05-24 17:07:03 +02:00
[![Install Outline with YunoHost ](https://install-app.yunohost.org/install-with-yunohost.svg )](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
2022-05-24 17:07:03 +02:00
> *This package allows you to install Outline quickly and simply on a YunoHost server.
2021-11-15 06:56:16 +01:00
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
2022-03-24 18:41:44 +01:00
- Including a Dex server to connect to Yunohost's LDAP userbase using an OIDC auth flow
- 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
2023-01-29 02:38:04 +01:00
**Shipped version:** 0.67.2~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
2022-05-24 17:07:03 +02:00
![Screenshot of Outline ](./doc/screenshots/outline_screenshot.png )
2021-11-17 06:16:56 +01:00
2021-11-15 06:56:16 +01:00
## Disclaimers / important information
2021-11-09 20:01:34 +01:00
2022-03-30 16:24:03 +02:00
### Not totally free licence
Outline is a softwared licenced under [BUSL 1.1 licence ](https://spdx.org/licenses/BUSL-1.1.html ).
⚠️ That licence **is not totally free** . Please read it very carefully if you have any commercial use in mind.
2022-07-22 08:35:17 +02:00
The Outline version shipped with this package (v0.65.2) will be released under Apache-2.0 licence [after May 23rd 2026 ](https://github.com/outline/outline/blob/151c2c731a94eefdda4e62f311308e9bd4615838/LICENSE ).
2022-03-30 16:24:03 +02:00
2021-11-17 06:16:56 +01:00
### Known limitations
2022-04-18 19:28:28 +02:00
1. The app can now run in the CI server and reach level 7. However, it is still very young and not broadly tested. **Please use it with extreme care if it's on a prod server**
2. The app requires [MinIO app ](https://github.com/YunoHost-apps/minio_ynh ) to be installed (MinIO installation and setup is automatic, though)
3. The app requires [Dex app ](https://github.com/YunoHost-apps/dex_ynh ) to be installed (Dex installation and setup is automatic, though)
4. The app is requiring three domains including two fully dedicated (one for MinIO server, one for Dex, one for Outline)
5. ARM architectures are not yet supported (But it should be achievable soon)
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
2022-03-31 15:27:51 +02:00
2021-11-15 06:56:16 +01:00
## Documentation and resources
2022-05-24 17:07:03 +02:00
* 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 >
2021-11-15 06:56:16 +01:00
## 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.
2022-05-24 17:07:03 +02:00
``` bash
2021-11-15 06:56:16 +01:00
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
```
2022-05-24 17:07:03 +02:00
**More info regarding app packaging:** < https: / / yunohost . org / packaging_apps >