Skip to content

Commit 0dec32f

Browse files
ahzeahze
committed
update docs
1 parent 9caf434 commit 0dec32f

39 files changed

Lines changed: 85 additions & 192 deletions

‎docs/images/adguardhome-sync.md‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,21 +82,18 @@ Access the Web UI at: `http://localhost:@ADGUARDHOME_SYNC_PORT@`
8282
<div class="placeholder-settings-panel"></div>
8383

8484
## Parameters
85-
8685
### Environment Variables
8786

8887
| Variable | Default | Description |
8988
|----------|---------|-------------|
9089
| `PUID` | `1000` | User ID for the application process |
9190
| `PGID` | `1000` | Group ID for the application process |
9291
| `TZ` | `UTC` | Timezone for the container |
93-
9492
### Volumes
9593

9694
| Path | Description |
9795
|------|-------------|
9896
| `/config` | Configuration directory |
99-
10097
### Ports
10198

10299
| Port | Protocol | Description |

‎docs/images/adguardhome.md‎

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ Before deploying, ensure your host environment is ready. See the [Quick Start Gu
4040
- PGID=@PGID@
4141
- TZ=@TZ@
4242
volumes:
43-
- @CONTAINER_CONFIG_ROOT@/@ADGUARDHOME_OPT_ADGUARDHOME_CONF_PATH@:/opt/adguardhome/conf
44-
- @CONTAINER_CONFIG_ROOT@/@ADGUARDHOME_OPT_ADGUARDHOME_WORK_PATH@:/opt/adguardhome/work
43+
- @CONTAINER_CONFIG_ROOT@/@ADGUARDHOME_CONF_PATH@:/opt/adguardhome/conf
44+
- @CONTAINER_CONFIG_ROOT@/@ADGUARDHOME_WORK_PATH@:/opt/adguardhome/work
4545
ports:
4646
- @ADGUARDHOME_PORT@:53
4747
- 53:53
@@ -83,8 +83,8 @@ Before deploying, ensure your host environment is ready. See the [Quick Start Gu
8383
-e PUID=@PUID@ \
8484
-e PGID=@PGID@ \
8585
-e TZ=@TZ@ \
86-
-v @CONTAINER_CONFIG_ROOT@/@ADGUARDHOME_OPT_ADGUARDHOME_CONF_PATH@:/opt/adguardhome/conf \
87-
-v @CONTAINER_CONFIG_ROOT@/@ADGUARDHOME_OPT_ADGUARDHOME_WORK_PATH@:/opt/adguardhome/work \
86+
-v @CONTAINER_CONFIG_ROOT@/@ADGUARDHOME_CONF_PATH@:/opt/adguardhome/conf \
87+
-v @CONTAINER_CONFIG_ROOT@/@ADGUARDHOME_WORK_PATH@:/opt/adguardhome/work \
8888
ghcr.io/daemonless/adguardhome:latest
8989
```
9090

@@ -118,8 +118,8 @@ Before deploying, ensure your host environment is ready. See the [Quick Start Gu
118118
- "6060:6060"
119119
- "8853:8853"
120120
volumes:
121-
- "@CONTAINER_CONFIG_ROOT@/@ADGUARDHOME_OPT_ADGUARDHOME_CONF_PATH@:/opt/adguardhome/conf"
122-
- "@CONTAINER_CONFIG_ROOT@/@ADGUARDHOME_OPT_ADGUARDHOME_WORK_PATH@:/opt/adguardhome/work"
121+
- "@CONTAINER_CONFIG_ROOT@/@ADGUARDHOME_CONF_PATH@:/opt/adguardhome/conf"
122+
- "@CONTAINER_CONFIG_ROOT@/@ADGUARDHOME_WORK_PATH@:/opt/adguardhome/work"
123123
```
124124

125125
Access the Web UI at: `http://localhost:@ADGUARDHOME_PORT@`
@@ -129,22 +129,19 @@ Access the Web UI at: `http://localhost:@ADGUARDHOME_PORT@`
129129
<div class="placeholder-settings-panel"></div>
130130

131131
## Parameters
132-
133132
### Environment Variables
134133

135134
| Variable | Default | Description |
136135
|----------|---------|-------------|
137136
| `PUID` | `1000` | User ID for the application process |
138137
| `PGID` | `1000` | Group ID for the application process |
139138
| `TZ` | `UTC` | Timezone for the container |
140-
141139
### Volumes
142140

143141
| Path | Description |
144142
|------|-------------|
145143
| `/opt/adguardhome/conf` | Configuration files |
146144
| `/opt/adguardhome/work` | Work directory (database, logs, data) |
147-
148145
### Ports
149146

150147
| Port | Protocol | Description |

‎docs/images/arr-base.md‎

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,6 @@ Before deploying, ensure your host environment is ready. See the [Quick Start Gu
3030
arr-base:
3131
image: ghcr.io/daemonless/arr-base:latest
3232
container_name: arr-base
33-
environment:
34-
volumes:
35-
ports:
3633
restart: unless-stopped
3734
```
3835

@@ -60,21 +57,6 @@ Before deploying, ensure your host environment is ready. See the [Quick Start Gu
6057

6158
## Parameters
6259

63-
### Environment Variables
64-
65-
| Variable | Default | Description |
66-
|----------|---------|-------------|
67-
68-
### Volumes
69-
70-
| Path | Description |
71-
|------|-------------|
72-
73-
### Ports
74-
75-
| Port | Protocol | Description |
76-
|------|----------|-------------|
77-
7860
!!! info "Implementation Details"
7961

8062
- **User:** `root` (UID/GID set via [PUID/PGID](../guides/permissions.md)). Defaults to `1000:1000`.

‎docs/images/base.md‎

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,6 @@ Before deploying, ensure your host environment is ready. See the [Quick Start Gu
3030
base:
3131
image: ghcr.io/daemonless/base:latest
3232
container_name: base
33-
environment:
34-
volumes:
35-
ports:
3633
restart: unless-stopped
3734
```
3835

@@ -60,21 +57,6 @@ Before deploying, ensure your host environment is ready. See the [Quick Start Gu
6057

6158
## Parameters
6259

63-
### Environment Variables
64-
65-
| Variable | Default | Description |
66-
|----------|---------|-------------|
67-
68-
### Volumes
69-
70-
| Path | Description |
71-
|------|-------------|
72-
73-
### Ports
74-
75-
| Port | Protocol | Description |
76-
|------|----------|-------------|
77-
7860
!!! info "Implementation Details"
7961

8062
- **User:** `root` (UID/GID set via [PUID/PGID](../guides/permissions.md)). Defaults to `1000:1000`.

‎docs/images/gitea.md‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,21 +85,18 @@ Access the Web UI at: `http://localhost:@GITEA_PORT@`
8585
<div class="placeholder-settings-panel"></div>
8686

8787
## Parameters
88-
8988
### Environment Variables
9089

9190
| Variable | Default | Description |
9291
|----------|---------|-------------|
9392
| `PUID` | `1000` | User ID for the application process |
9493
| `PGID` | `1000` | Group ID for the application process |
9594
| `TZ` | `UTC` | Timezone for the container |
96-
9795
### Volumes
9896

9997
| Path | Description |
10098
|------|-------------|
10199
| `/config` | Configuration, repositories, and data directory |
102-
103100
### Ports
104101

105102
| Port | Protocol | Description |

‎docs/images/homepage.md‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,21 +84,18 @@ Access the Web UI at: `http://localhost:@HOMEPAGE_PORT@`
8484
<div class="placeholder-settings-panel"></div>
8585

8686
## Parameters
87-
8887
### Environment Variables
8988

9089
| Variable | Default | Description |
9190
|----------|---------|-------------|
9291
| `PUID` | `1000` | User ID for the application process |
9392
| `PGID` | `1000` | Group ID for the application process |
9493
| `TZ` | `UTC` | Timezone for the container |
95-
9694
### Volumes
9795

9896
| Path | Description |
9997
|------|-------------|
10098
| `/config` | Configuration directory (settings, bookmarks, services) |
101-
10299
### Ports
103100

104101
| Port | Protocol | Description |

‎docs/images/hugo.md‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,6 @@ Access the Web UI at: `http://localhost:@HUGO_PORT@`
8787
<div class="placeholder-settings-panel"></div>
8888

8989
## Parameters
90-
9190
### Environment Variables
9291

9392
| Variable | Default | Description |
@@ -96,13 +95,11 @@ Access the Web UI at: `http://localhost:@HUGO_PORT@`
9695
| `PGID` | `1000` | Group ID for the application process |
9796
| `TZ` | `UTC` | Timezone for the container |
9897
| `HUGO_BASEURL` | `http://localhost:1313` | Hostname (and path) to the root |
99-
10098
### Volumes
10199

102100
| Path | Description |
103101
|------|-------------|
104102
| `/app` | Website source code (mount your repo here) |
105-
106103
### Ports
107104

108105
| Port | Protocol | Description |

‎docs/images/immich-ml.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Before deploying, ensure your host environment is ready. See the [Quick Start Gu
4141
- PGID=@PGID@
4242
- TZ=@TZ@
4343
volumes:
44-
- @CONTAINER_CONFIG_ROOT@/@IMMICH_ML_CACHE_PATH@:/cache
44+
- @CONTAINER_CONFIG_ROOT@/@IMMICH_CACHE_PATH@:/cache
4545
- @CONTAINER_CONFIG_ROOT@/@IMMICH_ML_CONFIG_PATH@:/config
4646
ports:
4747
- @IMMICH_ML_PORT@:3003
@@ -59,7 +59,7 @@ Before deploying, ensure your host environment is ready. See the [Quick Start Gu
5959
-e PUID=@PUID@ \
6060
-e PGID=@PGID@ \
6161
-e TZ=@TZ@ \
62-
-v @CONTAINER_CONFIG_ROOT@/@IMMICH_ML_CACHE_PATH@:/cache \
62+
-v @CONTAINER_CONFIG_ROOT@/@IMMICH_CACHE_PATH@:/cache \
6363
-v @CONTAINER_CONFIG_ROOT@/@IMMICH_ML_CONFIG_PATH@:/config \
6464
ghcr.io/daemonless/immich-ml:latest
6565
```
@@ -83,7 +83,7 @@ Before deploying, ensure your host environment is ready. See the [Quick Start Gu
8383
ports:
8484
- "@IMMICH_ML_PORT@:3003"
8585
volumes:
86-
- "@CONTAINER_CONFIG_ROOT@/@IMMICH_ML_CACHE_PATH@:/cache"
86+
- "@CONTAINER_CONFIG_ROOT@/@IMMICH_CACHE_PATH@:/cache"
8787
- "@CONTAINER_CONFIG_ROOT@/@IMMICH_ML_CONFIG_PATH@:/config"
8888
```
8989

@@ -94,7 +94,6 @@ Access the Web UI at: `http://localhost:@IMMICH_ML_PORT@`
9494
<div class="placeholder-settings-panel"></div>
9595

9696
## Parameters
97-
9897
### Environment Variables
9998

10099
| Variable | Default | Description |
@@ -105,20 +104,20 @@ Access the Web UI at: `http://localhost:@IMMICH_ML_PORT@`
105104
| `PUID` | `1000` | User ID for the application process |
106105
| `PGID` | `1000` | Group ID for the application process |
107106
| `TZ` | `UTC` | Timezone for the container |
108-
109107
### Volumes
110108

111109
| Path | Description |
112110
|------|-------------|
113111
| `/cache` | Model cache directory (HuggingFace) |
114112
| `/config` | Configuration directory (unused but mounted) |
115-
116113
### Ports
117114

118115
| Port | Protocol | Description |
119116
|------|----------|-------------|
120117
| `3003` | TCP | ML API |
121118

119+
This image is part of the [Immich Stack](https://daemonless.io/images/immich).
120+
122121
!!! info "Implementation Details"
123122

124123
- **User:** `bsd` (UID/GID set via [PUID/PGID](../guides/permissions.md)). Defaults to `1000:1000`.

‎docs/images/immich-postgres.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Before deploying, ensure your host environment is ready. See the [Quick Start Gu
3838
- POSTGRES_PASSWORD=postgres
3939
- POSTGRES_DB=immich
4040
volumes:
41-
- @CONTAINER_CONFIG_ROOT@/@IMMICH_POSTGRES_VAR_LIB_POSTGRESQL_DATA_PATH@:/var/lib/postgresql/data
41+
- @CONTAINER_CONFIG_ROOT@/@IMMICH_POSTGRES_PATH@:/var/lib/postgresql/data
4242
ports:
4343
- @IMMICH_POSTGRES_PORT@:5432
4444
restart: unless-stopped
@@ -52,7 +52,7 @@ Before deploying, ensure your host environment is ready. See the [Quick Start Gu
5252
-e POSTGRES_USER=postgres \
5353
-e POSTGRES_PASSWORD=postgres \
5454
-e POSTGRES_DB=immich \
55-
-v @CONTAINER_CONFIG_ROOT@/@IMMICH_POSTGRES_VAR_LIB_POSTGRESQL_DATA_PATH@:/var/lib/postgresql/data \
55+
-v @CONTAINER_CONFIG_ROOT@/@IMMICH_POSTGRES_PATH@:/var/lib/postgresql/data \
5656
ghcr.io/daemonless/immich-postgres:latest
5757
```
5858

@@ -72,7 +72,7 @@ Before deploying, ensure your host environment is ready. See the [Quick Start Gu
7272
ports:
7373
- "@IMMICH_POSTGRES_PORT@:5432"
7474
volumes:
75-
- "@CONTAINER_CONFIG_ROOT@/@IMMICH_POSTGRES_VAR_LIB_POSTGRESQL_DATA_PATH@:/var/lib/postgresql/data"
75+
- "@CONTAINER_CONFIG_ROOT@/@IMMICH_POSTGRES_PATH@:/var/lib/postgresql/data"
7676
```
7777

7878
Access the Web UI at: `http://localhost:@IMMICH_POSTGRES_PORT@`
@@ -82,27 +82,26 @@ Access the Web UI at: `http://localhost:@IMMICH_POSTGRES_PORT@`
8282
<div class="placeholder-settings-panel"></div>
8383

8484
## Parameters
85-
8685
### Environment Variables
8786

8887
| Variable | Default | Description |
8988
|----------|---------|-------------|
9089
| `POSTGRES_USER` | `postgres` | Database superuser (default: postgres) |
9190
| `POSTGRES_PASSWORD` | `postgres` | Database password (default: postgres) |
9291
| `POSTGRES_DB` | `immich` | Database name (default: immich) |
93-
9492
### Volumes
9593

9694
| Path | Description |
9795
|------|-------------|
9896
| `/var/lib/postgresql/data` | Database data directory |
99-
10097
### Ports
10198

10299
| Port | Protocol | Description |
103100
|------|----------|-------------|
104101
| `5432` | TCP | PostgreSQL Port |
105102

103+
This image is part of the [Immich Stack](https://daemonless.io/images/immich).
104+
106105
!!! info "Implementation Details"
107106

108107
- **User:** `postgres` (UID/GID set via [PUID/PGID](../guides/permissions.md)). Defaults to `1000:1000`.

‎docs/images/immich-server.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Before deploying, ensure your host environment is ready. See the [Quick Start Gu
4444
- TZ=@TZ@
4545
volumes:
4646
- @CONTAINER_CONFIG_ROOT@/@IMMICH_SERVER_CONFIG_PATH@:/config
47-
- @DATA_PATH@:/data
47+
- @CONTAINER_CONFIG_ROOT@/@IMMICH_DATA_PATH@:/data
4848
ports:
4949
- @IMMICH_SERVER_PORT@:2283
5050
restart: unless-stopped
@@ -64,7 +64,7 @@ Before deploying, ensure your host environment is ready. See the [Quick Start Gu
6464
-e PGID=@PGID@ \
6565
-e TZ=@TZ@ \
6666
-v @CONTAINER_CONFIG_ROOT@/@IMMICH_SERVER_CONFIG_PATH@:/config \
67-
-v @DATA_PATH@:/data \
67+
-v @CONTAINER_CONFIG_ROOT@/@IMMICH_DATA_PATH@:/data \
6868
ghcr.io/daemonless/immich-server:latest
6969
```
7070

@@ -90,7 +90,7 @@ Before deploying, ensure your host environment is ready. See the [Quick Start Gu
9090
- "@IMMICH_SERVER_PORT@:2283"
9191
volumes:
9292
- "@CONTAINER_CONFIG_ROOT@/@IMMICH_SERVER_CONFIG_PATH@:/config"
93-
- "@DATA_PATH@:/data"
93+
- "@CONTAINER_CONFIG_ROOT@/@IMMICH_DATA_PATH@:/data"
9494
```
9595

9696
Access the Web UI at: `http://localhost:@IMMICH_SERVER_PORT@`
@@ -100,7 +100,6 @@ Access the Web UI at: `http://localhost:@IMMICH_SERVER_PORT@`
100100
<div class="placeholder-settings-panel"></div>
101101

102102
## Parameters
103-
104103
### Environment Variables
105104

106105
| Variable | Default | Description |
@@ -113,20 +112,20 @@ Access the Web UI at: `http://localhost:@IMMICH_SERVER_PORT@`
113112
| `PUID` | `1000` | User ID for the application process |
114113
| `PGID` | `1000` | Group ID for the application process |
115114
| `TZ` | `UTC` | Timezone for the container |
116-
117115
### Volumes
118116

119117
| Path | Description |
120118
|------|-------------|
121119
| `/config` | Configuration directory (unused but mounted) |
122120
| `/data` | Media storage (photos, videos, thumbnails) |
123-
124121
### Ports
125122

126123
| Port | Protocol | Description |
127124
|------|----------|-------------|
128125
| `2283` | TCP | Web UI/API |
129126

127+
This image is part of the [Immich Stack](https://daemonless.io/images/immich).
128+
130129
!!! info "Implementation Details"
131130

132131
- **User:** `bsd` (UID/GID set via [PUID/PGID](../guides/permissions.md)). Defaults to `1000:1000`.

0 commit comments

Comments
 (0)