diff --git a/README.md b/README.md index d226e89..34be74e 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,41 @@ -# Owntracks for YunoHost + + +# OwnTracks for YunoHost [![Integration level](https://dash.yunohost.org/integration/owntracks.svg)](https://dash.yunohost.org/appci/app/owntracks) ![](https://ci-apps.yunohost.org/ci/badges/owntracks.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/owntracks.maintain.svg) -[![Install Owntracks with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=owntracks) +[![Install OwnTracks with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=owntracks) -> *This package allows you to install Owntracks quickly and simply on a YunoHost server. +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install OwnTracks 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 -A location history app for YunoHost, based on Owntracks and its PHP implementation for recording and displaying. + +Keep track of your location history + +**Shipped version:** 0.1~ynh10 + + + +## Screenshots + +![](./doc/screenshots/screenshot.png) + +## Disclaimers / important information ## Features -- [Owntracks features for a HTTP API](http://owntracks.org/booklet/tech/http/), limited to the [features implemented by the PHP recorder](https://github.com/tomyvi/php-owntracks-recorder#features). Notably, no Friends feature. The [upstream PHP recorder has been tweaked](https://github.com/tituspijean/php-owntracks-recorder) to remove a cumbersome PHP dependency. +- [OwnTracks features for a HTTP API](http://owntracks.org/booklet/tech/http/), limited to the [features implemented by the PHP recorder](https://github.com/tomyvi/php-owntracks-recorder#features). Notably, no Friends feature. The [upstream PHP recorder has been tweaked](https://github.com/tituspijean/php-owntracks-recorder) to remove a cumbersome PHP dependency. - Multi-user: each YunoHost user can connect though basic HTTP authentication, and has only access to their data. ## Installation - Install the app on your YunoHost server -- Install the mobile app on your device, see [Owntracks website](http://owntracks.org) +- Install the mobile app on your device, see [OwnTracks website](http://owntracks.org) - Configure your mobile app: - Allow it to access your location - Preference > Connection @@ -27,47 +45,14 @@ A location history app for YunoHost, based on Owntracks and its PHP implementati - Authentication: `enabled` - Username/password: your YNH credentials - Device ID: as you wish - - Refer to the [Owntracks documentation](http://owntracks.org/booklet) for the other settings + - Refer to the [OwnTracks documentation](http://owntracks.org/booklet) for the other settings -## Configuration +## Documentation and resources -How to configure this app: From an admin panel, a plain file with SSH, or any other way. - -## Documentation - - * Official documentation: Link to the official documentation of this app - * YunoHost documentation: If specific documentation is needed, feel free to contribute. - -## YunoHost specific features - -#### Multi-user support - - * Are LDAP and HTTP auth supported? - * Can the app be used by multiple users? - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/owntracks.svg)](https://ci-apps.yunohost.org/ci/apps/owntracks/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/owntracks.svg)](https://ci-apps-arm.yunohost.org/ci/apps/owntracks/) - -## Limitations - -* Any known limitations. - -## Additional information - -* Other info you would like to add about this app. - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/owntracks_ynh/issues - * App website: http://owntracks.org - * [php-owntracks-recorder](https://github.com/tomyvi/php-owntracks-recorder) - * [php-owntracks-recorder altered version for YunoHost](https://github.com/tituspijean/php-owntracks-recorder) - * Upstream app repository: Link to the official repository of the upstream app. - * YunoHost website: https://yunohost.org/ - ---- +* Official app website: https://owntracks.org/ +* Upstream app code repository: https://github.com/tomyvi/php-owntracks-recorder +* YunoHost documentation for this app: https://yunohost.org/app_owntracks +* Report a bug: https://github.com/YunoHost-Apps/owntracks_ynh/issues ## Developer info @@ -79,3 +64,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/owntracks_ynh/tree/te or sudo yunohost app upgrade owntracks -u https://github.com/YunoHost-Apps/owntracks_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..80cc548 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,64 @@ +# OwnTracks pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/owntracks.svg)](https://dash.yunohost.org/appci/app/owntracks) ![](https://ci-apps.yunohost.org/ci/badges/owntracks.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/owntracks.maintain.svg) +[![Installer OwnTracks avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=owntracks) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer OwnTracks 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 + +Gérez votre historique de géolocalisation + +**Version incluse :** 0.1~ynh10 + + + +## Captures d'écran + +![](./doc/screenshots/screenshot.png) + +## Avertissements / informations importantes + +## Caractéristiques + +- [Fonctionnalités d'OwnTracks pour une API HTTP](http://owntracks.org/booklet/tech/http/), limité aux [fonctionnalités implémentées par l'enregistreur PHP](https://github.com/tomyvi/php-owntracks-recorder#features). Notamment, pas de fonction Amis. L'[enregistreur PHP en amont a été modifié](https://github.com/tituspijean/php-owntracks-recorder) pour supprimer une dépendance PHP encombrante. +- Multi-utilisateur : chaque utilisateur YunoHost peut se connecter via l'authentification HTTP de base, et n'a accès qu'à ses données. + +## Installation + +- Installez l'application sur votre serveur YunoHost +- Installez l'application mobile sur votre appareil, consultez le [site Web d'OwnTracks](http://owntracks.org) +- Configurez votre application mobile : + - Autorisez-le à accéder à votre emplacement + - Préférence > Connexion + - Mode : `http privé` + - Hébergeur : `https://DOMAIN/PATH/record.php` + - Identification + - Authentification: `enabled` + - Nom d'utilisateur/mot de passe : vos identifiants YNH + - ID de l'appareil : comme vous le souhaitez + - Reportez-vous à la [documentation d'OwnTracks](http://owntracks.org/booklet) pour les autres paramètres + +## Documentations et ressources + +* Site officiel de l'app : https://owntracks.org/ +* Dépôt de code officiel de l'app : https://github.com/tomyvi/php-owntracks-recorder +* Documentation YunoHost pour cette app : https://yunohost.org/app_owntracks +* Signaler un bug : https://github.com/YunoHost-Apps/owntracks_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/owntracks_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/owntracks_ynh/tree/testing --debug +ou +sudo yunohost app upgrade owntracks -u https://github.com/YunoHost-Apps/owntracks_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file