mirror of
https://github.com/YunoHost-Apps/owntracks_ynh.git
synced 2024-09-03 19:56:24 +02:00
68 lines
No EOL
2.8 KiB
Markdown
68 lines
No EOL
2.8 KiB
Markdown
<!--
|
|
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.
|
|
-->
|
|
|
|
# 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)
|
|
|
|
*[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
|
|
|
|
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.
|
|
- 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)
|
|
- Configure your mobile app:
|
|
- Allow it to access your location
|
|
- Preference > Connection
|
|
- Mode: `Private http`
|
|
- Host: `https://DOMAIN/PATH/record.php`
|
|
- Identification
|
|
- 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
|
|
|
|
## Documentation and resources
|
|
|
|
* 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
|
|
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/owntracks_ynh/tree/testing).
|
|
|
|
To try the testing branch, please proceed like that.
|
|
```
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/owntracks_ynh/tree/testing --debug
|
|
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 |