mirror of
https://github.com/owntracks/frontend.git
synced 2026-08-25 20:47:16 +00:00
Update README.md
This commit is contained in:
@@ -1,7 +1,5 @@
|
||||
# OwnTracks UI
|
||||
|
||||
> Web interface for OwnTracks
|
||||
|
||||

|
||||
[](https://hub.docker.com/r/owntracks/frontend)
|
||||
[](https://travis-ci.org/owntracks/frontend)
|
||||
@@ -17,19 +15,28 @@ pages, this is a more advanced interface with more functionality, all in one pla
|
||||
|
||||

|
||||
|
||||
## Features
|
||||
|
||||
- Last known (i.e. live) locations:
|
||||
- Accuracy visualization (circle)
|
||||
- Device friendly name and icon
|
||||
- Detailed information (if available): time, latitude, longitude, height, battery and
|
||||
speed
|
||||
- Location history (data points, line or both)
|
||||
- Location heatmap
|
||||
- Quickly fit all shown objects on the map into view
|
||||
- Display data in a specific date range
|
||||
- Filter by user and device
|
||||
- Download selected location data as JSON
|
||||
- Highly customisable
|
||||
|
||||
## Installation
|
||||
|
||||
### Manually
|
||||
|
||||
- Run `yarn install --production` to install dependencies
|
||||
- Run `yarn build` to compile and minify for production
|
||||
- Copy the content of the `dist/` directory to your webroot
|
||||
|
||||
The API is expected to be reachable under the same domain as the web interface.
|
||||
|
||||
### Docker
|
||||
|
||||
You can launch directly via Docker run like this:
|
||||
A pre-built Docker image is available on Docker Hub as [`owntracks/frontend`](https://hub.docker.com/r/owntracks/frontend).
|
||||
|
||||
You can start a container directly via `docker run`:
|
||||
|
||||
```console
|
||||
$ docker run -d -p 80:80 -e SERVER_HOST=otrecorder-host -e SERVER_PORT=otrecorder-port owntracks/frontend
|
||||
@@ -54,6 +61,12 @@ services:
|
||||
restart: unless-stopped
|
||||
```
|
||||
|
||||
### Manually
|
||||
|
||||
- Run `yarn install --production` to install dependencies
|
||||
- Run `yarn build` to compile and minify for production
|
||||
- Copy the content of the `dist/` directory to your webroot
|
||||
|
||||
## Configuration
|
||||
|
||||
It's possible to get started without any configuration change whatsoever, assuming your
|
||||
@@ -96,21 +109,6 @@ and `OT_PROXY_PORT` environment variables.
|
||||
|
||||
Finally update `api.baseUrl` in your config to `"http://0.0.0.0:8888/https://owntracks.example.com"`.
|
||||
|
||||
## Features
|
||||
|
||||
- Last known (i.e. live) locations:
|
||||
- Accuracy visualization (circle)
|
||||
- Device friendly name and icon
|
||||
- Detailed information (if available): time, latitude, longitude, height, battery and
|
||||
speed
|
||||
- Location history (data points, line or both)
|
||||
- Location heatmap
|
||||
- Quickly fit all shown objects on the map into view
|
||||
- Display data in a specific date range
|
||||
- Filter by user and device
|
||||
- Download selected location data as JSON
|
||||
- Highly customisable
|
||||
|
||||
## Screenshots
|
||||
|
||||
<p align="center">
|
||||
|
||||
Reference in New Issue
Block a user