Merge pull request #93 from Owen000/main

Make postgres password dynamic

Author: iPromKnight

.gitignore

@@ -5,6 +5,7 @@ riderModule.iml
 /_ReSharper.Caches/
 .DS_Store
 .idea/
+.env
 
 src/Zilean.Scraper/python/
 src/Zilean.ApiService/python/

docs/Writerside/snippets/compose-file.yaml

@@ -9,6 +9,8 @@ services:
     restart: unless-stopped
     container_name: zilean
     tty: true
+    environment:
+      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
     ports:
       - "8181:8181"
     volumes:
@@ -31,12 +33,12 @@ services:
     environment:
       PGDATA: /var/lib/postgresql/data/pgdata
       POSTGRES_USER: postgres
-      POSTGRES_PASSWORD: postgres
+      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
       POSTGRES_DB: zilean
     volumes:
       - postgres_data:/var/lib/postgresql/data/pgdata
     healthcheck:
       test: [ "CMD-SHELL", "pg_isready -U postgres" ]
       interval: 10s
       timeout: 5s
-      retries: 5
+      retries: 5

docs/Writerside/snippets/default-settings.json

@@ -15,7 +15,7 @@
       "EnableEndpoint": true
     },
     "Database": {
-      "ConnectionString": "Host=postgres;Database=zilean;Username=postgres;Password=postgres;Include Error Detail=true;Timeout=30;CommandTimeout=3600;"
+      "ConnectionString": "Host=postgres;Database=zilean;Username=postgres;Password=$POSTGRES_PASSWORD;Include Error Detail=true;Timeout=30;CommandTimeout=3600;"
     },
     "Torrents": {
       "EnableEndpoint": false,

docs/Writerside/snippets/settings-with-ingestion.json

@@ -15,7 +15,7 @@
       "EnableEndpoint": true
     },
     "Database": {
-      "ConnectionString": "Host=localhost;Database=zilean;Username=postgres;Password=postgres;Include Error Detail=true;Timeout=30;CommandTimeout=3600;"
+      "ConnectionString": "Host=localhost;Database=zilean;Username=postgres;Password=$POSTGRES_PASSWORD;Include Error Detail=true;Timeout=30;CommandTimeout=3600;"
     },
     "Torrents": {
       "EnableEndpoint": true,

docs/Writerside/topics/Configuration.md

@@ -67,7 +67,8 @@ _Default: `true`_
 ### Database Configuration
 **Database.ConnectionString**
 _The connection string for the PostgreSQL database._
-_Default: `Host=localhost;Database=zilean;Username=postgres;Password=postgres;Include Error Detail=true;Timeout=30;CommandTimeout=3600;`_
+_$POSTGRES_PASSWORD should be replaced with the password in your .env_
+_Default: `Host=localhost;Database=zilean;Username=postgres;Password=$POSTGRES_PASSWORD;Include Error Detail=true;Timeout=30;CommandTimeout=3600;`_
 
 The database connection string comprises of the following:
 - `Host`: The host of the database, this will usually be the `containername` if you are using docker compose of the postgres instance.

docs/Writerside/topics/Getting-Started.md

@@ -18,6 +18,12 @@ The easiest way to get up and running with %Product% is to use the provided dock
 Ensure you have the following installed:
 - Docker, Docker Desktop or Podman
 
+First, generate your postgres password with 
+
+```bash
+echo "POSTGRES_PASSWORD=$(openssl rand -base64 42 | tr -dc A-Za-z0-9 | cut -c -32 | tr -d '\n')" > .env
+```
+
 The example compose file below can be copied, and used to get the system running locally.
 
 ```yaml
@@ -40,4 +46,4 @@ docker compose pull %product%
 
 > Please Note - Always make sure you check the [github release notes](https://github.com/iPromKnight/zilean/releases) for the latest release, to ensure there are no breaking changes.
 > The changelog can also be viewed [here](https://github.com/iPromKnight/zilean/blob/main/CHANGELOG.md).
-{ style="note" }
+{ style="note" }

eng/compose-dev.yaml

@@ -6,12 +6,12 @@ services:
     environment:
       PGDATA: /var/lib/postgresql/data/pgdata
       POSTGRES_USER: postgres
-      POSTGRES_PASSWORD: postgres
+      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
       POSTGRES_DB: postgres
     ports:
       - "5432:5432"
     healthcheck:
       test: [ "CMD-SHELL", "pg_isready -U postgres" ]
       interval: 10s
       timeout: 5s
-      retries: 5
+      retries: 5

src/Zilean.Shared/Features/Configuration/DatabaseConfiguration.cs

@@ -2,5 +2,16 @@ namespace Zilean.Shared.Features.Configuration;
 
 public class DatabaseConfiguration
 {
-    public string ConnectionString { get; set; } = "Host=postgres;Database=zilean;Username=postgres;Password=postgres;Include Error Detail=true;Timeout=30;CommandTimeout=3600;";
+  public string ConnectionString { get; set; }
+
+  public DatabaseConfiguration()
+  {
+    var password = Environment.GetEnvironmentVariable("POSTGRES_PASSWORD");
+    if (string.IsNullOrWhiteSpace(password))
+    {
+      throw new InvalidOperationException("Environment variable POSTGRES_PASSWORD is not set.");
+    }
+
+    ConnectionString = $"Host=postgres;Database=zilean;Username=postgres;Password={password};Include Error Detail=true;Timeout=30;CommandTimeout=3600;";
+  }
 }