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

83 lines
3.2 KiB
Markdown
Raw Normal View History

2020-12-20 15:02:54 +01:00
# Standard Notes Syncing Server for YunoHost
2020-01-18 10:28:47 +01:00
2021-01-24 21:36:24 +01:00
[![Integration level](https://dash.yunohost.org/integration/snserver.svg)](https://dash.yunohost.org/appci/app/snserver)
![Status](https://ci-apps.yunohost.org/ci/badges/snserver.status.svg)
![Maintained](https://ci-apps.yunohost.org/ci/badges/snserver.maintain.svg)
2021-01-07 17:38:18 +01:00
[![Install SNServer with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=snserver)
2020-01-18 10:28:47 +01:00
2021-01-24 21:36:24 +01:00
> *This package allow you to install snserver quickly and simply on a YunoHost server.
2020-01-18 10:28:47 +01:00
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
## Overview
2020-12-20 15:48:48 +01:00
Standard Notes syncing server
2020-12-20 15:02:54 +01:00
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.
2020-01-18 10:28:47 +01:00
2020-12-20 15:02:54 +01:00
**Shipped version:** 3.13.6
2021-01-24 21:36:24 +01:00
* Apps available for free. https://standardnotes.org/
2020-12-20 15:10:22 +01:00
* Desktop (Windows, Mac, Linux)
* Mobile (Android and iOS)
2020-12-20 15:48:48 +01:00
* Web https://app.standardnotes.org/
2020-12-20 15:10:22 +01:00
* Self-Hosted Yunohost - Web-App https://github.com/FabianWilkens/snweb_ynh
2020-12-20 15:48:48 +01:00
> Change Sync Server Domain during Registation and Sign in
2020-01-18 10:28:47 +01:00
## Screenshots
2020-12-20 15:02:54 +01:00
![](https://camo.githubusercontent.com/ca3744729c6c33f2f42d7917a4e7167c12a786615e14d1719f7d1ec6ed77aae8/68747470733a2f2f7374616e646172646e6f7465732e6f72672f6173736574732f686f6d65706167652d6865726f2e706e67)
Extensions, Editors, Themes: https://standardnotes.org/extensions
2020-01-18 10:28:47 +01:00
## Demo
2020-12-20 15:02:54 +01:00
* [Official demo - Web App](https://standardnotes.org/demo)
2020-01-18 10:28:47 +01:00
## Configuration
2021-01-24 21:36:24 +01:00
How to configure this app:
2020-12-20 15:10:22 +01:00
* The config-file is stored under "/opt/yunohost/$app/live/.env"
2021-01-24 21:36:24 +01:00
* You can find additional config features under https://your-domain.tld/yunohost/admin/#/apps/$app/config-panel
2020-01-18 10:28:47 +01:00
## Documentation
2020-12-20 15:02:54 +01:00
* Official documentation: https://docs.standardnotes.org
2020-01-18 10:28:47 +01:00
## YunoHost specific features
#### Multi-users support
2020-12-27 23:18:55 +01:00
* Are LDAP and HTTP auth supported? LDAP=No HTTP=Yes
2020-12-20 15:10:22 +01:00
* Can the app be used by multiple users? Yes
2020-01-18 10:28:47 +01:00
#### Supported architectures
2020-12-20 15:02:54 +01:00
* 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/snserver%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/snserver/)
2020-01-18 10:28:47 +01:00
## Limitations
2021-01-24 21:36:24 +01:00
* If users have installed the extensions included in this package. The URL of the server should not be changed anymore. Otherwise the users will have to reinstall the extensions.
2020-01-18 10:28:47 +01:00
## Links
2020-12-20 15:10:22 +01:00
* Report a bug: https://github.com/FabianWilkens/snserver_ynh/issues
2020-12-20 15:02:54 +01:00
* App website: https://standardnotes.org/
* Upstream app repository: https://github.com/standardnotes/syncing-server
2020-01-18 10:28:47 +01:00
* YunoHost website: https://yunohost.org/
---
Developers info
----------------
**Only if you want to use a testing branch for coding, instead of merging directly into master.**
2020-12-20 15:10:22 +01:00
Please do your pull request to the [testing branch](https://github.com/FabianWilkens/snserver_ynh/tree/testing).
2020-01-18 10:28:47 +01:00
To try the testing branch, please proceed like that.
```
2020-12-20 15:10:22 +01:00
sudo yunohost app install https://github.com/FabianWilkens/snserver_ynh/tree/testing --debug
2020-01-18 10:28:47 +01:00
or
2020-12-20 15:10:22 +01:00
sudo yunohost app upgrade snserver -u https://github.com/FabianWilkens/snserver_ynh/tree/testing --debug
2020-01-18 10:28:47 +01:00
```