mirror of https://github.com/YunoHost-Apps/dato_ynh.git synced 2024-09-03 18:16:33 +02:00

Dato package for YunoHost

closember

Find a file

squeak fdbe4c27f8 1.5.17~ynh1		2021-09-09 19:45:52 +02:00
.github	[autopatch] Update issue and PR templates	2021-05-13 17:46:06 +02:00
conf	1.5.17~ynh1	2021-09-09 19:45:52 +02:00
doc	Apply example_ynh	2021-08-05 23:28:50 +02:00
scripts	Restart couchdb service before editing _users db security document.	2021-09-09 19:42:21 +02:00
.gitignore	initial commit	2021-03-11 00:34:24 +01:00
check_process	Update check_process	2021-08-14 20:41:41 +02:00
LICENSE	initial commit	2021-03-11 00:34:24 +01:00
manifest.json	1.5.17~ynh1	2021-09-09 19:45:52 +02:00
README.md	1.5.17~ynh1	2021-09-09 19:45:52 +02:00
README_fr.md	1.5.17~ynh1	2021-09-09 19:45:52 +02:00

README.md

Dato for YunoHost

Lire ce readme en français.

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

Overview

Dato is an application that make it easy to generate and modify any type of database entries with a nice UI/UX.

With it, you can create and handle any amount of databases, choose and setup what type of entries to put in them and customize yourself the UI that will let you edit databases entries.

You can think of dato as an app that can replace: address book apps, todo list apps, table sheets to store lists of things... because it's flexible enough to do all these the way you want it to be done.

The purpose of dato is not to propose a UI specific to some purpose, but something as customizable as possible, so that you can in a few minutes setup any kind of database. However, if you want a more specialized interface to improve the UX for your needs, you can create plugins to extend the default general functionalities.

Dato is a progressive webapp, which means that you can install it from the browser in computer and phones, and use it offline.

Shipped version: 1.5.17

Screenshots

Demo

Official demo

Configuration

To configure dato, you can edit the config/public.js file in the app directory that should be in /opt/yunohost/APPID/ where APPID is dato if it's the first installed instance, dato__2, dato__3... for additional instances. You can also make modifications in config/private.js, but be sure to know what you're doing when doing so.

Autosynchronization

By default all data you create with dato is stored only in your browser. Users can manually enable per-database synchronization with any remote couch server, but this process is not obvious to users. Therefore dato provide an autosynchronization mechanism. To enable it, you need to setup a couchdb server (you can do this using the couchdb yunohost package). You should do this before installing dato. Then when installing dato, set the url to your couchdb server when prompted (you will also need to fill your couchdb admin password, and info about the dato admin user to create). Dato will automatically setup the dato administrator account in your couchdb server. You can then easily add users from the user interface, as specified below.

If you want to allow both a free usage of the app by anyone, and autosynchronization for some users, you can install the dato package multiple times with different setups.

Adding users

If you setup autosynchronization, users will need an account to use the app. Dato doesn't support LDAP for the moment, so you will need to add users in it's own database. To add a user to dato, just visit the /users/ page (e.g. https://dato.yourdomain.tld/users/), create a new user, then don't forget to click on "roles" under the user's name, and add the role dato. If you want a user to have administration rights (= to have the power to add/remove users) you can give that user the dato-admin role.

Also, if you need, you can make use of the password reset feature to allow users to modify their passwords, you will just need to send them the generated password reset link.

A note about dato

Please be aware that dato is a Progressive Web App. In a nutshell, this means that browsers cache the whole app, so it doesn't have to be requested to the server every time a user is visiting it. This lowers solicitation of the server, and also allow users to use dato offline.

When the app is upgraded, the user's browser will automatically detect that there is a new version, and propose to reload the page to update. However, sometimes it seems a bit random how browsers notice the new version, so if you want to make sure you're using the latest version, click on the "?" button (top-right in the web interface), and choose "credits" to verify the version you're using. You can also force reloading the app from the server opening "about:serviceworkers" in your browser and unregistering the worker for the domain in which you installed dato.

Documentation

Official documentation: https://squeak.eauchat.org/dato/

YunoHost specific features

Multi-user support

LDAP is not supported, but dato has it's own user's control system, so it can be used publicly, or restricted to some users when autosynchronization is enabled.

Supported architectures

x86-64 -
ARMv8-A -

Limitations

For now, dato needs a full domain, it doesn't support being set to a subpath.

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/dato_ynh/tree/testing --debug
or
sudo yunohost app upgrade dato -u https://github.com/YunoHost-Apps/dato_ynh/tree/testing --debug