diff --git a/wikijs/README.txt b/wikijs/README.txt index 092ce7a..663f234 100644 --- a/wikijs/README.txt +++ b/wikijs/README.txt @@ -19,6 +19,7 @@ HTTP_PORT - Web interface port (default: 3080) PUID - User ID for file permissions (default: 1000) PGID - Group ID for file permissions (default: 1000) TZ - Timezone (default: Pacific/Auckland) +DB_TYPE - Database type: sqlite or postgres (default: sqlite) Ports ----- @@ -44,10 +45,19 @@ You will be guided through the initial setup wizard to: Database -------- -By default, Wiki.js uses SQLite which requires no additional setup. -For PostgreSQL support, configure the database settings in the -Wiki.js admin panel after initial setup, or edit the config.yml -file directly in DATA_PATH/config/. +By default, Wiki.js uses SQLite (DB_TYPE=sqlite) which requires no +additional setup and stores data in DATA_PATH/data/. + +For PostgreSQL support, set DB_TYPE=postgres and configure these +additional environment variables in service.env: + DB_HOST - PostgreSQL server hostname + DB_PORT - PostgreSQL server port (default: 5432) + DB_NAME - Database name + DB_USER - Database username + DB_PASS - Database password + +Note: Database settings only apply on first run. After initial setup, +modify DATA_PATH/config/config.yml directly. Backup & Restore ---------------- diff --git a/wikijs/config/service.env b/wikijs/config/service.env index 9a1edfc..60b54b8 100644 --- a/wikijs/config/service.env +++ b/wikijs/config/service.env @@ -16,3 +16,6 @@ HTTP_PORT=3080 PUID=1000 PGID=1000 TZ="Pacific/Auckland" + +# Database configuration (sqlite requires no external database) +DB_TYPE="sqlite" diff --git a/wikijs/start.sh b/wikijs/start.sh index 666233e..8dc557d 100755 --- a/wikijs/start.sh +++ b/wikijs/start.sh @@ -1,6 +1,6 @@ #!/bin/bash source "${AGENT_PATH}/common.sh" -_check_required_env_vars "CONTAINER_NAME" "IMAGE_REGISTRY" "IMAGE_REPO" "IMAGE_TAG" "DATA_PATH" "HTTP_PORT" "PUID" "PGID" "TZ" +_check_required_env_vars "CONTAINER_NAME" "IMAGE_REGISTRY" "IMAGE_REPO" "IMAGE_TAG" "DATA_PATH" "HTTP_PORT" "PUID" "PGID" "TZ" "DB_TYPE" # START SCRIPT # The start script is required for all templates. @@ -15,6 +15,7 @@ DOCKER_RUN_CMD="docker run -d \ -e PUID=${PUID} \ -e PGID=${PGID} \ -e TZ=${TZ} \ + -e DB_TYPE=${DB_TYPE} \ ${IMAGE_REGISTRY}/${IMAGE_REPO}:${IMAGE_TAG}" if ! _create_and_start_container "$DOCKER_RUN_CMD" "$CONTAINER_NAME"; then