Turtl for YunoHost

Lire ce readme en français.

This package allows you to install Turtl quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

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

Shipped version: 1.0~ynh1

Demo: https://demo.example.com

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.

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