adds example config file

Author: tdjsnelling

README.md

@@ -60,9 +60,11 @@ The sqtracker platform is designed to be deployed via Docker. Once a configurati
 
 Alternatively, you can deploy each service individually on a PaaS cloud platform such as [Northflank](https://northflank.com).
 
+If you change the name of any services in `docker-compose.yml`, you will also need to update the relevant host names in your `config.js` and `traefik.yml` files.
+
 ## Configuration
 
-All configuration is provided via a single JavaScript file. This file must export an object containing 2 keys: `envs` and `secrets`.
+All configuration is provided via a single JavaScript file named `config.js`. This file must export an object containing 2 keys: `envs` and `secrets`.
 
 A full list of configuration options is below. All are required.
 

config.example.js

@@ -0,0 +1,29 @@
+/*
+  This is an example configuration file. Copy it to config.js and change each value according to your desired setup.
+  See the README.md file for a description of each configuration item.
+*/
+
+module.exports = {
+  envs: {
+    SQ_SITE_NAME: 'sqtracker demo',
+    SQ_SITE_DESCRIPTION: 'A short description for your tracker site',
+    SQ_ALLOW_REGISTER: 'invite',
+    SQ_ALLOW_ANONYMOUS_UPLOADS: false,
+    SQ_MINIMUM_RATIO: 0.75,
+    SQ_TORRENT_CATEGORIES: ['Movies', 'TV', 'Music', 'Books'],
+    SQ_BASE_URL: 'https://sqtracker.dev',
+    SQ_API_URL: 'https://sqtracker.dev/api',
+    SQ_TRACKER_URL: 'http://sq_opentracker:6969',
+    SQ_MONGO_URL: 'mongodb://sq_mongodb',
+    SQ_MAIL_FROM_ADDRESS: 'mail@sqtracker.dev',
+    SQ_SMTP_HOST: 'smtp.example.com',
+    SQ_SMTP_PORT: 587,
+    SQ_SMTP_SECURE: false,
+  },
+  secrets: {
+    SQ_JWT_SECRET: 'long_random_string',
+    SQ_ADMIN_EMAIL: 'admin@example.com',
+    SQ_SMTP_USER: 'smtp_username',
+    SQ_SMTP_PASS: 'smtp_password',
+  },
+}