2021-11-15 06:56:16 +01:00
|
|
|
<!--
|
2024-02-21 10:57:50 +01:00
|
|
|
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/readme_generator
|
2021-11-15 06:56:16 +01:00
|
|
|
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
|
|
|
[](https://dash.yunohost.org/appci/app/outline)  
|
2023-03-28 12:13:42 +02:00
|
|
|
|
2022-05-24 17:07:03 +02:00
|
|
|
[](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
|
|
|
|
2023-10-19 19:07:31 +02:00
|
|
|
Outline is a 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
|
2023-10-19 19:07:31 +02:00
|
|
|
- Including a Dex server to connect to YunoHost's LDAP userbase using an OIDC auth flow
|
2022-03-24 18:41:44 +01:00
|
|
|
- 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
|
|
|
|
2024-02-21 10:57:50 +01:00
|
|
|
**Shipped version:** 0.75.0~ynh2
|
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
|
|
|
|
|
|
2023-10-19 18:57:19 +02:00
|
|
|
|
2021-11-17 06:16:56 +01:00
|
|
|
|
2023-03-28 12:13:42 +02:00
|
|
|
## :red_circle: Antifeatures
|
|
|
|
|
|
|
|
|
|
- **Not totally free upstream**: The packaged app is under an overall free licence, but with clauses that restrict its use.
|
|
|
|
|
|
2021-11-15 06:56:16 +01:00
|
|
|
## Documentation and resources
|
|
|
|
|
|
2023-02-08 17:26:18 +01:00
|
|
|
* Official app website: <https://www.getoutline.com>
|
2022-05-24 17:07:03 +02:00
|
|
|
* 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>
|
2024-01-22 19:03:41 +01:00
|
|
|
* YunoHost Store: <https://apps.yunohost.org/app/outline>
|
2022-05-24 17:07:03 +02:00
|
|
|
* 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
|
|
|
|
|
```
|
|
|
|
|
|
2024-02-21 10:57:50 +01:00
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|
