Skip to content

Commit 9b5102a

Browse files
committed
doc tweaks
1 parent 43e5989 commit 9b5102a

3 files changed

Lines changed: 11 additions & 12 deletions

File tree

Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,4 +59,4 @@ RUN \
5959
COPY /root /
6060

6161
# ports and volumes
62-
EXPOSE 3000
62+
EXPOSE 3001

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -231,8 +231,8 @@ services:
231231
volumes:
232232
- /path/to/config:/config
233233
ports:
234-
- 3000:3000 #optional
235-
- 3001:3001 #optional
234+
- 3000:3000
235+
- 3001:3001
236236
shm_size: "1gb"
237237
restart: unless-stopped
238238
```
@@ -245,8 +245,8 @@ docker run -d \
245245
-e PUID=1000 \
246246
-e PGID=1000 \
247247
-e TZ=Etc/UTC \
248-
-p 3000:3000 `#optional` \
249-
-p 3001:3001 `#optional` \
248+
-p 3000:3000 \
249+
-p 3001:3001 \
250250
-v /path/to/config:/config \
251251
--shm-size="1gb" \
252252
--restart unless-stopped \
@@ -259,8 +259,8 @@ Containers are configured using parameters passed at runtime (such as those abov
259259

260260
| Parameter | Function |
261261
| :----: | --- |
262-
| `-p 3000` | digiKam desktop gui HTTP, must be proxied |
263-
| `-p 3001` | digiKam desktop gui HTTPS |
262+
| `-p 3000:3000` | Calligra desktop gui HTTP, must be proxied. |
263+
| `-p 3001:3001` | Calligra desktop gui HTTPS. |
264264
| `-e PUID=1000` | for UserID - see below for explanation |
265265
| `-e PGID=1000` | for GroupID - see below for explanation |
266266
| `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |

readme-vars.yml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,10 @@ param_container_name: "{{ project_name }}"
1919
param_usage_include_vols: true
2020
param_volumes:
2121
- {vol_path: "/config", vol_host_path: "/path/to/config", desc: "Users home directory in the container, stores database."}
22-
# optional parameters
23-
opt_param_usage_include_ports: true
24-
opt_param_ports:
25-
- {external_port: "3000", internal_port: "3000", port_desc: "digiKam desktop gui HTTP, must be proxied"}
26-
- {external_port: "3001", internal_port: "3001", port_desc: "digiKam desktop gui HTTPS"}
22+
param_usage_include_ports: true
23+
param_ports:
24+
- {external_port: "3000", internal_port: "3000", port_desc: "Calligra desktop gui HTTP, must be proxied."}
25+
- {external_port: "3001", internal_port: "3001", port_desc: "Calligra desktop gui HTTPS."}
2726
custom_params:
2827
- {name: "shm-size", name_compose: "shm_size", value: "1gb", desc: "Recommended for all desktop images."}
2928
# Selkies blurb settings

0 commit comments

Comments
 (0)