Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
tchapi committed Aug 3, 2024
1 parent 090d3fe commit a0fd679
Showing 1 changed file with 8 additions and 12 deletions.
20 changes: 8 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -392,10 +392,14 @@ For each release, a Docker image is built and published in the [Github package r
### Release images
Each release builds and tags an image. Example:
Each release builds and tags two images: one for the standard build (no reverse-proxy) and one for the standalone build (including Caddy as a reverse-proxy). Example:
```
docker pull ghcr.io/tchapi/davis:v3.1.0
docker pull ghcr.io/tchapi/davis:v4.4.0
```
```
docker pull ghcr.io/tchapi/davis-standalone:v4.4.0
```
### Edge image
Expand All @@ -412,23 +416,15 @@ docker pull ghcr.io/tchapi/davis:edge
## Full stack
A `docker-compose.yml` file is also included (in the `docker` folder) as a minimal example setup with a MariaDB database and Nginx as a reverse proxy.
A few `docker-compose.yml` files are also included (in the `docker` folder) as minimal example setups, with various databases for instance.
You can start the containers with :
cd docker && docker-compose up -d
> [!NOTE]
>
> The recipe above uses MariaDB but you can also use PostgreSQL with:
> ```
> cd docker && docker-compose -f docker-compose-postgresql.yml up -d
> ```
>
> Or SQLite with:
> ```
> cd docker && docker-compose -f docker-compose-sqlite.yml up -d
> ```
> The default recipe above uses MariaDB.
> [!IMPORTANT]
>
Expand Down

0 comments on commit a0fd679

Please sign in to comment.