Skip to content

Commit ca29b80

Browse files
authored
Fix typos and enhance clarity in README.md
Signed-off-by: Marcel Hellkamp <marc@gsites.de>
1 parent a4c93a7 commit ca29b80

1 file changed

Lines changed: 9 additions & 10 deletions

File tree

examples/bbblb-compose/README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# BBBLB Docker Compose Example
22

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.
44

55
## Prerequisites
66

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.
88

99
## Getting Started
1010

@@ -22,9 +22,9 @@ Before we begin, ensure you have [Docker](https://docs.docker.com/engine/install
2222
You can delete the cloned repository afterwards, we do not need it.
2323

2424
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.
2626

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.
2828

2929
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.
3030

@@ -34,20 +34,19 @@ Before we begin, ensure you have [Docker](https://docs.docker.com/engine/install
3434
Do not change `PATH_DATA` or `DB` for now. Both are overridden in the `docker-compose.yml` file because they need to match other parts of the compose file.
3535

3636
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.
3938

4039
## Starting the Services
4140

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:
4342

4443
```bash
4544
docker compose up --build -d
4645
```
4746

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).
5150

5251
Since all containers are configured with `restart: unless-stopped` they will be restarted automatically after a reboot.
5352

0 commit comments

Comments
 (0)