mirror of
https://github.com/YunoHost-Apps/turtl_ynh.git
synced 2024-09-03 20:26:35 +02:00
Merge branch 'testing' of https://github.com/YunoHost-Apps/Turtl_ynh into testing
This commit is contained in:
commit
a19eb83c2b
2 changed files with 148 additions and 19 deletions
89
README.md
89
README.md
|
@ -1,31 +1,82 @@
|
||||||
# Turtl app for YunoHost
|
<!--
|
||||||
|
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.
|
||||||
|
-->
|
||||||
|
|
||||||
[](https://dash.yunohost.org/appci/app/turtl)  
|
# Turtl for YunoHost
|
||||||
|
|
||||||
- [Yunohost project](https://yunohost.org)
|
[](https://dash.yunohost.org/appci/app/turtl)  
|
||||||
- [Turtl website](https://turtlapp.com/)
|
[](https://install-app.yunohost.org/?app=turtl)
|
||||||
|
|
||||||
.
|
*[Lire ce readme en français.](./README_fr.md)*
|
||||||
|
|
||||||
**WARNING**: this is a work in progress, test it at your own risks!
|
> *This package allows you to install Turtl quickly and simply on a YunoHost server.
|
||||||
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
||||||
|
|
||||||
## Todo
|
## Overview
|
||||||
|
|
||||||
- [ ] test on x86 (only tested on arm for now)
|
Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
|
||||||
- [ ] upgrade script
|
|
||||||
- [ ] backup script
|
|
||||||
- [ ] restore script
|
|
||||||
- [ ] check_process
|
|
||||||
|
|
||||||
------------------------------
|
### Features
|
||||||
|
|
||||||
## What's Turtl
|
- Different note types: text, bookmark, password, image, and file/document
|
||||||
|
- Client-side cryptography to keep all of your data safe
|
||||||
|
- Securely share with anyone without compromising the security of your data
|
||||||
|
- Sharing allows different permissions ranging from read-only to full ownership of shared content
|
||||||
|
- Find your notes easily. Turtl supports full-text search, filtering by tag (or lack of tag), and sort by create/edit date
|
||||||
|
- Attach photos, files, and documents to your notes. Files are stored securely just like the rest of your data.
|
||||||
|
- Browser extension makes bookmarking easy on desktop
|
||||||
|
- Share to Turtl on Android for easy bookmarking and file uploads
|
||||||
|
- Write notes in Markdown, an easy and natural way to format text
|
||||||
|
- TeX math expressions in notes for math people (surround them by $$ to use)
|
||||||
|
- Multiple translations (German, Spanish, French, and more)
|
||||||
|
- RTL text support for our Farsi/Hebrew/etc-speaking friends
|
||||||
|
- Export/import your entire profile for backup purposes or to move between servers
|
||||||
|
- Semi-offline mode (you only need to be connected to log in)
|
||||||
|
- A number of keyboard shortcuts for navigation the app without mouse (type ? in-app to see shortcuts)
|
||||||
|
- An open-source server allows you to host your own Turtl data
|
||||||
|
|
||||||
Turtl lets you take notes, bookmark websites, and store documents for sensitive projects.
|
|
||||||
From sharing passwords with your coworkers to tracking research on an article you're writing, Turtl keeps it all safe from everyone but you and those you share with.
|
|
||||||
|
|
||||||
You will need apps to use Turtl. Get them from <https://turtlapp.com/download/>.
|
**Shipped version:** 1.0~ynh1
|
||||||
|
|
||||||
## Nota bene
|
**Demo:** https://demo.example.com
|
||||||
|
|
||||||
The `rethinkdb_2.3.6_armhf.deb` debian package in `conf` directory of this repository is a cross-compiled RethinkDB package for ARM architecture since no ARM package is provided by RethinkDB.
|
## Screenshots
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Disclaimers / important information
|
||||||
|
|
||||||
|
* Any known limitations, constrains or stuff not working, such as (but not limited to):
|
||||||
|
* requiring a full dedicated domain ?
|
||||||
|
* architectures not supported ?
|
||||||
|
* not-working single-sign on or LDAP integration ?
|
||||||
|
* the app requires an important amount of RAM / disk / .. to install or to work properly
|
||||||
|
* etc...
|
||||||
|
|
||||||
|
* Other infos that people should be aware of, such as:
|
||||||
|
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
|
||||||
|
* how to configure / administrate the application if it ain't obvious
|
||||||
|
* upgrade process / specificities / things to be aware of ?
|
||||||
|
* security considerations ?
|
||||||
|
|
||||||
|
## Documentation and resources
|
||||||
|
|
||||||
|
* Official app website: https://turtlapp.com/
|
||||||
|
* Official admin documentation: https://turtlapp.com/docs/
|
||||||
|
* Upstream app code repository: https://github.com/turtl/server
|
||||||
|
* YunoHost documentation for this app: https://yunohost.org/app_turtl
|
||||||
|
* Report a bug: https://github.com/YunoHost-Apps/turtl_ynh/issues
|
||||||
|
|
||||||
|
## Developer info
|
||||||
|
|
||||||
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/turtl_ynh/tree/testing).
|
||||||
|
|
||||||
|
To try the testing branch, please proceed like that.
|
||||||
|
```
|
||||||
|
sudo yunohost app install https://github.com/YunoHost-Apps/turtl_ynh/tree/testing --debug
|
||||||
|
or
|
||||||
|
sudo yunohost app upgrade turtl -u https://github.com/YunoHost-Apps/turtl_ynh/tree/testing --debug
|
||||||
|
```
|
||||||
|
|
||||||
|
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
78
README_fr.md
Normal file
78
README_fr.md
Normal file
|
@ -0,0 +1,78 @@
|
||||||
|
# Turtl pour YunoHost
|
||||||
|
|
||||||
|
[](https://dash.yunohost.org/appci/app/turtl)  
|
||||||
|
[](https://install-app.yunohost.org/?app=turtl)
|
||||||
|
|
||||||
|
*[Read this readme in english.](./README.md)*
|
||||||
|
*[Lire ce readme en français.](./README_fr.md)*
|
||||||
|
|
||||||
|
> *Ce package vous permet d'installer Turtl rapidement et simplement sur un serveur YunoHost.
|
||||||
|
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
|
||||||
|
|
||||||
|
## Vue d'ensemble
|
||||||
|
|
||||||
|
Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Different note types: text, bookmark, password, image, and file/document
|
||||||
|
- Client-side cryptography to keep all of your data safe
|
||||||
|
- Securely share with anyone without compromising the security of your data
|
||||||
|
- Sharing allows different permissions ranging from read-only to full ownership of shared content
|
||||||
|
- Find your notes easily. Turtl supports full-text search, filtering by tag (or lack of tag), and sort by create/edit date
|
||||||
|
- Attach photos, files, and documents to your notes. Files are stored securely just like the rest of your data.
|
||||||
|
- Browser extension makes bookmarking easy on desktop
|
||||||
|
- Share to Turtl on Android for easy bookmarking and file uploads
|
||||||
|
- Write notes in Markdown, an easy and natural way to format text
|
||||||
|
- TeX math expressions in notes for math people (surround them by $$ to use)
|
||||||
|
- Multiple translations (German, Spanish, French, and more)
|
||||||
|
- RTL text support for our Farsi/Hebrew/etc-speaking friends
|
||||||
|
- Export/import your entire profile for backup purposes or to move between servers
|
||||||
|
- Semi-offline mode (you only need to be connected to log in)
|
||||||
|
- A number of keyboard shortcuts for navigation the app without mouse (type ? in-app to see shortcuts)
|
||||||
|
- An open-source server allows you to host your own Turtl data
|
||||||
|
|
||||||
|
|
||||||
|
**Version incluse :** 1.0~ynh1
|
||||||
|
|
||||||
|
**Démo :** https://demo.example.com
|
||||||
|
|
||||||
|
## Captures d'écran
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Avertissements / informations importantes
|
||||||
|
|
||||||
|
* Any known limitations, constrains or stuff not working, such as (but not limited to):
|
||||||
|
* requiring a full dedicated domain ?
|
||||||
|
* architectures not supported ?
|
||||||
|
* not-working single-sign on or LDAP integration ?
|
||||||
|
* the app requires an important amount of RAM / disk / .. to install or to work properly
|
||||||
|
* etc...
|
||||||
|
|
||||||
|
* Other infos that people should be aware of, such as:
|
||||||
|
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
|
||||||
|
* how to configure / administrate the application if it ain't obvious
|
||||||
|
* upgrade process / specificities / things to be aware of ?
|
||||||
|
* security considerations ?
|
||||||
|
|
||||||
|
## Documentations et ressources
|
||||||
|
|
||||||
|
* Site officiel de l'app : https://turtlapp.com/
|
||||||
|
* Documentation officielle de l'admin : https://turtlapp.com/docs/
|
||||||
|
* Dépôt de code officiel de l'app : https://github.com/turtl/server
|
||||||
|
* Documentation YunoHost pour cette app : https://yunohost.org/app_turtl
|
||||||
|
* Signaler un bug : https://github.com/YunoHost-Apps/turtl_ynh/issues
|
||||||
|
|
||||||
|
## Informations pour les développeurs
|
||||||
|
|
||||||
|
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/turtl_ynh/tree/testing).
|
||||||
|
|
||||||
|
Pour essayer la branche testing, procédez comme suit.
|
||||||
|
```
|
||||||
|
sudo yunohost app install https://github.com/YunoHost-Apps/turtl_ynh/tree/testing --debug
|
||||||
|
ou
|
||||||
|
sudo yunohost app upgrade turtl -u https://github.com/YunoHost-Apps/turtl_ynh/tree/testing --debug
|
||||||
|
```
|
||||||
|
|
||||||
|
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
|
Loading…
Add table
Reference in a new issue