chore(fireshare): refactor config

apps/fireshare/config.json

@@ -15,25 +15,25 @@
   "form_fields": [
     {
       "type": "random",
-      "label": "SECRET_KEY",
+      "label": "FIRESHARE_SECRET_KEY",
       "min": 32,
-      "env_variable": "SECRET_KEY"
+      "env_variable": "FIRESHARE_SECRET_KEY"
     },
     {
       "type": "text",
-      "label": "ADMIN_USERNAME",
+      "label": "Fireshare username",
       "max": 50,
       "min": 3,
       "required": true,
-      "env_variable": "ADMIN_USERNAME"
+      "env_variable": "FIRESHARE_USERNAME"
     },
     {
       "type": "password",
-      "label": "ADMIN_PASSWORD",
+      "label": "Fireshare password",
       "max": 50,
-      "min": 3,
+      "min": 8,
       "required": true,
-      "env_variable": "ADMIN_PASSWORD"
+      "env_variable": "FIRESHARE_PASSWORD"
     }
   ]
 }

apps/fireshare/docker-compose.yml

@@ -1,4 +1,4 @@
-version: "3"
+version: '3'
 
 services:
   fireshare:
@@ -11,9 +11,9 @@ services:
       - ${APP_DATA_DIR}/data/fireshare_processed:/processed
       - ${ROOT_FOLDER_HOST}/media/data/videos/fireshare_videos:/videos
     environment:
-      - ADMIN_USERNAME=${ADMIN_USERNAME}
+      - ADMIN_USERNAME=${FIRESHARE_USERNAME}
-      - ADMIN_PASSWORD=${ADMIN_PASSWORD}
+      - ADMIN_PASSWORD=${FIRESHARE_PASSWORD}
-      - SECRET_KEY=${SECRET_KEY}
+      - SECRET_KEY=${FIRESHARE_SECRET_KEY}
       - MINUTES_BETWEEN_VIDEO_SCANS=5
       - PUID=1000
       - PGID=1000

apps/fireshare/metadata/description.md

@@ -1,18 +1,16 @@
-[![Logo](https://github.com/ShaneIsrael/fireshare/raw/main/app/client/src/assets/logo.png)](https://github.com/ShaneIsrael/fireshare)
-
 ## Fireshare
 
 Table of Contents
 
 1.  [About The Project](https://github.com/ShaneIsrael/fireshare#about-the-project)
-    -   [Built With](https://github.com/ShaneIsrael/fireshare#built-with)
+    - [Built With](https://github.com/ShaneIsrael/fireshare#built-with)
 2.  [Installation](https://github.com/ShaneIsrael/fireshare#installation)
-    -   [Configurable Settings](https://github.com/ShaneIsrael/fireshare#configurable-settings)
+    - [Configurable Settings](https://github.com/ShaneIsrael/fireshare#configurable-settings)
 3.  [Local Development](https://github.com/ShaneIsrael/fireshare#local-development)
-    -   [Setup](https://github.com/ShaneIsrael/fireshare#setup)
+    - [Setup](https://github.com/ShaneIsrael/fireshare#setup)
 4.  [Contributing](https://github.com/ShaneIsrael/fireshare#contributing)
 5.  [FAQ / Troubleshooting](https://github.com/ShaneIsrael/fireshare#frequently-asked-questions)
-    -   [Playback Issues](https://github.com/ShaneIsrael/fireshare#playback-issues)
+    - [Playback Issues](https://github.com/ShaneIsrael/fireshare#playback-issues)
 
 ## About The Project
 
@@ -82,9 +80,9 @@ Connect Fireshare to a central user directory and keep user access organised.
 
 ### Built With
 
--   [React](https://reactjs.org/)
+- [React](https://reactjs.org/)
--   [Python](https://www.python.org/)
+- [Python](https://www.python.org/)
--   [Material UI](https://mui.com/)
+- [Material UI](https://mui.com/)
 
 ## Installation
 
@@ -96,7 +94,7 @@ Fireshare needs 3 volume mounts.
 2.  **/processed** - The directory used to hold metadata created by fireshare in relation to your videos (posters, metadata info)
 3.  **/videos** - The directory fireshare will watch and scan for any videos.
 
-If you have all of your game clips stored in a folder **my\_game\_clips** then in your docker compose file (or docker run command) you will need to volume mount that folder to the **/videos** folder that fireshare watches.
+If you have all of your game clips stored in a folder **my_game_clips** then in your docker compose file (or docker run command) you will need to volume mount that folder to the **/videos** folder that fireshare watches.
 
 ### Docker Compose