Skip to content

Commit

Permalink
Merge pull request #2514 from dvdksn/syntax-freshness
Browse files Browse the repository at this point in the history
docs: update deprecated/outdated compose syntax and filenames
  • Loading branch information
tianon authored Dec 6, 2024
2 parents e3ae9e0 + 9cec477 commit 2613481
Show file tree
Hide file tree
Showing 19 changed files with 103 additions and 119 deletions.
6 changes: 3 additions & 3 deletions backdrop/content.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ $ docker run --name some-%%REPO%% \
-d %%REPO%%
```

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

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

```yaml
%%REPO%%:
Expand All @@ -65,7 +65,7 @@ db:
MYSQL_DATABASE: %%REPO%%
```
Run `docker-compose up`, wait for it to initialize completely, and visit `http://localhost:8080` or `http://host-ip:8080`.
Run `docker compose up`, wait for it to initialize completely, and visit `http://localhost:8080` or `http://host-ip:8080`.

## Adding additional libraries / extensions

Expand Down
2 changes: 1 addition & 1 deletion bonita/content.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ This image is built from the following [GitHub repository](https://github.com/Bo

## %%STACK%%

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).
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).

- Replace `<hostname>` with the one used in the licence generation command
- leave double `$$` untouched
Expand Down
2 changes: 1 addition & 1 deletion cassandra/content.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,4 +114,4 @@ The `-v /my/own/datadir:/var/lib/cassandra` part of the command mounts the `/my/

## No connections until Cassandra init completes

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.
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.
6 changes: 3 additions & 3 deletions convertigo/content.md
Original file line number Diff line number Diff line change
Expand Up @@ -275,13 +275,13 @@ The default `ENABLE_JDWP_DEBUG` value is **false** and can be defined this way:
$ docker run -d –name C8O -e ENABLE_JDWP_DEBUG=true -p 28080:28080 %%IMAGE%%
```

## Pre configurated Docker compose stack
## Pre-configurated Docker Compose file

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.
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.

```console
$ mkdir c8oMBaaS
$ cd c8oMBaaS
$ wget https://raw.githubusercontent.com/convertigo/docker/master/compose/mbaas/docker-compose.yml
$ docker-compose up -d
$ docker compose up -d
```
2 changes: 1 addition & 1 deletion drupal/content.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ $ docker run --name some-%%REPO%% --network some-network -d \

## %%STACK%%

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`
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`

## Adding additional libraries / extensions

Expand Down
6 changes: 3 additions & 3 deletions eggdrop/content.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,13 +104,13 @@ to your docker run command line.

## Common Errors

# docker-compose.yml
# compose.yaml

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
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:

stdin_open: true

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

## Troubleshooting / Support

Expand Down
70 changes: 34 additions & 36 deletions emqx/content.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,53 +62,51 @@ If not specified, EMQX determines its node name based on the running environment

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

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

- Create `docker-compose.yaml`:
- Create `compose.yaml`:

```yaml
version: '3'

services:
emqx1:
image: %%IMAGE%%:latest
environment:
- "[email protected]"
- "EMQX_CLUSTER__DISCOVERY_STRATEGY=static"
- "EMQX_CLUSTER__STATIC__SEEDS=[[email protected], [email protected]]"
networks:
emqx-bridge:
aliases:
- node1.emqx.io

emqx2:
image: %%IMAGE%%:latest
environment:
- "[email protected]"
- "EMQX_CLUSTER__DISCOVERY_STRATEGY=static"
- "EMQX_CLUSTER__STATIC__SEEDS=[[email protected], [email protected]]"
networks:
emqx-bridge:
aliases:
- node2.emqx.io

networks:
emqx-bridge:
driver: bridge
services:
emqx1:
image: %%IMAGE%%:latest
environment:
- "[email protected]"
- "EMQX_CLUSTER__DISCOVERY_STRATEGY=static"
- "EMQX_CLUSTER__STATIC__SEEDS=[[email protected], [email protected]]"
networks:
emqx-bridge:
aliases:
- node1.emqx.io

emqx2:
image: %%IMAGE%%:latest
environment:
- "[email protected]"
- "EMQX_CLUSTER__DISCOVERY_STRATEGY=static"
- "EMQX_CLUSTER__STATIC__SEEDS=[[email protected], [email protected]]"
networks:
emqx-bridge:
aliases:
- node2.emqx.io

networks:
emqx-bridge:
driver: bridge
```
- Start the docker-compose cluster
- Start the Docker Compose services
```bash
docker-compose -p my_emqx up -d
docker compose -p my_emqx up -d
```

- View cluster

```bash
$ docker exec -it my_emqx_emqx1_1 sh -c "emqx ctl cluster status"
Cluster status: #{running_nodes => ['[email protected]','[email protected]'],
stopped_nodes => []}
$ docker exec -it my_emqx_emqx1_1 sh -c "emqx ctl cluster status"
Cluster status: #{running_nodes => ['[email protected]','[email protected]'],
stopped_nodes => []}
```

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

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.

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

```YAML
volumes:
Expand Down
20 changes: 7 additions & 13 deletions friendica/content.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ Now you can access the Friendica installation wizard at http://localhost:8080/ f

## Using the fpm image

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.
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.

```console
$ docker run -d %%IMAGE%%:fpm
```

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.
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.

## Background tasks

Expand Down Expand Up @@ -159,8 +159,6 @@ The Friendica image supports auto configuration via environment variables. You c
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:

```yaml
version: '3.2'

services:
db:
image: mariadb
Expand Down Expand Up @@ -220,9 +218,9 @@ Currently, this is only supported for `FRIENDICA_ADMIN_MAIL`, `MYSQL_DATABASE`,

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.

# Running this image with docker-compose
# Running this image with Docker Compose

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.
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.

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.

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

```yaml
version: '2'
services:
db:
image: mariadb
Expand Down Expand Up @@ -268,7 +264,7 @@ volumes:
friendica:
```

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

## Base version - FPM

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

- Make sure to set the variable `MYSQL_PASSWORD` and `MYSQL_USER` before you run the setup.
- 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))
- 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))

```yaml
version: '2'
services:
db:
image: mariadb
Expand Down Expand Up @@ -333,7 +327,7 @@ networks:
proxy-tier:
```

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

# Special settings for DEV/RC images

Expand Down
2 changes: 1 addition & 1 deletion geonetwork/content.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ docker run --name some-%%REPO%% -d -p 8080:8080 -e GN_CONFIG_PROPERTIES="-Dgeon

### %%STACK%%

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).
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).

### Default credentials

Expand Down
4 changes: 2 additions & 2 deletions ghost/content.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ $ docker run -d \
%%IMAGE%%:alpine
```

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).
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).

### Docker Volume

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

## %%STACK%%

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).
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).
2 changes: 1 addition & 1 deletion joomla/content.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ $ docker run --name some-%%REPO%% --network some-network -e JOOMLA_DB_HOST=10.1.

## %%STACK%%

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).
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).

## Adding additional libraries / extensions

Expand Down
4 changes: 2 additions & 2 deletions matomo/content.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,9 @@ The PHP memory limit can be configured with the following environment variable:

- `PHP_MEMORY_LIMIT`

## Docker-compose examples and log import instructions
## Docker Compose examples and log import instructions

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

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:

Expand Down
2 changes: 1 addition & 1 deletion mediawiki/content.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ $ docker run --rm %%IMAGE%% tar -cC /var/www/html/sites . | tar -xC /path/on/hos

## %%STACK%%

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).
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).

## Adding additional libraries / extensions

Expand Down
Loading

0 comments on commit 2613481

Please sign in to comment.