143 lines
4.3 KiB
Markdown
143 lines
4.3 KiB
Markdown
|
---
|
||
|
|
title: Official Docker images
|
||
|
|
sidebarDepth: 3
|
||
|
|
---
|
||
|
|
|
||
|
|
# Official Docker images
|
||
|
|
|
||
|
|
Castopod pushes 2 Docker images to the Docker Hub during its automated build
|
||
|
|
process:
|
||
|
|
|
||
|
|
- [**`castopod/app`**](https://hub.docker.com/r/castopod/app): the app bundle
|
||
|
|
with all of Castopod dependencies
|
||
|
|
- [**`castopod/web-server`**](https://hub.docker.com/r/castopod/web-server): an
|
||
|
|
Nginx configuration for Castopod
|
||
|
|
|
||
|
|
Additionally, Castopod requires a MySQL-compatible database. A Redis database
|
||
|
|
can be added as a cache handler.
|
||
|
|
|
||
|
|
## Supported tags
|
||
|
|
|
||
|
|
- `develop` [unstable], latest development branch build
|
||
|
|
|
||
|
|
// more tags to come!
|
||
|
|
|
||
|
|
## Example usage
|
||
|
|
|
||
|
|
1. Install [docker](https://docs.docker.com/get-docker/) and
|
||
|
|
[docker-compose](https://docs.docker.com/compose/install/)
|
||
|
|
2. Create a `docker-compose.yml` file with the following:
|
||
|
|
|
||
|
|
```yml
|
||
|
|
version: "3.7"
|
||
|
|
|
||
|
|
services:
|
||
|
|
app:
|
||
|
|
image: castopod/app:develop
|
||
|
|
container_name: "castopod-app"
|
||
|
|
volumes:
|
||
|
|
- castopod-media:/opt/castopod/public/media
|
||
|
|
environment:
|
||
|
|
MYSQL_DATABASE: castopod
|
||
|
|
MYSQL_USER: castopod
|
||
|
|
MYSQL_PASSWORD: changeme
|
||
|
|
CP_BASEURL: "http://castopod.example.com"
|
||
|
|
CP_ANALYTICS_SALT: changeme
|
||
|
|
CP_CACHE_HANDLER: redis
|
||
|
|
CP_REDIS_HOST: redis
|
||
|
|
networks:
|
||
|
|
- castopod-app
|
||
|
|
- castopod-db
|
||
|
|
restart: unless-stopped
|
||
|
|
|
||
|
|
web-server:
|
||
|
|
image: castopod/web-server:develop
|
||
|
|
container_name: "castopod-web-server"
|
||
|
|
volumes:
|
||
|
|
- castopod-media:/var/www/html/media
|
||
|
|
networks:
|
||
|
|
- castopod-app
|
||
|
|
ports:
|
||
|
|
- 8080:80
|
||
|
|
restart: unless-stopped
|
||
|
|
|
||
|
|
mariadb:
|
||
|
|
image: mariadb:10.5
|
||
|
|
container_name: "castopod-mariadb"
|
||
|
|
networks:
|
||
|
|
- castopod-db
|
||
|
|
volumes:
|
||
|
|
- castopod-db:/var/lib/mysql
|
||
|
|
environment:
|
||
|
|
MYSQL_ROOT_PASSWORD: changeme
|
||
|
|
MYSQL_DATABASE: castopod
|
||
|
|
MYSQL_USER: castopod
|
||
|
|
MYSQL_PASSWORD: changeme
|
||
|
|
restart: unless-stopped
|
||
|
|
|
||
|
|
redis:
|
||
|
|
image: redis:7.0-alpine
|
||
|
|
container_name: "castopod-redis"
|
||
|
|
volumes:
|
||
|
|
- castopod-cache:/data
|
||
|
|
networks:
|
||
|
|
- castopod-app
|
||
|
|
|
||
|
|
volumes:
|
||
|
|
castopod-media:
|
||
|
|
castopod-db:
|
||
|
|
castopod-cache:
|
||
|
|
|
||
|
|
networks:
|
||
|
|
castopod-app:
|
||
|
|
castopod-db:
|
||
|
|
```
|
||
|
|
|
||
|
|
You have to adapt some variables to your needs (e.g. `CP_BASEURL`,
|
||
|
|
`MYSQL_ROOT_PASSWORD`, `MYSQL_PASSWORD` and `CP_ANALYTICS_SALT`).
|
||
|
|
|
||
|
|
3. Setup a reverse proxy for TLS (SSL/HTTPS)
|
||
|
|
|
||
|
|
TLS is mandatory for ActivityPub to work. This job can easily be handled by
|
||
|
|
a reverse proxy, for example with [Caddy](https://caddyserver.com/):
|
||
|
|
|
||
|
|
```
|
||
|
|
#castopod
|
||
|
|
castopod.example.com {
|
||
|
|
reverse_proxy localhost:8080
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
4. Run `docker-compose up -d`, wait for it to initialize and head on to
|
||
|
|
`https://castopod.example.com/cp-install` to finish setting up Castopod!
|
||
|
|
|
||
|
|
5. You're all set, start podcasting! 🎙️🚀
|
||
|
|
|
||
|
|
## Environment Variables
|
||
|
|
|
||
|
|
- **castopod/app**
|
||
|
|
|
||
|
|
| Variable name | Type (`default`) |
|
||
|
|
| -------------------------- | ----------------------------------- |
|
||
|
|
| **`CP_BASEURL`** | string (`undefined`) |
|
||
|
|
| **`CP_MEDIA_BASEURL`** | ?string (`(empty)`) |
|
||
|
|
| **`CP_ADMIN_GATEWAY`** | ?string (`"cp-admin"`) |
|
||
|
|
| **`CP_AUTH_GATEWAY`** | ?string (`"cp-auth"`) |
|
||
|
|
| **`CP_ANALYTICS_SALT`** | string (`undefined`) |
|
||
|
|
| **`CP_DATABASE_HOSTNAME`** | ?string (`"mariadb"`) |
|
||
|
|
| **`CP_DATABASE_NAME`** | string (`MYSQL_DATABASE`) |
|
||
|
|
| **`CP_DATABASE_USERNAME`** | string (`MYSQL_USER`) |
|
||
|
|
| **`CP_DATABASE_PASSWORD`** | string (`MYSQL_PASSWORD`) |
|
||
|
|
| **`CP_DATABASE_PREFIX`** | ?string (`"cp_"`) |
|
||
|
|
| **`CP_CACHE_HANDLER`** | ?[`"file"` or `"redis"`] (`"file"`) |
|
||
|
|
| **`CP_REDIS_HOST`** | ?string (`"localhost"`) |
|
||
|
|
| **`CP_REDIS_PASSWORD`** | ?string (`null`) |
|
||
|
|
| **`CP_REDIS_PORT`** | ?number (`6379`) |
|
||
|
|
| **`CP_REDIS_DATABASE`** | ?number (`0`) |
|
||
|
|
|
||
|
|
- **castopod/web-server**
|
||
|
|
|
||
|
|
| Variable name | Type (`default`) |
|
||
|
|
| --------------------- | ----------------- |
|
||
|
|
| **`CP_APP_HOSTNAME`** | ?string (`"app"`) |
|