Add CHANGELOG.md

Enable compression for faster download of history

CHANGELOG.md

@@ -0,0 +1,9 @@
+# 1.1.0 (2019-10-26)
+
+- Add support for Docker. [#7](https://github.com/owntracks/frontend/pull/7), [@sharkoz](https://github.com/sharkoz)
+- Move project to the OwnTracks organisation on GitHub. [#8](https://github.com/owntracks/frontend/pull/8), [@jpmens](https://github.com/jpmens)
+- Enable compression in nginx configuration used in Docker image. [#11](https://github.com/owntracks/frontend/pull/11), [@sharkoz](https://github.com/sharkoz)
+
+# 1.0.0 (2019-06-18)
+
+- Initial release

Dockerfile

@@ -0,0 +1,11 @@
+FROM nginx:alpine
+EXPOSE 80
+ENV LISTEN_PORT=80 \
+  SERVER_HOST=otrecorder \
+  SERVER_PORT=80
+
+COPY nginx.tmpl /etc/nginx/nginx.tmpl
+COPY index.html /usr/share/nginx/html
+COPY static/ /usr/share/nginx/html/static/
+
+CMD /bin/sh -c "envsubst '\${SERVER_HOST} \${SERVER_PORT} \${LISTEN_PORT}' < /etc/nginx/nginx.tmpl > /etc/nginx/nginx.conf && nginx -g 'daemon off;' || ( env; cat /etc/nginx/nginx.conf )"

README.md

@@ -2,20 +2,45 @@
 
 > A modern web interface for OwnTracks made with Vue.js
 
+[![Docker Pulls](https://img.shields.io/docker/pulls/owntracks/frontend)](https://hub.docker.com/r/owntracks/frontend)
+
 <p style="text-align: center;">
-  <img src="docs/images/owntracks-ui.png" alt="OwnTracks UI">
+  <img src="https://raw.githubusercontent.com/owntracks/frontend/master/docs/images/owntracks-ui.png" alt="OwnTracks UI">
 </p>
 
 ## Introduction
 
 This is a web interface for [OwnTracks](https://github.com/owntracks/recorder), intended to replace the various web pages shipping with the recorder. OwnTracks UI uses Vue.js under the hood.
 
-*This is not an official OwnTracks project.*
-
 ## Installation
 
+### Manual install
+
 Clone the repository and copy `index.html` and the `static/` directory to your server's 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:
+```console
+$ docker run -d -p 80:80 -e SERVER_HOST=otrecorder-host -e SERVER_PORT=otrecorder-port owntracks/frontend
+```
+
+Or you can use `docker-compose` (if you also run the OwnTracks Recorder with the default compose config, and the service is named `otrecorder`):
+
+```yaml
+version: '3'
+
+services:
+  owntracks-ui:
+    image: owntracks/frontend
+    ports:
+      - 80:80
+    environment:
+      - SERVER_HOST=otrecorder
+      - SERVER_PORT=8083
+    restart: unless-stopped
+```
+
 ## Features
 
 - Enable or disable multiple layers:
@@ -47,11 +72,11 @@ Clone the repository and copy `index.html` and the `static/` directory to your s
 
 _Click to enlarge._
 
-<a href="docs/images/live.png" target="_blank"><img src="docs/images/live.png" alt="Live" height="200"></a>
-<a href="docs/images/multiple.png" target="_blank"><img src="docs/images/multiple.png" alt="Multiple" height="200"></a>
-<a href="docs/images/date-selection.png" target="_blank"><img src="docs/images/date-selection.png" alt="Date selection" height="200"></a>
-<a href="docs/images/heatmap.png" target="_blank"><img src="docs/images/heatmap.png" alt="Heatmap" height="200"></a>
-<a href="docs/images/customized.png" target="_blank"><img src="docs/images/customized.png" alt="Customized" height="200"></a>
+<a href="https://raw.githubusercontent.com/owntracks/frontend/master/docs/images/live.png" target="_blank"><img src="https://raw.githubusercontent.com/owntracks/frontend/master/docs/images/live.png" alt="Live" height="200"></a>
+<a href="https://raw.githubusercontent.com/owntracks/frontend/master/docs/images/multiple.png" target="_blank"><img src="https://raw.githubusercontent.com/owntracks/frontend/master/docs/images/multiple.png" alt="Multiple" height="200"></a>
+<a href="https://raw.githubusercontent.com/owntracks/frontend/master/docs/images/date-selection.png" target="_blank"><img src="https://raw.githubusercontent.com/owntracks/frontend/master/docs/images/date-selection.png" alt="Date selection" height="200"></a>
+<a href="https://raw.githubusercontent.com/owntracks/frontend/master/docs/images/heatmap.png" target="_blank"><img src="https://raw.githubusercontent.com/owntracks/frontend/master/docs/images/heatmap.png" alt="Heatmap" height="200"></a>
+<a href="https://raw.githubusercontent.com/owntracks/frontend/master/docs/images/customized.png" target="_blank"><img src="https://raw.githubusercontent.com/owntracks/frontend/master/docs/images/customized.png" alt="Customized" height="200"></a>
 
 ## ToDo
 
@@ -63,7 +88,6 @@ _Click to enlarge._
   - Dependency management with yarn instead of a local copy or unpkg.com
 
 - Add documentation, at least for the config file
-- Docker support
 - Download data for selected date range, user and device as JSON
 
 ## Contributing

nginx.tmpl

@@ -0,0 +1,35 @@
+worker_processes 1;
+events {
+    worker_connections 1024;
+}
+http {
+    upstream otrecorder {
+        server ${SERVER_HOST}:${SERVER_PORT};
+    }
+    server {
+        listen ${LISTEN_PORT};
+        root /usr/share/nginx/html;
+        location /api {
+            proxy_pass http://otrecorder/api/;
+        }
+        location /ws {
+            proxy_pass http://otrecorder/ws/;
+            proxy_http_version 1.1;
+            proxy_set_header Upgrade $http_upgrade;
+            proxy_set_header Connection upgrade;
+        }
+        location / {
+            include /etc/nginx/mime.types;
+            try_files $uri $uri/index.html;
+        }
+        
+        gzip on;
+        gzip_vary on;
+        gzip_proxied any;
+        gzip_comp_level 6;
+        gzip_buffers 16 8k;
+        gzip_http_version 1.1;
+        gzip_types text/plain text/css application/json application/javascript text/javascript;
+    }
+}
+