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: examples/bbblb-compose/README.md
+9-10Lines changed: 9 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,10 @@
1
1
# BBBLB Docker Compose Example
2
2
3
-
This example project shows how to deploy the BBBLB application using Docker Compose.
3
+
This example shows how to deploy the BBBLB application using Docker Compose.
4
4
5
5
## Prerequisites
6
6
7
-
Before we begin, ensure you have [Docker](https://docs.docker.com/engine/install/) instaleld and also the `docker-compose-plugin` package that comes with it. Do not use the legacy `docher-compose` command, but the `docker compose` plugin.
7
+
Before we begin, ensure you have [Docker](https://docs.docker.com/engine/install/) instaleld and also the `docker-compose-plugin` package that comes with it. Do not use the legacy `docker-compose` command, but the `docker compose` plugin.
8
8
9
9
## Getting Started
10
10
@@ -22,9 +22,9 @@ Before we begin, ensure you have [Docker](https://docs.docker.com/engine/install
22
22
You can delete the cloned repository afterwards, we do not need it.
23
23
24
24
2. **Read, understand and customize `docker-compose.yml`**
25
-
The typical deployment needs three containers: `caddy` to automatically handle SSL/TLS and serve static files, `postgres` as a database, and `bbblb` itself. Read the entire file and try to understand it. Follow the comments.
25
+
The typical deployment needs three containers: `caddy` to handle SSL/TLS and serve static files, `postgres` as a database, and `bbblb` itself. Read the entire file and try to understand it. Follow the comments.
26
26
27
-
The default settings will store any persistant data in the `./data/` host folder, so you will end up with a neat and self-contained deployment with everything in one directory. I strongly prefer this over docker volumes.
27
+
The default settings will store any persistent data in the `./data/` host folder, so you will end up with a neat and self-contained deployment with everything in one directory.
28
28
29
29
You can of cause run the http server or database outside of docker or even on a different server if you prefer, but that's usually only required for *really* large deployments or if you need redundancy. That's out of scope for a simple example.
30
30
@@ -34,20 +34,19 @@ Before we begin, ensure you have [Docker](https://docs.docker.com/engine/install
34
34
Do not change `PATH_DATA` or `DB`fornow. Both are overriddenin the `docker-compose.yml` file because they need to match other parts of the compose file.
35
35
36
36
4. **Configure Caddy:**
37
-
Open `./caddy/Caddyfile`in an editor and change the domains Caddy should listen to. You may also want to have a look at the rest of the file and
38
-
tweak ot to your needs.
37
+
Open `./caddy/Caddyfile`in an editor and change the domains Caddy should listen to. You may also want to have a look at the rest of the file and tweak it to your needs.
39
38
40
39
## Starting the Services
41
40
42
-
If you followed all the previous steps, navigate to the directory containing the `docker-compose.yml`, then run:
41
+
After you followed all the previous steps, navigate to the directory containing the `docker-compose.yml`, then run:
43
42
44
43
```bash
45
44
docker compose up --build -d
46
45
```
47
46
48
-
*`docker compose up`: Starts the services defined in`docker-compose.yml`.
49
-
*`--build`: Builds or re-builds missing images. You can skip this step if you do not want to update caddy or bbblb.
50
-
*`-d`: Runs the containers in detached mode (in the background).
47
+
*`docker compose up`: Starts the services defined in`docker-compose.yml`.
48
+
*`--build`: Builds or re-builds missing images. You can skip this step if you do not want to update caddy or bbblb.
49
+
*`-d`: Runs the containers in detached mode (in the background).
51
50
52
51
Since all containers are configured with `restart: unless-stopped` they will be restarted automatically after a reboot.
0 commit comments