1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/snserver_ynh.git synced 2024-09-03 20:26:22 +02:00
snserver_ynh/README.md

56 lines
2.4 KiB
Markdown
Raw Normal View History

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
2022-06-20 08:13:47 +02:00
[![Integration level](https://dash.yunohost.org/integration/snserver.svg)](https://dash.yunohost.org/appci/app/snserver) ![Working status](https://ci-apps.yunohost.org/ci/badges/snserver.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/snserver.maintain.svg)
2021-07-04 21:46:55 +02:00
[![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
2022-08-04 17:30:35 +02:00
**Shipped version:** 2022.07.29~ynh1
2020-12-20 15:48:48 +01:00
2021-05-12 04:22:52 +02:00
**Demo:** https://standardnotes.org/demo
## Disclaimers / important information
2020-01-18 10:28:47 +01:00
2021-10-30 16:25:50 +02:00
* No single-sign on or LDAP integration
* Ram requirements (Swap memory will be created during install):
* The app requires at least 800MB of RAM to work properly.
* The app requires at least 1000MB of RAM to start.
* The app requires at least 1500MB of RAM to install.
* The ".env" config-files are stored under "/opt/yunohost/$app/live/"
* 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
2022-06-20 08:13:47 +02:00
* Official app website: <https://standardnotes.org/>
* Official user documentation: <https://standardnotes.com/help>
* Official admin documentation: <https://docs.standardnotes.org/>
* Upstream app code repository: <https://github.com/standardnotes/standalone>
* 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.
2022-06-20 08:13:47 +02:00
``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/snserver_ynh/tree/testing --debug
2020-01-18 10:28:47 +01:00
or
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
2022-06-20 08:13:47 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>