2021-08-14 12:46:57 +02: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-08-14 17:45:20 +02:00
|
|
|
# Plainpad for YunoHost
|
2021-08-14 12:46:57 +02:00
|
|
|
|
2021-08-14 17:45:20 +02:00
|
|
|
[![Integration level](https://dash.yunohost.org/integration/plainpad.svg)](https://dash.yunohost.org/appci/app/plainpad) ![](https://ci-apps.yunohost.org/ci/badges/plainpad.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/plainpad.maintain.svg)
|
|
|
|
[![Install Plainpad with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=plainpad)
|
2021-08-14 12:46:57 +02:00
|
|
|
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
|
2021-08-14 17:45:20 +02:00
|
|
|
> *This package allows you to install Plainpad quickly and simply on a YunoHost server.
|
2021-08-14 12:46:57 +02:00
|
|
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
|
|
|
|
|
|
|
## Overview
|
|
|
|
|
2021-08-14 17:45:20 +02:00
|
|
|
Self hosted, note taking application
|
2021-08-14 12:46:57 +02:00
|
|
|
|
2021-08-14 17:45:20 +02:00
|
|
|
**Shipped version:** 1.0.0~ynh1
|
2021-08-14 12:46:57 +02:00
|
|
|
|
2021-08-14 17:45:20 +02:00
|
|
|
**Demo:** https://alextselegidis.com/try/plainpad/#/login
|
2021-08-14 12:46:57 +02:00
|
|
|
|
|
|
|
## Screenshots
|
|
|
|
|
2021-08-14 17:45:20 +02:00
|
|
|
![](./doc/screenshots/screenshot.png)
|
2021-08-14 12:46:57 +02:00
|
|
|
|
|
|
|
## Disclaimers / important information
|
|
|
|
|
2021-08-14 17:45:20 +02:00
|
|
|
## Configuration
|
2021-08-14 12:46:57 +02:00
|
|
|
|
2021-08-14 17:46:47 +02:00
|
|
|
The default credentials are:
|
2021-08-14 17:45:20 +02:00
|
|
|
```
|
|
|
|
username: admin@example.org
|
|
|
|
password: 12345
|
2021-08-14 17:46:47 +02:00
|
|
|
```
|
2021-08-14 12:46:57 +02:00
|
|
|
## Documentation and resources
|
|
|
|
|
2021-08-14 17:45:20 +02:00
|
|
|
* Official app website: https://alextselegidis.com/get/plainpad
|
|
|
|
* Official admin documentation: https://alextselegidis.com/get/plainpad/self-hosted
|
|
|
|
* Upstream app code repository: https://github.com/alextselegidis/plainpad
|
|
|
|
* YunoHost documentation for this app: https://yunohost.org/app_plainpad
|
|
|
|
* Report a bug: https://github.com/YunoHost-Apps/plainpad_ynh/issues
|
2021-08-14 12:46:57 +02:00
|
|
|
|
|
|
|
## Developer info
|
|
|
|
|
2021-08-14 17:45:20 +02:00
|
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/plainpad_ynh/tree/testing).
|
2021-08-14 12:46:57 +02:00
|
|
|
|
|
|
|
To try the testing branch, please proceed like that.
|
|
|
|
```
|
2021-08-14 17:45:20 +02:00
|
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/plainpad_ynh/tree/testing --debug
|
2021-08-14 12:46:57 +02:00
|
|
|
or
|
2021-08-14 17:45:20 +02:00
|
|
|
sudo yunohost app upgrade plainpad -u https://github.com/YunoHost-Apps/plainpad_ynh/tree/testing --debug
|
2021-08-14 12:46:57 +02:00
|
|
|
```
|
|
|
|
|
|
|
|
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|