Skip to content

Commit 2f5742a

Browse files
committed
use container engine agnostic file names as it works with Docker and Podman
1 parent 67e668b commit 2f5742a

File tree

7 files changed

+28
-15
lines changed

7 files changed

+28
-15
lines changed

Docker.md renamed to Container.md

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,24 @@
1-
LinuxFr on Docker
2-
-----------------
1+
LinuxFr with Containers
2+
-----------------------
33

44
To simplify set up of a developement environment, LinuxFr.org can be
5-
run on Docker with `docker compose up`.
5+
run with a container engine like Docker or Podman with the [`compose.yml`](./compose.yaml)
6+
file which describes how to build all needed services.
67

7-
Note: you need to enable the Docker BuildKit builder. Either you have a Docker
8-
version which uses it by default, or you set the environment variable `export DOCKER_BUILDKIT=1`.
8+
If you use the Docker engine, you can use the `docker compose up` command to start the system (you
9+
need to install the [Docker compose plugin](https://docs.docker.com/compose/)).
10+
11+
> Note: with the Docker engine, you need to enable the Docker BuildKit builder.
12+
> Either you have a Docker version which uses it by default, or you set the
13+
> environment variable `export DOCKER_BUILDKIT=1`.
14+
15+
If you use Podman, you can either use the same Docker compose plugin or the
16+
[podman-compose](https://github.com/containers/podman-compose/)
17+
utility. The podman cli itself provide a wrapper of one of these two tools through the
18+
[`podman compose` command](https://docs.podman.io/en/latest/markdown/podman-compose.1.html).
19+
20+
At this point, the documentation will give you `docker compose` commands, but you should be able
21+
to use `podman compose` without any issue.
922

1023
To init the SQL database schema, you need to wait upto the `database`
1124
container to be ready to listen MySQL connections.
@@ -68,8 +81,8 @@ service won't work well and so you won't be able to see images in the news.
6881
Test modifications
6982
==================
7083

71-
The docker compose is currently configured to share `./app`, `./db` and
72-
`./public` directories with the docker container.
84+
The compose file currently shares `./app`, `./db` and
85+
`./public` directories with the container.
7386

7487
So you can update files with your prefered IDE on your machine. Rails
7588
will directly detect changes and apply them on next page reload.
@@ -95,7 +108,7 @@ To get help about writing tests, see the
95108
[Ruby on Rails documentation](https://guides.rubyonrails.org/testing.html#the-rails-test-runner)
96109
.
97110

98-
To run tests with Docker environment, you need to use this command:
111+
To run tests with containers, you need to use this command:
99112

100113
```
101114
docker compose exec linuxfr.org bin/rails test -v
@@ -128,10 +141,10 @@ use:
128141
docker compose exec linuxfr.org bin/rails db:reset
129142
```
130143

131-
Services provided by the docker compose
144+
Services provided by the compose file
132145
=======================================
133146

134-
Currently, these services are directly enabled by docker compose:
147+
Currently, these services are directly enabled by compose:
135148

136149
1. The [LinuxFr.org](https://github.com/linuxfrorg/linuxfr.org)
137150
ruby on rails application itself

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ Install
1212

1313
See [INSTALL.md](INSTALL.md) to set up LinuxFr.org on a Debian environment.
1414

15-
Alternatively, you can read [Docker.md](Docker.md) to setup easily
16-
LinuxFr.org development environment with the Docker engine and
17-
[docker-compose](https://docs.docker.com/compose/).
15+
Alternatively, you can read [Container.md](Container.md) to setup easily
16+
LinuxFr.org development environment with a container engine like Docker or
17+
Podman and use the [container composer](https://docs.docker.com/compose/).
1818

1919
See also
2020
--------

docker-compose.yaml renamed to compose.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ services:
22
linuxfr.org:
33
build:
44
context: .
5-
dockerfile: deployment/linuxfr.org/Dockerfile
5+
dockerfile: deployment/linuxfr.org/Containerfile
66
env_file:
77
- deployment/default.env
88
volumes:
File renamed without changes.
File renamed without changes.
File renamed without changes.

deployment/linuxfr.org/Dockerfile renamed to deployment/linuxfr.org/Containerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ FROM docker.io/debian:bookworm-slim
33
LABEL org.opencontainers.image.title="LinuxFr.org website"
44
LABEL org.opencontainers.image.description="Run LinuxFr.org Ruby on Rails website"
55
LABEL org.opencontainers.image.source="https://github.com/linuxfrorg/linuxfr.org"
6-
LABEL org.opencontainers.image.url="https://github.com/linuxfrorg/linuxfr.org/blob/master/Docker.md"
6+
LABEL org.opencontainers.image.url="https://github.com/linuxfrorg/linuxfr.org/blob/master/Container.md"
77
LABEL org.opencontainers.image.licenses="AGPL-3.0-only"
88
LABEL org.opencontainers.image.version="rails7-bookworm"
99
LABEL org.opencontainers.image.authors="Adrien Dorsaz <[email protected]>"

0 commit comments

Comments
 (0)