Use a Docker volume to store the configuration of the apps and stores

.gitignore

@@ -65,9 +65,4 @@ typings/
 
 # SonarQube
 .sonarlint
-.scannerwork
-
-# Ignore existing configuration file
-# Remove it from this file if you want to save them on your Git repo
-src/config/apps.json
-src/config/config.json
+.scannerwork

Dockerfile

@@ -28,9 +28,7 @@ HEALTHCHECK --interval=15s --timeout=5s --start-period=30s \
 
 RUN \
       npm install --production --unsafe-perm && \
-      npm cache clean --force && \
-      mv /opt/app/src/config/apps.sample.json /opt/app/src/config/apps.json && \
-      mv /opt/app/src/config/config.sample.json /opt/app/src/config/config.json
+      npm cache clean --force
 
 RUN chown -R app-user /opt/app
 USER app-user

README.md

@@ -308,16 +308,16 @@ cd app-stores-prometheus-exporter
 npm install
 ```
 
-Rename the configuration files
+Copy the configuration files
 
 | From || To |
 |---|---|---|
-|config/apps.**sample**.json|=>|config/apps.json|
-|config/config.**sample**.json|=>|config/config.json|
+|src/examples/apps.json|=>|config/apps.json|
+|src/examples/config.json|=>|config/config.json|
 
 ``` bash
-mv config/apps.sample.json config/apps.json
-mv config/config.sample.json config/config.json
+mv src/examples/apps.json config/apps.json
+mv src/examples/config.json config/config.json
 ```
 
 Start the App Stores Prometheus Exporter:

docker-compose.yml

@@ -1,10 +1,15 @@
-version: '2'
+version: '3.3'
 
 services:
   api:
     image: timoa/app-stores-prometheus-exporter:latest
     environment:
       - NODE_ENV=production
+    volumes:
+      - ./config:/opt/app/config
     ports:
       - 9514:9514
     restart: always
+
+volumes:
+  config:

src/exporter.js

@@ -5,15 +5,15 @@ const path = require('path');
 
 const logger = require('./lib/logger');
 
-// Check if apps.sample.json has been renamed
-if (!fs.existsSync(path.resolve(__dirname, 'config/apps.json'))) {
-  logger.error('Please rename the file "src/config/apps.sample.json" => "src/config/apps.json"');
+// Check if there is a `apps.json` in the config folder
+if (!fs.existsSync(path.resolve(__dirname, '../config/apps.json'))) {
+  logger.error('Please copy the file "src/examples/apps.json" => "config/apps.json"');
   process.exit(1);
 }
 
-// Check if config.sample.json has been renamed
-if (!fs.existsSync(path.resolve(__dirname, 'config/config.json'))) {
-  logger.error('Please rename the file "src/config/config.sample.json" => "src/config/config.json"');
+// Check if there is a `config.json` in the config folder
+if (!fs.existsSync(path.resolve(__dirname, '../config/config.json'))) {
+  logger.error('Please copy the file "src/examples/config.json" => "config/config.json"');
   process.exit(1);
 }
 

src/lib/prometheus.js

@@ -6,8 +6,8 @@ const itunes = require('app-store-scraper');
 const gplay = require('google-play-scraper');
 
 // Config files
-const config = require('../config/config.json');
-const apps = require('../config/apps.json');
+const config = require('../../config/config.json');
+const apps = require('../../config/apps.json');
 const metrics = require('../config/metrics.json');
 
 const register = new client.Registry();