Skip to content

Commit b249a6f

Browse files
committed
📖 Use docker compose Instead of docker-compose
Signed-off-by: Pascal Marco Caversaccio <pascal.caversaccio@hotmail.ch>
1 parent e4f4c87 commit b249a6f

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -212,14 +212,14 @@ Make sure to replace `BASH_PATH` with the actual path you retrieved in step 1.
212212
Using [Docker](https://www.docker.com), you can run the [script](./safe_hashes.sh) in a containerised environment with all dependencies pre-installed. This is useful if you do not wish to install the required tools locally, or if you are on a system where installation is difficult.
213213

214214
> [!TIP]
215-
> The [Docker](https://www.docker.com) setup can also be used with [Podman](https://podman.io) by simply replacing `docker-compose` with [`podman-compose`](https://github.com/containers/podman-compose) in the commands. On Windows and macOS, you may need to disable or override the [`AppArmor`](https://apparmor.net) security option in the [`compose.yaml`](./compose.yaml) file, as it is only supported on Linux environments. [Docker](https://www.docker.com) typically ignores unsupported security options like [`AppArmor`](https://apparmor.net) on non-Linux systems, but [Podman](https://podman.io) will fail when encountering them.
215+
> The [Docker](https://www.docker.com) setup can also be used with [Podman](https://podman.io) by simply replacing `docker compose` with [`podman-compose`](https://github.com/containers/podman-compose) in the commands. On Windows and macOS, you may need to disable or override the [`AppArmor`](https://apparmor.net) security option in the [`compose.yaml`](./compose.yaml) file, as it is only supported on Linux environments. [Docker](https://www.docker.com) typically ignores unsupported security options like [`AppArmor`](https://apparmor.net) on non-Linux systems, but [Podman](https://podman.io) will fail when encountering them.
216216
217217
#### Building the Docker Image
218218

219219
Build the [Docker](https://www.docker.com) image using [Docker Compose](https://docs.docker.com/compose/):
220220

221221
```console
222-
docker-compose build
222+
docker compose build
223223
```
224224

225225
#### Basic Usage
@@ -229,13 +229,13 @@ To run the [script](./safe_hashes.sh) using [Docker Compose](https://docs.docker
229229
Example displaying help:
230230

231231
```console
232-
docker-compose run --rm safe-tx-hashes-util --help
232+
docker compose run --rm safe-tx-hashes-util --help
233233
```
234234

235235
Example calculating the Safe transaction hashes:
236236

237237
```console
238-
docker-compose run --rm safe-tx-hashes-util --network arbitrum --address 0x111CEEee040739fD91D29C34C33E6B3E112F2177 --nonce 234
238+
docker compose run --rm safe-tx-hashes-util --network arbitrum --address 0x111CEEee040739fD91D29C34C33E6B3E112F2177 --nonce 234
239239
```
240240

241241
#### Using Message Files
@@ -248,7 +248,7 @@ When calculating off-chain message hashes, you need to provide a local directory
248248
~$ echo "Your message content here" > data/message.txt
249249

250250
# Run the container with the mounted directory.
251-
~$ docker-compose run --rm safe-tx-hashes-util \
251+
~$ docker compose run --rm safe-tx-hashes-util \
252252
--network sepolia \
253253
--address 0x657ff0D4eC65D82b2bC1247b0a558bcd2f80A0f1 \
254254
--message /data/message.txt
@@ -260,7 +260,7 @@ You can pass environment variables directly via [Docker Compose](https://docs.do
260260

261261
```console
262262
# Disable all formatting.
263-
docker-compose run --rm -e NO_COLOR=true safe-tx-hashes-util \
263+
docker compose run --rm -e NO_COLOR=true safe-tx-hashes-util \
264264
--network arbitrum \
265265
--address 0x111CEEee040739fD91D29C34C33E6B3E112F2177 \
266266
--nonce 234

0 commit comments

Comments
 (0)