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

Update README.md

Browse source
This commit is contained in:
Fabian Wilkens 2020-12-20 15:02:54 +01:00
parent ac876960dc
commit ec8d135afe
1 changed files with 29 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

61
README.md
View file

@ -1,55 +1,52 @@
# Usage of this package (REMOVE THIS SECTION BEFORE RELEASE) # Standard Notes Syncing Server for YunoHost
- Copy this app before working on it.
- Edit `conf/nginx.conf` file to match application prerequisites.
- Edit `manifest.json` with application specific information.
- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts.
- Using the [script helpers documentation.](https://helpers.yunohost.org/)
- Add a `LICENSE` file for the package.
- Edit `README.md` and README_fr.md.
# Example app for YunoHost [![Integration level](https://dash.yunohost.org/integration/snserver.svg)](https://dash.yunohost.org/appci/app/snserver)
[![Install SNServer with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=snserver)
[![Integration level](https://dash.yunohost.org/integration/REPLACEBYYOURAPP.svg)](https://dash.yunohost.org/appci/app/REPLACEBYYOURAPP) > *This package allow you to install snserver quickly and simply on a YunoHost server.
[![Install REPLACEBYYOURAPP with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=REPLACEBYYOURAPP)
*[Lire ce readme en français.](./README_fr.md)*
> *This package allow you to install REPLACEBYYOURAPP quickly and simply on a YunoHost server.
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
## Overview ## Overview
Quick description of this app.
**Shipped version:** 1.0 The Standard Notes syncing server
You can run your own Standard Notes server and use it with any Standard Notes app. This allows you to have 100% control of your data.
**Shipped version:** 3.13.6
Apps available for free. https://standardnotes.org/
Desktop (Windows, Mac, Linux)
Mobile (Android and iOS)
Web https://github.com/YunoHost-Apps/snweb_ynh
Self-Hosted Yunohost - Web-App
## Screenshots ## Screenshots
![](Link to an screenshot for this app) ![](https://camo.githubusercontent.com/ca3744729c6c33f2f42d7917a4e7167c12a786615e14d1719f7d1ec6ed77aae8/68747470733a2f2f7374616e646172646e6f7465732e6f72672f6173736574732f686f6d65706167652d6865726f2e706e67)
Extensions, Editors, Themes: https://standardnotes.org/extensions
## Demo ## Demo
* [Official demo](Link to a demo site for this app) * [Official demo - Web App](https://standardnotes.org/demo)
## Configuration ## Configuration
How to configure this app: by an admin panel, a plain file with SSH, or any other way. How to configure this app: The config-file is stored under "/opt/yunohost/$app/live/.env"
## Documentation ## Documentation
* Official documentation: Link to the official documentation of this app * Official documentation: https://docs.standardnotes.org
* YunoHost documentation: If specific documentation is needed, feel free to contribute.
## YunoHost specific features ## YunoHost specific features
#### Multi-users support #### Multi-users support
Are LDAP and HTTP auth supported? Are LDAP and HTTP auth supported? No
Can the app be used by multiple users? Can the app be used by multiple users? Yes
#### Supported architectures #### Supported architectures
* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/REPLACEBYYOURAPP/) * x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/snserver%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/snserver/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/REPLACEBYYOURAPP/) * ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/snserver%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/snserver/)
## Limitations ## Limitations
@ -64,9 +61,9 @@ https://yunohost.org/packaging_apps
## Links ## Links
* Report a bug: https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/issues * Report a bug: https://github.com/YunoHost-Apps/snserver_ynh/issues
* App website: Link to the official website of this app * App website: https://standardnotes.org/
* Upstream app repository: Link to the official repository of the upstream app * Upstream app repository: https://github.com/standardnotes/syncing-server
* YunoHost website: https://yunohost.org/ * YunoHost website: https://yunohost.org/
--- ---
@ -75,11 +72,11 @@ Developers info
---------------- ----------------
**Only if you want to use a testing branch for coding, instead of merging directly into master.** **Only if you want to use a testing branch for coding, instead of merging directly into master.**
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing). Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/snserver_ynh/tree/testing).
To try the testing branch, please proceed like that. To try the testing branch, please proceed like that.
``` ```
sudo yunohost app install https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/snserver_ynh/tree/testing --debug
or or
sudo yunohost app upgrade REPLACEBYYOURAPP -u https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug sudo yunohost app upgrade snserver -u https://github.com/YunoHost-Apps/snserver_ynh/tree/testing --debug
``` ```