Skip to content

Commit c0da39c

Browse files
rm3lbenwilcock
andauthored
docs: include docker commands alongside the podman ones (#153)
Co-authored-by: Ben Wilcock <benwilcock@gmail.com> Assisted-by: Cursor
1 parent c43e745 commit c0da39c

10 files changed

Lines changed: 374 additions & 173 deletions

docs/rhdh-local-guide/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Common variables to customize:
6262

6363
After making configuration changes:
6464

65-
=== "Podman (Recommended)"
65+
=== "Podman"
6666
```bash
6767
# For app-config changes
6868
podman compose restart rhdh

docs/rhdh-local-guide/corporate-proxy-setup-sim.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
11
If you want to test how RHDH would behave if deployed in a corporate proxy environment,
22
you can run `podman compose` or `docker compose` by merging both the [`compose.yaml`](https://github.com/redhat-developer/rhdh-local/blob/main/compose.yaml) and [`compose-with-corporate-proxy.yaml`](https://github.com/redhat-developer/rhdh-local/blob/main/compose-with-corporate-proxy.yaml) files.
33

4-
Example with `podman compose` (note that the order of the YAML files is important):
4+
Note that the order of the YAML files is important:
55

6-
```bash
7-
podman compose -f compose.yaml -f compose-with-corporate-proxy.yaml up -d
8-
```
6+
=== "Podman"
7+
```bash
8+
podman compose -f compose.yaml -f compose-with-corporate-proxy.yaml up -d
9+
```
10+
11+
=== "Docker"
12+
```bash
13+
docker compose -f compose.yaml -f compose-with-corporate-proxy.yaml up -d
14+
```
915

1016
The [`compose-with-corporate-proxy.yaml`](https://github.com/redhat-developer/rhdh-local/blob/main/compose-with-corporate-proxy.yaml) file includes a specific [Squid](https://www.squid-cache.org/)-based proxy container as well as an isolated network, such that:
1117

docs/rhdh-local-guide/dynamic-plugins-management.md

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Without a restart, your changes won't take effect because the running instance i
2121

2222
After making plugin changes through the UI, restart your local instance with these commands:
2323

24-
=== "Podman (Recommended)"
24+
=== "Podman"
2525
```bash
2626
# Reinstall plugins and restart RHDH
2727
podman compose run install-dynamic-plugins
@@ -37,7 +37,7 @@ After making plugin changes through the UI, restart your local instance with the
3737

3838
This process typically may take a few minutes. You can monitor the startup progress in the container logs:
3939

40-
=== "Podman (Recommended)"
40+
=== "Podman"
4141
```bash
4242
podman compose logs -f rhdh
4343
```
@@ -201,23 +201,35 @@ podman run --rm -it \
201201
202202
### Managing Plugin Cache
203203
204-
```bash
205-
# Clear plugin cache (rebuilds all plugins)
206-
podman compose down --volumes
207-
podman compose up -d
204+
=== "Podman"
205+
```bash
206+
# Clear plugin cache (rebuilds all plugins)
207+
podman compose down --volumes
208+
podman compose up -d
208209
209-
# Reinstall plugins without clearing other data
210-
podman compose run install-dynamic-plugins
211-
podman compose restart rhdh
212-
```
210+
# Reinstall plugins without clearing other data
211+
podman compose run install-dynamic-plugins
212+
podman compose restart rhdh
213+
```
214+
215+
=== "Docker"
216+
```bash
217+
# Clear plugin cache (rebuilds all plugins)
218+
docker compose down --volumes
219+
docker compose up -d
220+
221+
# Reinstall plugins without clearing other data
222+
docker compose run install-dynamic-plugins
223+
docker compose restart rhdh
224+
```
213225
214226
## Applying Plugin Changes
215227
216228
### Standard Plugin Changes
217229
218230
After modifying the plugin configuration, for example after configuring plugins using the Extensions in the RHDH UI:
219231
220-
=== "Podman (Recommended)"
232+
=== "Podman"
221233
```bash
222234
# Reinstall plugins and restart RHDH
223235
podman compose run install-dynamic-plugins
@@ -235,7 +247,7 @@ After modifying the plugin configuration, for example after configuring plugins
235247
236248
For configuration-only changes:
237249
238-
=== "Podman (Recommended)"
250+
=== "Podman"
239251
```bash
240252
# Just restart RHDH (if plugins haven't changed)
241253
podman compose restart rhdh

docs/rhdh-local-guide/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ You can optionally customize the application configuration and dynamic plugins t
4343

4444
Pick your container engine and run:
4545

46-
=== "Podman (Recommended)"
46+
=== "Podman"
4747
```bash
4848
podman compose up -d
4949
```
@@ -85,6 +85,6 @@ Now that RHDH Local is running, explore these areas:
8585

8686
If you encounter issues:
8787

88-
1. Review container logs: `podman compose logs`
88+
1. Review container logs: `podman compose logs` (or `docker compose logs`)
8989
2. Verify prerequisites and configuration syntax
9090
3. Visit [Help & Contributing](help-and-contrib.md) for support options

docs/rhdh-local-guide/github-auth.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ catalog:
107107
108108
Apply your authentication changes:
109109
110-
=== "Podman (Recommended)"
110+
=== "Podman"
111111
```bash
112112
podman compose up -d --force-recreate
113113
```
@@ -121,10 +121,17 @@ Apply your authentication changes:
121121

122122
Check that RHDH Local starts successfully with GitHub authentication:
123123

124-
```bash
125-
# Monitor startup logs
126-
podman compose logs -f rhdh
127-
```
124+
=== "Podman"
125+
```bash
126+
# Monitor startup logs
127+
podman compose logs -f rhdh
128+
```
129+
130+
=== "Docker"
131+
```bash
132+
# Monitor startup logs
133+
docker compose logs -f rhdh
134+
```
128135

129136
Then try to login using GitHub.
130137

docs/rhdh-local-guide/help-and-contrib.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Use [JIRA (Component: RHDH Local)](https://issues.redhat.com/browse/RHIDP) for:
4646
4. [Expected Result]
4747

4848
**Logs and Configuration:**
49-
[Relevant logs from `podman compose logs`]
49+
[Relevant logs from `podman compose logs` or `docker compose logs`]
5050
[Configuration snippets (remove sensitive data)]
5151
[Screenshots if applicable]
5252

docs/rhdh-local-guide/loading-content.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ As long as you create those files, they will be automatically registered in the
3434
After modifying `app-config.local.yaml`:
3535

3636

37-
=== "Podman (Recommended)"
37+
=== "Podman"
3838
```bash
3939
# Restart RHDH to load new configuration
4040
podman compose restart rhdh

0 commit comments

Comments
 (0)