Skip to content

Commit 9cec477

Browse files
committed
docs: update deprecated/outdated compose syntax and filenames
Signed-off-by: David Karlsson <[email protected]>
1 parent a5e63d9 commit 9cec477

File tree

19 files changed

+103
-119
lines changed

19 files changed

+103
-119
lines changed

backdrop/content.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ $ docker run --name some-%%REPO%% \
4444
-d %%REPO%%
4545
```
4646

47-
## ... via [`docker-compose`](https://github.com/docker/compose)
47+
## ... via [Docker Compose](https://github.com/docker/compose)
4848

49-
Example `docker-compose.yml` for `%%REPO%%`:
49+
Example `compose.yaml` for `%%REPO%%`:
5050

5151
```yaml
5252
%%REPO%%:
@@ -65,7 +65,7 @@ db:
6565
MYSQL_DATABASE: %%REPO%%
6666
```
6767
68-
Run `docker-compose up`, wait for it to initialize completely, and visit `http://localhost:8080` or `http://host-ip:8080`.
68+
Run `docker compose up`, wait for it to initialize completely, and visit `http://localhost:8080` or `http://host-ip:8080`.
6969

7070
## Adding additional libraries / extensions
7171

bonita/content.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ This image is built from the following [GitHub repository](https://github.com/Bo
3838

3939
## %%STACK%%
4040

41-
Run `docker stack deploy -c stack.yml %%REPO%%` (or `docker-compose -f stack.yml up`), wait for it to initialize completely, and visit `http://swarm-ip:8080`, `http://localhost:8080`, or `http://host-ip:8080` (as appropriate).
41+
Run `docker stack deploy -c stack.yml %%REPO%%` (or `docker compose -f stack.yml up`), wait for it to initialize completely, and visit `http://swarm-ip:8080`, `http://localhost:8080`, or `http://host-ip:8080` (as appropriate).
4242

4343
- Replace `<hostname>` with the one used in the licence generation command
4444
- leave double `$$` untouched

cassandra/content.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -114,4 +114,4 @@ The `-v /my/own/datadir:/var/lib/cassandra` part of the command mounts the `/my/
114114

115115
## No connections until Cassandra init completes
116116

117-
If there is no database initialized when the container starts, then a default database will be created. While this is the expected behavior, this means that it will not accept incoming connections until such initialization completes. This may cause issues when using automation tools, such as `docker-compose`, which start several containers simultaneously.
117+
If there is no database initialized when the container starts, then a default database will be created. While this is the expected behavior, this means that it will not accept incoming connections until such initialization completes. This may cause issues when using automation tools, such as Docker Compose, which start several containers simultaneously.

convertigo/content.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -275,13 +275,13 @@ The default `ENABLE_JDWP_DEBUG` value is **false** and can be defined this way:
275275
$ docker run -d –name C8O -e ENABLE_JDWP_DEBUG=true -p 28080:28080 %%IMAGE%%
276276
```
277277

278-
## Pre configurated Docker compose stack
278+
## Pre-configurated Docker Compose file
279279

280-
You can use this [stack](https://github.com/convertigo/docker/blob/master/compose/mbaas/docker-compose.yml) to run a complete Convertigo Low Code server with FullSync repository and MySQL analytics in a few command lines.
280+
You can use [this Docker Compose file](https://github.com/convertigo/docker/blob/master/compose/mbaas/docker-compose.yml) to run a complete Convertigo Low Code server with FullSync repository and MySQL analytics in a few command lines.
281281

282282
```console
283283
$ mkdir c8oMBaaS
284284
$ cd c8oMBaaS
285285
$ wget https://raw.githubusercontent.com/convertigo/docker/master/compose/mbaas/docker-compose.yml
286-
$ docker-compose up -d
286+
$ docker compose up -d
287287
```

drupal/content.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ $ docker run --name some-%%REPO%% --network some-network -d \
100100

101101
## %%STACK%%
102102

103-
Run `docker stack deploy -c stack.yml %%REPO%%` (or `docker-compose -f stack.yml up`), wait for it to initialize completely, and visit `http://swarm-ip:8080`, `http://localhost:8080`, or `http://host-ip:8080` (as appropriate). When installing select `postgres` as database with the following parameters: `dbname=postgres` `user=postgres` `pass=example` `hostname=postgres`
103+
Run `docker stack deploy -c stack.yml %%REPO%%` (or `docker compose -f stack.yml up`), wait for it to initialize completely, and visit `http://swarm-ip:8080`, `http://localhost:8080`, or `http://host-ip:8080` (as appropriate). When installing select `postgres` as database with the following parameters: `dbname=postgres` `user=postgres` `pass=example` `hostname=postgres`
104104

105105
## Adding additional libraries / extensions
106106

eggdrop/content.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -104,13 +104,13 @@ to your docker run command line.
104104

105105
## Common Errors
106106

107-
# docker-compose.yml
107+
# compose.yaml
108108

109-
A docker-compose.yml example is hosted at https://github.com/eggheads/eggdrop-docker/blob/master/docker-compose.yml . A common error creating your own docker-compose.yml file from scratch is not adding
109+
A `docker-compose.yml` example is hosted at https://github.com/eggheads/eggdrop-docker/blob/master/docker-compose.yml. A common error creating your own Docker Compose file from scratch is not adding:
110110

111111
stdin_open: true
112112

113-
to the docker-compose.yml file. Without it, Eggdrop will give you an "END OF FILE ON TERMINAL" error and not start.
113+
Without it, Eggdrop will give you an "END OF FILE ON TERMINAL" error and not start.
114114

115115
## Troubleshooting / Support
116116

emqx/content.md

+34-36
Original file line numberDiff line numberDiff line change
@@ -62,53 +62,51 @@ If not specified, EMQX determines its node name based on the running environment
6262

6363
EMQX supports a variety of clustering methods, see our [documentation](https://docs.emqx.com/en/emqx/latest/deploy/cluster/create-cluster.html) for details.
6464

65-
Let's create a static node list cluster from docker-compose.
65+
Let's create a static node list cluster from Docker Compose.
6666

67-
- Create `docker-compose.yaml`:
67+
- Create `compose.yaml`:
6868

6969
```yaml
70-
version: '3'
71-
72-
services:
73-
emqx1:
74-
image: %%IMAGE%%:latest
75-
environment:
76-
77-
- "EMQX_CLUSTER__DISCOVERY_STRATEGY=static"
78-
- "EMQX_CLUSTER__STATIC__SEEDS=[[email protected], [email protected]]"
79-
networks:
80-
emqx-bridge:
81-
aliases:
82-
- node1.emqx.io
83-
84-
emqx2:
85-
image: %%IMAGE%%:latest
86-
environment:
87-
88-
- "EMQX_CLUSTER__DISCOVERY_STRATEGY=static"
89-
- "EMQX_CLUSTER__STATIC__SEEDS=[[email protected], [email protected]]"
90-
networks:
91-
emqx-bridge:
92-
aliases:
93-
- node2.emqx.io
94-
95-
networks:
96-
emqx-bridge:
97-
driver: bridge
70+
services:
71+
emqx1:
72+
image: %%IMAGE%%:latest
73+
environment:
74+
75+
- "EMQX_CLUSTER__DISCOVERY_STRATEGY=static"
76+
- "EMQX_CLUSTER__STATIC__SEEDS=[[email protected], [email protected]]"
77+
networks:
78+
emqx-bridge:
79+
aliases:
80+
- node1.emqx.io
81+
82+
emqx2:
83+
image: %%IMAGE%%:latest
84+
environment:
85+
86+
- "EMQX_CLUSTER__DISCOVERY_STRATEGY=static"
87+
- "EMQX_CLUSTER__STATIC__SEEDS=[[email protected], [email protected]]"
88+
networks:
89+
emqx-bridge:
90+
aliases:
91+
- node2.emqx.io
92+
93+
networks:
94+
emqx-bridge:
95+
driver: bridge
9896
```
9997
100-
- Start the docker-compose cluster
98+
- Start the Docker Compose services
10199
102100
```bash
103-
docker-compose -p my_emqx up -d
101+
docker compose -p my_emqx up -d
104102
```
105103

106104
- View cluster
107105

108106
```bash
109-
$ docker exec -it my_emqx_emqx1_1 sh -c "emqx ctl cluster status"
110-
Cluster status: #{running_nodes => ['[email protected]','[email protected]'],
111-
stopped_nodes => []}
107+
$ docker exec -it my_emqx_emqx1_1 sh -c "emqx ctl cluster status"
108+
Cluster status: #{running_nodes => ['[email protected]','[email protected]'],
109+
stopped_nodes => []}
112110
```
113111

114112
### Persistence
@@ -120,7 +118,7 @@ If you want to persist the EMQX docker container, you need to keep the following
120118

121119
Since data in these folders are partially stored under the `/opt/emqx/data/mnesia/${node_name}`, the user also needs to reuse the same node name to see the previous state. To make this work, one needs to set the host part of `EMQX_NODE__NAME` to something static that does not change when you restart or recreate the container. It could be container name, hostname or loopback IP address `127.0.0.1` if you only have one node.
122120

123-
In if you use docker-compose, the configuration would look something like this:
121+
In if you use Docker Compose, the configuration would look something like this:
124122

125123
```YAML
126124
volumes:

friendica/content.md

+7-13
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ Now you can access the Friendica installation wizard at http://localhost:8080/ f
2828

2929
## Using the fpm image
3030

31-
To use the fpm image you need an additional web server that can proxy http-request to the fpm-port of the container. For fpm connection this container exposes port 9000. In most cases you might want use another container or your host as proxy. If you use your host you can address your Friendica container directly on port 9000. If you use another container, make sure that you add them to the same docker network (via `docker run --network <NAME> ...` or a `docker-compose` file). In both cases you don't want to map the fpm port to you host.
31+
To use the fpm image you need an additional web server that can proxy http-request to the fpm-port of the container. For fpm connection this container exposes port 9000. In most cases you might want use another container or your host as proxy. If you use your host you can address your Friendica container directly on port 9000. If you use another container, make sure that you add them to the same docker network (via `docker run --network <NAME> ...` or a `compose.yaml` file). In both cases you don't want to map the fpm port to you host.
3232

3333
```console
3434
$ docker run -d %%IMAGE%%:fpm
3535
```
3636

37-
As the fastCGI-Process is not capable of serving static files (style sheets, images, ...) the webserver needs access to these files. This can be achieved with the `volumes-from` option. You can find more information in the docker-compose section.
37+
As the fastCGI-Process is not capable of serving static files (style sheets, images, ...) the webserver needs access to these files. This can be achieved with the `volumes-from` option. You can find more information in the Docker Compose section.
3838

3939
## Background tasks
4040

@@ -159,8 +159,6 @@ The Friendica image supports auto configuration via environment variables. You c
159159
As an alternative to passing sensitive information via environment variables, _FILE may be appended to the previously listed environment variables, causing the initialization script to load the values for those variables from files present in the container. In particular, this can be used to load passwords from Docker secrets stored in /run/secrets/<secret_name> files. For example:
160160

161161
```yaml
162-
version: '3.2'
163-
164162
services:
165163
db:
166164
image: mariadb
@@ -220,9 +218,9 @@ Currently, this is only supported for `FRIENDICA_ADMIN_MAIL`, `MYSQL_DATABASE`,
220218

221219
You have to pull the latest image from the hub (`docker pull %%IMAGE%%`). The stable branch gets checked at every startup and will get updated if no installation was found or a new image is used.
222220

223-
# Running this image with docker-compose
221+
# Running this image with Docker Compose
224222

225-
The easiest way to get a fully featured and functional setup is using a `docker-compose` file. There are too many different possibilities to setup your system, so here are only some examples what you have to look for.
223+
The easiest way to get a fully featured and functional setup is using a `compose.yaml` file. There are too many different possibilities to setup your system, so here are only some examples what you have to look for.
226224

227225
At first make sure you have chosen the right base image (fpm or apache) and added the features you wanted (see below). In every case you want to add a database container and docker volumes to get easy access to your persistent data. When you want your server reachable from the internet adding HTTPS-encryption is mandatory! See below for more information.
228226

@@ -233,8 +231,6 @@ This version will use the apache image and add a mariaDB container. The volumes
233231
Make sure to set the variable `MYSQL_PASSWORD` before run this setup.
234232

235233
```yaml
236-
version: '2'
237-
238234
services:
239235
db:
240236
image: mariadb
@@ -268,7 +264,7 @@ volumes:
268264
friendica:
269265
```
270266

271-
Then run `docker-compose up -d`, now you can access Friendica at http://localhost:8080/ from your system.
267+
Then run `docker compose up -d`, now you can access Friendica at http://localhost:8080/ from your system.
272268

273269
## Base version - FPM
274270

@@ -281,11 +277,9 @@ As this setup does **not include encryption** it should to be run behind a proxy
281277
Prerequisites for this example:
282278

283279
- Make sure to set the variable `MYSQL_PASSWORD` and `MYSQL_USER` before you run the setup.
284-
- Create a `nginx.conf` in the same directory as the docker-compose.yml file (take it from [example](https://github.com/friendica/docker/tree/master/.examples/docker-compose/with-traefik-proxy/mariadb-cron-smtp/fpm/web/nginx.conf))
280+
- Create a `nginx.conf` in the same directory as the `compose.yaml` file (take it from [example](https://github.com/friendica/docker/tree/master/.examples/docker-compose/with-traefik-proxy/mariadb-cron-smtp/fpm/web/nginx.conf))
285281

286282
```yaml
287-
version: '2'
288-
289283
services:
290284
db:
291285
image: mariadb
@@ -333,7 +327,7 @@ networks:
333327
proxy-tier:
334328
```
335329

336-
Then run `docker-compose up -d`, now you can access Friendica at http://localhost:8080/ from your system.
330+
Then run `docker compose up -d`, now you can access Friendica at http://localhost:8080/ from your system.
337331

338332
# Special settings for DEV/RC images
339333

geonetwork/content.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ docker run --name some-%%REPO%% -d -p 8080:8080 -e GN_CONFIG_PROPERTIES="-Dgeon
164164

165165
### %%STACK%%
166166

167-
Run `docker stack deploy -c stack.yml %%REPO%%` (or `docker-compose -f stack.yml up`), wait for it to initialize completely, and visit `http://swarm-ip:8080/geonetwork`, `http://localhost:8080/geonetwork`, or `http://host-ip:8080/geonetwork` (as appropriate).
167+
Run `docker stack deploy -c stack.yml %%REPO%%` (or `docker compose -f stack.yml up`), wait for it to initialize completely, and visit `http://swarm-ip:8080/geonetwork`, `http://localhost:8080/geonetwork`, or `http://host-ip:8080/geonetwork` (as appropriate).
168168

169169
### Default credentials
170170

ghost/content.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ $ docker run -d \
4444
%%IMAGE%%:alpine
4545
```
4646

47-
Note: `database__connection__filename` is only valid in development mode and is the location for the SQLite database file. If using development mode, it should be set to a writeable path within a persistent folder (bind mount or volume). It is not available in production mode because an external MySQL server is required (see the `docker-compose` example below).
47+
Note: `database__connection__filename` is only valid in development mode and is the location for the SQLite database file. If using development mode, it should be set to a writeable path within a persistent folder (bind mount or volume). It is not available in production mode because an external MySQL server is required (see the Docker Compose example below).
4848

4949
### Docker Volume
5050

@@ -91,4 +91,4 @@ The following example demonstrates some of the necessary configuration for runni
9191

9292
## %%STACK%%
9393

94-
Run `docker stack deploy -c stack.yml %%REPO%%` (or `docker-compose -f stack.yml up`), wait for it to initialize completely, and visit `http://swarm-ip:8080`, `http://localhost:8080`, or `http://host-ip:8080` (as appropriate).
94+
Run `docker stack deploy -c stack.yml %%REPO%%` (or `docker compose -f stack.yml up`), wait for it to initialize completely, and visit `http://swarm-ip:8080`, `http://localhost:8080`, or `http://host-ip:8080` (as appropriate).

joomla/content.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ $ docker run --name some-%%REPO%% --network some-network -e JOOMLA_DB_HOST=10.1.
5252

5353
## %%STACK%%
5454

55-
Run `docker stack deploy -c stack.yml %%REPO%%` (or `docker-compose -f stack.yml up`), wait for it to initialize completely, and visit `http://swarm-ip:8080`, `http://localhost:8080`, or `http://host-ip:8080` (as appropriate).
55+
Run `docker stack deploy -c stack.yml %%REPO%%` (or `docker compose -f stack.yml up`), wait for it to initialize completely, and visit `http://swarm-ip:8080`, `http://localhost:8080`, or `http://host-ip:8080` (as appropriate).
5656

5757
## Adding additional libraries / extensions
5858

matomo/content.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,9 @@ The PHP memory limit can be configured with the following environment variable:
5454

5555
- `PHP_MEMORY_LIMIT`
5656

57-
## Docker-compose examples and log import instructions
57+
## Docker Compose examples and log import instructions
5858

59-
A minimal set-up using docker-compose is available in the [.examples folder](%%GITHUB-REPO%%/tree/master/.examples).
59+
A minimal set-up using Docker Compose is available in the [.examples folder](%%GITHUB-REPO%%/tree/master/.examples).
6060

6161
If you want to use the import logs script, you can then run the following container as needed, in order to execute the python import logs script:
6262

mediawiki/content.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ $ docker run --rm %%IMAGE%% tar -cC /var/www/html/sites . | tar -xC /path/on/hos
4848

4949
## %%STACK%%
5050

51-
Run `docker stack deploy -c stack.yml %%REPO%%` (or `docker-compose -f stack.yml up`), wait for it to initialize completely, and visit `http://swarm-ip:8080`, `http://localhost:8080`, or `http://host-ip:8080` (as appropriate).
51+
Run `docker stack deploy -c stack.yml %%REPO%%` (or `docker compose -f stack.yml up`), wait for it to initialize completely, and visit `http://swarm-ip:8080`, `http://localhost:8080`, or `http://host-ip:8080` (as appropriate).
5252

5353
## Adding additional libraries / extensions
5454

0 commit comments

Comments
 (0)