Add changelog, version badge, and APPLICATION_HOST environment variable

CHANGELOG.md

@@ -0,0 +1,22 @@
+
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [0.1.5] - 2024-04-05
+
+You can now specify the host of the application by setting the `APPLICATION_HOST` environment variable in the `docker-compose.yml` file.
+
+### Added
+
+- Added version badge to navbar
+- Added APPLICATION_HOST environment variable to docker-compose.yml to allow user to specify the host of the application
+- Added CHANGELOG.md to keep track of changes
+
+### Changed
+
+- Specified gem version in Docker entrypoint
+
+### Fixed

README.md

@@ -2,6 +2,8 @@
 
 Dawarich is a self-hosted web application to replace Google Timeline (aka Google Location History). It allows you to import your location history from Google Maps Timeline and Owntracks, view it on a map and see some statistics, such as the number of countries and cities visited, and distance traveled.
 
+You can find changelog [here](CHANGELOG.md).
+
 ## Usage
 
 To track your location, install the [Owntracks app](https://owntracks.org/booklet/guide/apps/) on your phone and configure it to send location updates to your Dawarich instance. Currently, the app only supports [HTTP mode](https://owntracks.org/booklet/tech/http/). The url to send the location updates to is `http://<your-dawarich-instance>/api/v1/points`.
@@ -10,6 +12,10 @@ To import your Google Maps Timeline data, download your location history from [G
 
 ## Features
 
+### Location Tracking
+
+You can track your location using the Owntracks app.
+
 ### Location history
 
 You can view your location history on a map.
@@ -34,11 +40,12 @@ Copy the contents of the `docker-compose.yml` file to your server and run `docke
 
 ## Environment variables
 
-`MINIMUM_POINTS_IN_CITY` — minimum number of points in a city to consider it as a city visited, eg. `10`
+```
-
+MINIMUM_POINTS_IN_CITY — minimum number of points in a city to consider it as a city visited, eg. `10`
-`MAP_CENTER` — default map center, e.g. `55.7558,37.6176`
+MAP_CENTER — default map center, e.g. `55.7558,37.6176`
-
+TIME_ZONE — time zone, e.g. `Europe/Berlin`
-`TIME_ZONE` — time zone, e.g. `Europe/Berlin`
+APPLICATION_HOST — host of the application, e.g. `localhost` or `dawarich.example.com`
+```
 
 ## Screenshots
 

app/views/shared/_navbar.html.erb

@@ -10,7 +10,8 @@
         <li><%= link_to 'Imports', imports_url %></li>
       </ul>
     </div>
-    <%= link_to 'DaWarIch', root_path, class: 'btn btn-ghost normal-case text-xl mr-10'%>
+    <%= link_to 'DaWarIch', root_path, class: 'btn btn-ghost normal-case text-xl'%>
+    <div class="badge badge-neutral mx-4">0.1.5</div>
     <label class="flex cursor-pointer gap-2">
       <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><circle cx="12" cy="12" r="5"/><path d="M12 1v2M12 21v2M4.2 4.2l1.4 1.4M18.4 18.4l1.4 1.4M1 12h2M21 12h2M4.2 19.8l1.4-1.4M18.4 5.6l1.4-1.4"/></svg>
       <input type="checkbox" value="light" class="toggle theme-controller"/>

config/environments/development.rb

@@ -73,5 +73,6 @@ Rails.application.configure do
 
   # Raise error when a before_action's only/except options reference missing actions
   config.action_controller.raise_on_missing_callback_actions = true
-  config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }
+  config.action_mailer.default_url_options = { host: ENV.fetch("APPLICATION_HOST", "localhost"), port: 3000 }
+  config.hosts << ENV.fetch("APPLICATION_HOST", "localhost")
 end

dev-docker-entrypoint.sh

@@ -17,7 +17,7 @@ until nc -zv $DATABASE_HOST 5432; do
 done
 
 # Install gems
-gem update --system
+gem update --system 3.5.7
 gem install bundler --version '2.5.7'
 
 # Create the database

docker-compose.yml

@@ -41,6 +41,7 @@ services:
       DATABASE_PASSWORD: password
       DATABASE_NAME: dawarich_development
       MINIMUM_POINTS_IN_CITY: 5
+      APPLICATION_HOST: localhost
     depends_on:
       - dawarich_db
       - dawarich_redis
@@ -62,6 +63,7 @@ services:
       DATABASE_USERNAME: postgres
       DATABASE_PASSWORD: password
       DATABASE_NAME: dawarich_development
+      APPLICATION_HOST: localhost
     depends_on:
       - dawarich_db
       - dawarich_redis