diff --git a/README.md b/README.md index fe3e581..1aaad3f 100644 --- a/README.md +++ b/README.md @@ -1,67 +1,61 @@ -# μlogger for YunoHost + -[![Integration level](https://dash.yunohost.org/integration/ulogger.svg)](https://dash.yunohost.org/appci/app/ulogger) ![](https://ci-apps.yunohost.org/ci/badges/ulogger.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/ulogger.maintain.svg) -[![Install μlogger with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ulogger) +# ulogger for YunoHost -> *This package allows you to install μlogger quickly and simply on a YunoHost server. +[![Integration level](https://dash.yunohost.org/integration/ulogger.svg)](https://dash.yunohost.org/appci/app/ulogger) ![Working status](https://ci-apps.yunohost.org/ci/badges/ulogger.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/ulogger.maintain.svg) +[![Install ulogger with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ulogger) + +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install ulogger 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 -This is a web application for real-time collection of geolocation data, tracks viewing and management. Together with a dedicated [μlogger mobile client](https://github.com/bfabiszewski/ulogger-android) it may be used as a complete self hosted server–client solution for logging and monitoring users' geolocation. -**Version:** 1.0 +**μlogger** is a web application for real-time collection of geolocation data, tracks viewing and management. + +Together with a dedicated [μlogger mobile client](https://github.com/bfabiszewski/ulogger-android +) it may be used as a complete self hosted server–client solution for logging and monitoring users' geolocation. + + +**Shipped version:** 1.1~ynh1 ## Screenshots -![](screenshot.png) +![Screenshot of ulogger](./doc/screenshots/screenshot.png) -## Demo -* [Official demo](http://ulogger.fabiszewski.net/) (login: demo, password: demo) +## Disclaimers / important information ## Configuration -How to configure this app: From an admin panel, a plain file with SSH, or any other way. +### Login +**Name:** The user selected during installation -## Documentation +**Password:** Will be emailed to you immediately after installation - * Official documentation: Link to the official documentation of this app - * YunoHost documentation: If specific documentation is needed, feel free to contribute. +### How to configure this app: +From an admin panel, or a plain file with SSH. -## YunoHost specific features +## Documentation and resources -#### Multi-user support - -* Are LDAP and HTTP auth supported? **No** -* Can the app be used by multiple users? **Yes** - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/ulogger%20%28Community%29.svg)](https://ci-apps.yunohost.org/ci/apps/ulogger/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/ulogger%20%28Community%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/ulogger/) - -## 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/ulogger_ynh/issues - * Upstream app repository: https://github.com/bfabiszewski/ulogger-server - * YunoHost website: https://yunohost.org/ - ---- +* Official app website: +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: ## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/ulogger_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/ulogger_ynh/tree/testing --debug or sudo yunohost app upgrade ulogger -u https://github.com/YunoHost-Apps/ulogger_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..b65a654 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,61 @@ + + +# ulogger pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/ulogger.svg)](https://dash.yunohost.org/appci/app/ulogger) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/ulogger.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/ulogger.maintain.svg) +[![Installer ulogger avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ulogger) + +*[Read this readme in english.](./README.md)* + +> *Ce package vous permet d'installer ulogger 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 + +**μlogger** is a web application for real-time collection of geolocation data, tracks viewing and management. + +Together with a dedicated [μlogger mobile client](https://github.com/bfabiszewski/ulogger-android +) it may be used as a complete self hosted server–client solution for logging and monitoring users' geolocation. + + +**Version incluse :** 1.1~ynh1 + +## Captures d'écran + +![Capture d'écran de ulogger](./doc/screenshots/screenshot.png) + +## Avertissements / informations importantes + +## Configuration + +### Login +**Name:** The user selected during installation + +**Password:** Will be emailed to you immediately after installation + +### How to configure this app: +From an admin panel, or a plain file with SSH. + +## Documentations et ressources + +* Site officiel de l'app : +* Dépôt de code officiel de l'app : +* Documentation YunoHost pour cette app : +* Signaler un bug : + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/ulogger_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. + +``` bash +sudo yunohost app install https://github.com/YunoHost-Apps/ulogger_ynh/tree/testing --debug +ou +sudo yunohost app upgrade ulogger -u https://github.com/YunoHost-Apps/ulogger_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :**