2021-05-12 04:22:52 +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.
-->
# Standard Notes Server for YunoHost
2021-07-04 21:46:55 +02:00
[![Integration level ](https://dash.yunohost.org/integration/snserver.svg )](https://dash.yunohost.org/appci/app/snserver) ![](https://ci-apps.yunohost.org/ci/badges/snserver.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/snserver.maintain.svg)
[![Install Standard Notes Server with YunoHost ](https://install-app.yunohost.org/install-with-yunohost.svg )](https://install-app.yunohost.org/?app=snserver)
2021-05-12 04:22:52 +02:00
2021-05-11 20:31:32 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2020-01-18 10:28:47 +01:00
2021-07-04 21:46:55 +02:00
> *This package allows you to install Standard Notes Server quickly and simply on a YunoHost server.
2021-05-11 20:31:32 +02:00
If you don't have YunoHost, please consult [the guide ](https://yunohost.org/#/install ) to learn how to install it.*
2020-01-18 10:28:47 +01:00
2021-05-12 04:22:52 +02:00
## Overview
2020-12-20 15:48:48 +01:00
2021-05-12 04:22:52 +02:00
The Standard Notes syncing server. An end-to-end encrypted note-taking app.
2020-01-18 10:28:47 +01:00
2021-08-20 21:32:13 +02:00
**Shipped version:** 2021.07.24~ynh3
2020-12-20 15:48:48 +01:00
2021-05-12 04:22:52 +02:00
**Demo:** https://standardnotes.org/demo
2020-01-18 10:28:47 +01:00
2021-05-12 04:22:52 +02:00
## Disclaimers / important information
2020-01-18 10:28:47 +01:00
2021-05-11 20:31:32 +02:00
* Any known limitations, constrains or stuff not working, such as (but not limited to):
* No single-sign on or LDAP integration
2021-07-09 21:04:32 +02:00
* The app requires at least 450MB of RAM to work properly.
* The app requires at least 650MB of RAM to start.
2021-07-11 19:31:26 +02:00
* The app requires around 1800MB of disk.
2020-01-18 10:28:47 +01:00
2021-05-11 20:31:32 +02:00
* Other infos that people should be aware of, such as:
2021-07-09 21:04:32 +02:00
* The ".env" config-files are stored under "/opt/yunohost/$app/live/"
2021-05-11 20:31:32 +02:00
* You can change the url of this app, but than all useres have to reinstall the extensions.
2020-01-18 10:28:47 +01:00
2021-05-12 04:22:52 +02:00
## Documentation and resources
2020-01-18 10:28:47 +01:00
2021-05-12 04:22:52 +02:00
* Official app website: https://standardnotes.org/
2021-07-08 22:28:25 +02:00
* Official user documentation: https://standardnotes.com/help
2021-05-12 04:22:52 +02:00
* Official admin documentation: https://docs.standardnotes.org/
2021-07-08 22:28:25 +02:00
* Upstream app code repository: https://github.com/standardnotes/standalone
2021-05-12 04:22:52 +02:00
* YunoHost documentation for this app: https://yunohost.org/app_snserver
* Report a bug: https://github.com/YunoHost-Apps/snserver_ynh/issues
2020-01-18 10:28:47 +01:00
2021-05-12 04:22:52 +02:00
## Developer info
2020-01-18 10:28:47 +01:00
2021-05-12 04:22:52 +02:00
Please send your pull request to the [testing branch ](https://github.com/YunoHost-Apps/snserver_ynh/tree/testing ).
2020-01-18 10:28:47 +01:00
2021-05-12 04:22:52 +02:00
To try the testing branch, please proceed like that.
2020-01-18 10:28:47 +01:00
```
2021-03-14 21:58:37 +01:00
sudo yunohost app install https://github.com/YunoHost-Apps/snserver_ynh/tree/testing --debug
2020-01-18 10:28:47 +01:00
or
2021-03-14 21:58:37 +01:00
sudo yunohost app upgrade snserver -u https://github.com/YunoHost-Apps/snserver_ynh/tree/testing --debug
2020-01-18 10:28:47 +01:00
```
2021-05-11 20:31:32 +02:00
2021-05-12 04:22:52 +02:00
**More info regarding app packaging:** https://yunohost.org/packaging_apps