Merge branch 'release/1.3.5'

Author: turegjorup

CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+## [1.3.5] - 2023-09-14
+
+- [#115](https://github.com/os2display/display-client/pull/115)
+  Removed trailing slash from URLs in `/public/example_config.json` given that our fetch code expects no trailing slash
+
 ## [1.3.4] - 2023-07-13
 
 - [#114](https://github.com/os2display/display-client/pull/114)

README.md

@@ -3,6 +3,35 @@
 This is the client that will display slides from OS2Display.
 See [https://github.com/os2display/display-docs/blob/main/client.md](https://github.com/os2display/display-docs/blob/main/client.md) for more info about the client.
 
+## Config
+The client can be configured by creating `public/config.json` with relevant values.
+See `public/example_config.json` for values.
+
+```json
+{
+  "apiEndpoint": "",
+  "authenticationEndpoint": "/v1/authentication/screen",
+  "authenticationRefreshTokenEndpoint": "/v1/authentication/token/refresh",
+  "dataStrategy": {
+    "type": "pull",
+    "config": {
+      "interval": 30000,
+      "endpoint": ""
+    }
+  },
+  "colorScheme": {
+    "type": "library",
+    "lat": 56.0,
+    "lng": 10.0
+  },
+  "schedulingInterval": 60000,
+  "debug": false
+}
+```
+All endpoint should be configured with out a trailing slash. The endpoints `apiEndpoint` and `dataStrategy.config.endpoint` can be
+left empty if the api is hosted from the root of the same domain as the client. E.g. if the api is at https://example.org and the client is at
+https://example.org/client
+
 ## Docker development setup
 
 Start docker setup

infrastructure/itkdev/etc/confd/templates/config.tmpl

@@ -1,12 +1,12 @@
 {
-  "apiEndpoint": "{{ getenv "APP_API_ENDPOINT" "/" }}",
+  "apiEndpoint": "{{ getenv "APP_API_ENDPOINT" "" }}",
   "authenticationEndpoint": "{{ getenv "APP_API_AUTHENTICATION_ENDPOINT" "/v1/authentication/token" }}",
   "authenticationRefreshTokenEndpoint": "{{ getenv "APP_API_AUTHENTICATION_REFRESH_ENDPOINT" "/v1/authentication/token/refresh" }}",
   "dataStrategy": {
     "type": "pull",
     "config": {
       "interval": {{ getenv "APP_DATA_PULL_INTERVAL" "30000" }},
-      "endpoint": "{{ getenv "APP_API_PATH" "/" }}"
+      "endpoint": "{{ getenv "APP_API_PATH" "" }}"
     }
   },
   "colorScheme": {

public/example_config.json

@@ -1,12 +1,12 @@
 {
-  "apiEndpoint": "/",
+  "apiEndpoint": "",
   "authenticationEndpoint": "/v1/authentication/screen",
   "authenticationRefreshTokenEndpoint": "/v1/authentication/token/refresh",
   "dataStrategy": {
     "type": "pull",
     "config": {
       "interval": 30000,
-      "endpoint": "/"
+      "endpoint": ""
     }
   },
   "colorScheme": {