1
- LinuxFr on Docker
2
- -----------------
1
+ LinuxFr with Containers
2
+ -----------------------
3
3
4
4
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.
6
7
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.
9
22
10
23
To init the SQL database schema, you need to wait upto the ` database `
11
24
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.
68
81
Test modifications
69
82
==================
70
83
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.
73
86
74
87
So you can update files with your prefered IDE on your machine. Rails
75
88
will directly detect changes and apply them on next page reload.
@@ -95,7 +108,7 @@ To get help about writing tests, see the
95
108
[ Ruby on Rails documentation] ( https://guides.rubyonrails.org/testing.html#the-rails-test-runner )
96
109
.
97
110
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:
99
112
100
113
```
101
114
docker compose exec linuxfr.org bin/rails test -v
@@ -128,10 +141,10 @@ use:
128
141
docker compose exec linuxfr.org bin/rails db:reset
129
142
```
130
143
131
- Services provided by the docker compose
144
+ Services provided by the compose file
132
145
=======================================
133
146
134
- Currently, these services are directly enabled by docker compose:
147
+ Currently, these services are directly enabled by compose:
135
148
136
149
1 . The [ LinuxFr.org] ( https://github.com/linuxfrorg/linuxfr.org )
137
150
ruby on rails application itself
0 commit comments