From 9b5102afbda5ced40a36366b6e2dc557f7de5bd2 Mon Sep 17 00:00:00 2001 From: thelamer Date: Mon, 22 Sep 2025 14:32:19 -0400 Subject: [PATCH] doc tweaks --- Dockerfile | 2 +- README.md | 12 ++++++------ readme-vars.yml | 9 ++++----- 3 files changed, 11 insertions(+), 12 deletions(-) diff --git a/Dockerfile b/Dockerfile index 07cfd16..bded40e 100644 --- a/Dockerfile +++ b/Dockerfile @@ -59,4 +59,4 @@ RUN \ COPY /root / # ports and volumes -EXPOSE 3000 +EXPOSE 3001 diff --git a/README.md b/README.md index b4fdd56..4ea2fb9 100644 --- a/README.md +++ b/README.md @@ -231,8 +231,8 @@ services: volumes: - /path/to/config:/config ports: - - 3000:3000 #optional - - 3001:3001 #optional + - 3000:3000 + - 3001:3001 shm_size: "1gb" restart: unless-stopped ``` @@ -245,8 +245,8 @@ docker run -d \ -e PUID=1000 \ -e PGID=1000 \ -e TZ=Etc/UTC \ - -p 3000:3000 `#optional` \ - -p 3001:3001 `#optional` \ + -p 3000:3000 \ + -p 3001:3001 \ -v /path/to/config:/config \ --shm-size="1gb" \ --restart unless-stopped \ @@ -259,8 +259,8 @@ Containers are configured using parameters passed at runtime (such as those abov | Parameter | Function | | :----: | --- | -| `-p 3000` | digiKam desktop gui HTTP, must be proxied | -| `-p 3001` | digiKam desktop gui HTTPS | +| `-p 3000:3000` | Calligra desktop gui HTTP, must be proxied. | +| `-p 3001:3001` | Calligra desktop gui HTTPS. | | `-e PUID=1000` | for UserID - see below for explanation | | `-e PGID=1000` | for GroupID - see below for explanation | | `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). | diff --git a/readme-vars.yml b/readme-vars.yml index d844ffb..1c1fadb 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -19,11 +19,10 @@ param_container_name: "{{ project_name }}" param_usage_include_vols: true param_volumes: - {vol_path: "/config", vol_host_path: "/path/to/config", desc: "Users home directory in the container, stores database."} -# optional parameters -opt_param_usage_include_ports: true -opt_param_ports: - - {external_port: "3000", internal_port: "3000", port_desc: "digiKam desktop gui HTTP, must be proxied"} - - {external_port: "3001", internal_port: "3001", port_desc: "digiKam desktop gui HTTPS"} +param_usage_include_ports: true +param_ports: + - {external_port: "3000", internal_port: "3000", port_desc: "Calligra desktop gui HTTP, must be proxied."} + - {external_port: "3001", internal_port: "3001", port_desc: "Calligra desktop gui HTTPS."} custom_params: - {name: "shm-size", name_compose: "shm_size", value: "1gb", desc: "Recommended for all desktop images."} # Selkies blurb settings