mirror of
https://github.com/YunoHost-Apps/dato_ynh.git
synced 2024-09-03 18:16:33 +02:00
104 lines
5.1 KiB
Markdown
104 lines
5.1 KiB
Markdown
|
|
||
|
|
# Dato for YunoHost
|
||
|
|
|
||
|
|
[](https://dash.yunohost.org/appci/app/dato)  
|
||
|
|
[](https://install-app.yunohost.org/?app=dato)
|
||
|
|
|
||
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
||
|
|
|
||
|
|
> *This package allows you to install dato 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.*
|
||
|
|
|
||
|
|
|
||
|
|
## 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.11
|
||
|
|
|
||
|
|
|
||
|
|
## Screenshots
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Demo
|
||
|
|
|
||
|
|
* [Official demo](https://publicdato.eauchat.org/)
|
||
|
|
|
||
|
|
|
||
|
|
## Configuration
|
||
|
|
|
||
|
|
To configure dato, you can edit the `config/public.js` file in the app directory that should be in `/vim/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](https://github.com/YunoHost-Apps/couchdb_ynh)). 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.
|
||
|
|
|
||
|
|
|
||
|
|
## 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 - [](https://ci-apps.yunohost.org/ci/apps/dato/)
|
||
|
|
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/dato/)
|
||
|
|
|
||
|
|
|
||
|
|
## Limitations
|
||
|
|
|
||
|
|
For now, dato needs a full domain, it doesn't support being set to a subpath.
|
||
|
|
|
||
|
|
|
||
|
|
## Links
|
||
|
|
|
||
|
|
* Report a bug: https://github.com/YunoHost-Apps/dato_ynh/issues
|
||
|
|
* App website: Link to the official website of this app.
|
||
|
|
* Upstream app repository: Link to the official repository of the upstream app.
|
||
|
|
* YunoHost website: https://yunohost.org/
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
|
||
|
|
## Developer info
|
||
|
|
|
||
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/dato_ynh/tree/testing).
|
||
|
|
|
||
|
|
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
|
||
|
|
```
|