Enables PIXL DB to operate as a service separate from Orthanc Raw

.env.sample

@@ -10,12 +10,13 @@ PIXL_DB_NAME=pixl
 PIXL_DB_USER=pixl
 PIXL_DB_PASSWORD=
 SKIP_ALEMBIC=false
+EXTERNAL_PIXL_DB=false
 
 # PIXL DB Postgres host
 CLI_PIXL_DB_HOST=localhost
 
 # Orthanc Raw PostgreSQL instance
-ORTHANC_RAW_DB_HOST=postgres-exposed  # change to `postgres` if PIXL DB is external postgres instance
+ORTHANC_RAW_DB_HOST=postgres-exposed  # change to correct host if PIXL DB is external postgres instance
 ORTHANC_RAW_DB_PORT=5432
 ORTHANC_RAW_DB_NAME=pixl
 ORTHANC_RAW_DB_USER=pixl

cli/README.md

@@ -35,22 +35,27 @@ For convenience, we provide the `pixl dc` command, which acts as a wrapper for `
 but takes care of some of the configuration for you.
 
 **1) Default Start-up**
+
 ```bash
 pixl dc up
 ```
-By default, `pixl dc up` runs with the option: `--profile postgres-exposed`. You should use this option if PIXL DB and Orthanc Raw 
-will share the same postgres instance. The `ORTHANC_RAW_DB_*` and `PIXL_DB_*` variables should have the same values, as seen in the 
-[default .env.sample](../.env.sample).
 
 **2) Start-up with External PIXL DB**
-Set the port number environment variable of your external PIXL DB:
+
+PIXL can be set up so that the PIXL DB uses a separate postgres instance to Orthanc Raw, e.g. for production environment configurations. 
+Edit the .env file to enable this:
+
 ```bash
+EXTERNAL_PIXL_DB=true
+
 CLI_PIXL_DB_PORT=7001
+
+ORTHANC_RAW_DB_HOST=postgres
 ```
 
 Start-up PIXL:
 ```bash
-pixl dc up --profile postgres
+pixl dc up
 ```
 
 ### Configuration

cli/src/pixl_cli/_docker_commands.py

@@ -12,6 +12,7 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
+import os
 import shutil
 import subprocess
 from pathlib import Path
@@ -42,11 +43,17 @@ def dc(args: tuple[str]) -> None:
 
 
 def _parse_up_args(args: tuple[str, ...]) -> list:
-    """Check up args and define default profile if not set"""
+    """Check up args and set docker compose profile"""
     args_list = list(args)
-    if "--profile" not in args:
-        up_index = args.index("up")
-        args_list[up_index:up_index] = ["--profile", "postgres-exposed"]
+
+    up_index = args.index("up")
+    external_pixl_db_env = os.environ.get("EXTERNAL_PIXL_DB", "false").lower()
+    args_list[up_index:up_index] = (
+        ["--profile", "postgres"]
+        if external_pixl_db_env == "true"
+        else ["--profile", "postgres-exposed"]
+    )
+
     args_list.extend(["--wait", "--build", "--remove-orphans"])
     return args_list
 

test/.env

@@ -14,6 +14,7 @@ PIXL_DB_NAME=pixl
 PIXL_DB_USER=pixl_db_username
 PIXL_DB_PASSWORD=pixl_db_password
 SKIP_ALEMBIC=false
+EXTERNAL_PIXL_DB=true
 
 # PIXL DB Postgres host
 CLI_PIXL_DB_HOST=localhost