YunoHost-Apps/traccar_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/traccar_ynh.git synced 2024-09-03 20:35:56 +02:00
Code Issues Activity Actions

Auto-update README

Browse source
This commit is contained in:
yunohost-bot 2023-11-19 13:02:25 +00:00
parent 3cfa5d2094
commit 68cc03e1ee
2 changed files with 53 additions and 92 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

73
README.md
View file

@ -1,85 +1,60 @@
# Packaging an app, starting from this example
* Copy this app before working on it, using the ['Use this template'](https://github.com/YunoHost/example_ynh/generate) button on the Github repo.
* Edit the `manifest.toml` with app specific info.
* Edit the `install`, `upgrade`, `remove`, `backup` and `restore` scripts, and any relevant conf files in `conf/`.
* Using the [script helpers documentation.](https://yunohost.org/packaging_apps_helpers)
* Edit the `change_url` and `config` scripts too, or remove them if you have no use of them
* Add a `LICENSE` file for the package. NB: this LICENSE file is not meant to necessarily be the LICENSE of the upstream app - it is only the LICENSE you want this package's code to published with ;). We recommend to use [the AGPL-3](https://www.gnu.org/licenses/agpl-3.0.txt).
* Edit `doc/DISCLAIMER*.md`
* The `README.md` files are to be automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
---
<!-- <!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator 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. It shall NOT be edited by hand.
--> -->
# Example app for YunoHost # Traccar for YunoHost
[![Integration level](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![Working status](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) [![Integration level](https://dash.yunohost.org/integration/traccar.svg)](https://dash.yunohost.org/appci/app/traccar) ![Working status](https://ci-apps.yunohost.org/ci/badges/traccar.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/traccar.maintain.svg)
[![Install Example app with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example)
[![Install Traccar with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=traccar)
*[Lire ce readme en français.](./README_fr.md)* *[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install Example app quickly and simply on a YunoHost server. > *This package allows you to install Traccar 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.* If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview ## 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. Traccar is an open source GPS tracking system. This repository contains Java-based back-end service. It supports more than 200 GPS protocols and more than 2000 models of GPS tracking devices. Traccar can be used with any major SQL database system.
### Features ### Features
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ; Real-time GPS tracking
- Laboris nisi ut aliquip ex ea commodo consequat ; Driver behaviour monitoring
- Duis aute irure dolor in reprehenderit in voluptate ; Detailed and summary reports
- Velit esse cillum dolore eu fugiat nulla pariatur ; Geofencing functionality
- Excepteur sint occaecat cupidatat non proident, sunt in culpa." Alarms and notifications
Account and device management
Email and SMS support
**Shipped version:** 1.0~ynh1 **Shipped version:** 5.9~ynh1
**Demo:** https://demo.example.com **Demo:** https://www.traccar.org/demo-server/
## Screenshots ## Screenshots
![Screenshot of Example app](./doc/screenshots/example.jpg) ![Screenshot of Traccar](./doc/screenshots/screenshot.png)
## 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 ## Documentation and resources
* Official app website: <https://example.com> * Official app website: <https://www.traccar.org/>
* Official user documentation: <https://yunohost.org/apps> * Official admin documentation: <https://www.traccar.org/documentation/>
* Official admin documentation: <https://yunohost.org/packaging_apps> * Upstream app code repository: <https://github.com/traccar/traccar-web>
* Upstream app code repository: <https://some.forge.com/example/example> * YunoHost Store: <https://apps.yunohost.org/app/traccar>
* YunoHost documentation for this app: <https://yunohost.org/app_example> * Report a bug: <https://github.com/YunoHost-Apps/traccar_ynh/issues>
* Report a bug: <https://github.com/YunoHost-Apps/example_ynh/issues>
## Developer info ## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/example_ynh/tree/testing). Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/traccar_ynh/tree/testing).
To try the testing branch, please proceed like that. To try the testing branch, please proceed like that.
``` bash ``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/traccar_ynh/tree/testing --debug
or or
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app upgrade traccar -u https://github.com/YunoHost-Apps/traccar_ynh/tree/testing --debug
``` ```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps> **More info regarding app packaging:** <https://yunohost.org/packaging_apps>

72
README_fr.md
View file

@ -3,71 +3,57 @@ N.B.: This README was automatically generated by https://github.com/YunoHost/app
It shall NOT be edited by hand. It shall NOT be edited by hand.
--> -->
# Exemple d'app pour YunoHost # Traccar pour YunoHost
[![Niveau d'intégration](https://dash.yunohost.org/integration/example.svg)](https://dash.yunohost.org/appci/app/example) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/example.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/example.maintain.svg) [![Niveau d’intégration](https://dash.yunohost.org/integration/traccar.svg)](https://dash.yunohost.org/appci/app/traccar) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/traccar.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/traccar.maintain.svg)
[![Installer Example app avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=example)
[![Installer Traccar avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=traccar)
*[Read this readme in english.](./README.md)* *[Read this readme in english.](./README.md)*
> *Ce package vous permet d'installer Example app rapidement et simplement sur un serveur YunoHost. > *Ce package vous permet d’installer Traccar 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.* Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l’installer et en profiter.*
## Vue d'ensemble ## 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. Traccar est un système de suivi GPS open source. Ce référentiel contient un service back-end basé sur Java. Il prend en charge plus de 200 protocoles GPS et plus de 2 000 modèles de dispositifs de suivi GPS. Traccar peut être utilisé avec n'importe quel système de base de données SQL majeur.
### Features ### Caractéristiques
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ; Suivi GPS en temps réel
- Laboris nisi ut aliquip ex ea commodo consequat ; Surveillance du comportement des conducteurs
- Duis aute irure dolor in reprehenderit in voluptate ; Rapports détaillés et synthétiques
- Velit esse cillum dolore eu fugiat nulla pariatur ; Fonctionnalité de géolocalisation
- Excepteur sint occaecat cupidatat non proident, sunt in culpa." Alarmes et notifications
Gestion des comptes et des appareils
Assistance par e-mail et SMS
**Version incluse :** 5.9~ynh1
**Version incluse :** 1.0~ynh1 **Démo :** https://www.traccar.org/demo-server/
**Démo :** https://demo.example.com ## Captures d’écran
## Captures d'écran ![Capture d’écran de Traccar](./doc/screenshots/screenshot.png)
![Capture d'écran de Example app](./doc/screenshots/example.jpg)
## 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 ## Documentations et ressources
* Site officiel de l'app : <https://example.com> * Site officiel de l’app : <https://www.traccar.org/>
* Documentation officielle utilisateur : <https://yunohost.org/apps> * Documentation officielle de l’admin : <https://www.traccar.org/documentation/>
* Documentation officielle de l'admin : <https://yunohost.org/packaging_apps> * Dépôt de code officiel de l’app : <https://github.com/traccar/traccar-web>
* Dépôt de code officiel de l'app : <https://some.forge.com/example/example> * YunoHost Store: <https://apps.yunohost.org/app/traccar>
* Documentation YunoHost pour cette app : <https://yunohost.org/app_example> * Signaler un bug : <https://github.com/YunoHost-Apps/traccar_ynh/issues>
* Signaler un bug : <https://github.com/YunoHost-Apps/example_ynh/issues>
## Informations pour les développeurs ## Informations pour les développeurs
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/example_ynh/tree/testing). Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/traccar_ynh/tree/testing).
Pour essayer la branche testing, procédez comme suit. Pour essayer la branche testing, procédez comme suit.
``` bash ``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/traccar_ynh/tree/testing --debug
ou ou
sudo yunohost app upgrade example -u https://github.com/YunoHost-Apps/example_ynh/tree/testing --debug sudo yunohost app upgrade traccar -u https://github.com/YunoHost-Apps/traccar_ynh/tree/testing --debug
``` ```
**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps> **Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>