castopod/docs/src/fr/getting-started/docker.md

173 lines
7.5 KiB
Markdown
Raw Normal View History

---
2023-03-16 17:45:41 +01:00
title: Images officielles Docker
sidebarDepth: 3
---
2023-03-16 17:45:41 +01:00
# Images officielles de Docker
2023-03-16 17:45:41 +01:00
Castopod envoie 3 images Docker au Hub Docker pendant son processus de
construction automatisée :
2023-03-23 13:13:46 +01:00
- [**`castopod/castopod`**](https://hub.docker.com/r/castopod/castopod): an all
in one castopod image using nginx unit
2022-08-22 17:56:51 +02:00
- [**`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
2022-11-04 12:03:24 +01:00
- [**`castopod/video-clipper`**](https://hub.docker.com/r/castopod/video-clipper):
an optional image building videoclips thanks to ffmpeg
2023-03-16 17:45:41 +01:00
De plus, Castopod nécessite une base de données compatible avec MySQL. Une base
de données Redis peut être ajoutée en tant que gestionnaire de cache.
2023-03-16 17:45:41 +01:00
## Tags supportés
2023-03-16 17:45:41 +01:00
- `développer` [unstable], la dernière version de la branche de développement
- `beta` [stable], dernière version bêta
- `1.0.0-beta.x` [stable], version bêta spécifique (depuis `1.0.0-beta.22`)
- `beta` [stable], dernière version bêta
- `1.x.x` [stable], version spécifique (depuis `1.0.0`)
2023-03-16 17:45:41 +01:00
## Exemple d'utilisation
2023-03-16 17:45:41 +01:00
1. Installez [docker](https://docs.docker.com/get-docker/) et
[docker-compose](https://docs.docker.com/compose/install/)
2023-03-16 17:45:41 +01:00
2. Créez un fichier `docker-compose.yml` avec les éléments suivants :
```yml
version: "3.7"
services:
app:
2022-11-04 12:03:24 +01:00
image: castopod/app:latest
container_name: "castopod-app"
volumes:
2023-05-05 16:28:51 +02:00
- castopod-media:/var/www/castopod/public/media
environment:
MYSQL_DATABASE: castopod
MYSQL_USER: castopod
MYSQL_PASSWORD: changeme
2023-05-05 16:28:51 +02:00
CP_BASEURL: "https://castopod.example.com"
CP_ANALYTICS_SALT: changeme
CP_CACHE_HANDLER: redis
CP_REDIS_HOST: redis
networks:
- castopod-app
- castopod-db
ports:
2023-05-05 16:28:51 +02:00
- 8000:8000
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:
```
2023-03-16 17:45:41 +01:00
Vous devez adapter certaines variables à vos besoins (p. ex. `CP_BASEURL`,
`MYSQL_ROOT_PASSWORD`, `MYSQL_PASSWORD` et `CP_ANALYTICS_SALT`).
2022-08-22 17:56:51 +02:00
3. Setup a reverse proxy for TLS (SSL/HTTPS)
2022-08-22 17:56:51 +02:00
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 {
2023-05-05 16:28:51 +02:00
reverse_proxy localhost:8000
}
```
2023-03-16 17:45:41 +01:00
4. Exécutez `docker-compose up -d`, attendez qu'il s'initialise sur
`https://castopod.example.com/cp-install` pour terminer la configuration de
Castopod !
2023-03-16 17:45:41 +01:00
5. Vous êtes prêt, commencez à podcaster! 🎙️🚀
2022-08-22 17:56:51 +02:00
## Environment Variables
2022-11-04 12:03:24 +01:00
- **castopod/video-clipper**
2023-03-16 17:45:41 +01:00
| Nom de la variable | Type (`default`) | Par défaut |
2022-11-04 12:03:24 +01:00
| -------------------------- | ---------------- | ---------------- |
| **`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_"` |
2023-05-05 16:28:51 +02:00
- **castopod/castopod** and **castopod/app**
| Variable name | Type (`default`) | Par défaut |
| ------------------------------------- | ----------------------- | ---------------- |
| **`CP_BASEURL`** | string | `undefined` |
| **`CP_MEDIA_BASEURL`** | ?string | `CP_BASEURL` |
| **`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` |
| **`CP_EMAIL_SMTP_HOST`** | ?string | `undefined` |
| **`CP_EMAIL_FROM`** | ?string | `undefined` |
| **`CP_EMAIL_SMTP_USERNAME`** | ?string | `"localhost"` |
| **`CP_EMAIL_SMTP_PASSWORD`** | ?string | `null` |
| **`CP_EMAIL_SMTP_PORT`** | ?number | `25` |
| **`CP_EMAIL_SMTP_CRYPTO`** | [`"tls"` or `"ssl"`] | `"tls"` |
| **`CP_ENABLE_2FA`** | ?boolean | `undefined` |
| **`CP_MEDIA_FILE_MANAGER`** | ?string | `undefined` |
| **`CP_MEDIA_S3_ENDPOINT`** | ?string | `undefined` |
| **`CP_MEDIA_S3_KEY`** | ?string | `undefined` |
| **`CP_MEDIA_S3_SECRET`** | ?string | `undefined` |
| **`CP_MEDIA_S3_REGION`** | ?string | `undefined` |
| **`CP_MEDIA_S3_BUCKET`** | ?string | `undefined` |
| **`CP_MEDIA_S3_PROTOCOL`** | ?number | `undefined` |
| **`CP_MEDIA_S3_PATH_STYLE_ENDPOINT`** | ?boolean | `undefined` |
| **`CP_MEDIA_S3_KEY_PREFIX`** | ?string | `undefined` |
| **`CP_DISABLE_HTTPS`** | ?[`0` or `1`] | `undefined` |
| **`CP_MAX_BODY_SIZE`** | ?number (with suffix) | `512M` |
| **`CP_PHP_MEMORY_LIMIT`** | ?number (with suffix) | `512M` |
| **`CP_TIMEOUT`** | ?number | `900` |
- **castopod/web-server**
2023-05-05 16:28:51 +02:00
| Nom de la variable | Type | Par défaut |
| ---------------------- | --------------------- | ---------- |
| **`CP_APP_HOSTNAME`** | ?string | `"app"` |
| **`CP_MAX_BODY_SIZE`** | ?number (with suffix) | `512M` |
| **`CP_TIMEOUT`** | ?number | `900` |