You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-6Lines changed: 20 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -17,17 +17,31 @@ Markdown.
17
17
18
18
## Building the site
19
19
Make sure you are in the root directory of the cloned repository.
20
-
### With `docker-compose`:
20
+
### With `Docker Compose`:
21
21
22
-
To build and view site with Docker:
22
+
You need to have [Docker Engine](https://docs.docker.com/engine/) and [Docker Compose](https://docs.docker.com/compose/) installed on your machine.
23
+
Under macOS (Intel or Apple silicon), instead of installing [Docker Desktop](https://docs.docker.com/desktop/) you can also use [HomeBrew](https://brew.sh/) with [Colima](https://github.com/abiosoft/colima): `brew install colima docker`.
24
+
UID and GID environment variables are needed to avoid docker from writing files as root in your directory.
23
25
24
-
env UID="$(id -u)" GID="$(id -g)" docker-compose up
26
+
```
27
+
env UID="$(id -u)" GID="$(id -g)" docker-compose up
28
+
```
29
+
30
+
The generated site is available at `http://localhost:4000`.
25
31
26
-
It will incrementally build and serve site at `http://localhost:4000`.
32
+
When the website dependencies change (the content of the `Gemfile`),
33
+
you have to re-build the Docker image:
34
+
35
+
```
36
+
env UID="$(id -u)" GID="$(id -g)" docker-compose up --build
37
+
```
38
+
39
+
If you have problems with the Docker image or want to force the rebuild of the Docker image:
0 commit comments