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-7Lines changed: 20 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -15,19 +15,32 @@ To build and view the site locally:
15
15
16
16
For more details, read on.
17
17
18
-
## Quickstart with Docker ##
18
+
## Quickstart with Docker Compose##
19
19
20
-
To build and view site with Docker:
20
+
You need to have [Docker Engine](https://docs.docker.com/engine/) and [Docker Compose](https://docs.docker.com/compose/) installed on your machine.
21
+
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`.
22
+
UID and GID environment variables are needed to avoid docker from writing files as root in your directory.
21
23
22
-
env UID="$(id -u)" GID="$(id -g)" docker-compose up
24
+
```
25
+
env UID="$(id -u)" GID="$(id -g)" docker-compose up
26
+
```
23
27
24
-
It will incrementally build and serve site at `http://localhost:4000`.
28
+
The generated site is available at `http://localhost:4000`.
25
29
26
-
In case the Dockerfile changed, re-build it with:
30
+
When the website dependencies change (the content of the `Gemfile`),
31
+
you have to re-build the Docker image:
27
32
28
-
env UID="$(id -u)" GID="$(id -g)" docker-compose up --build
33
+
```
34
+
env UID="$(id -u)" GID="$(id -g)" docker-compose up --build
35
+
```
29
36
30
-
For more details on the Docker option, see [this issue](https://github.com/scala/docs.scala-lang/issues/1286).
37
+
If you have problems with the Docker image or want to force the rebuild of the Docker image:
0 commit comments