From 78152d84122f5a2ab7585f1d640170c63e48150b Mon Sep 17 00:00:00 2001 From: Romain de Laage Date: Mon, 11 Jul 2022 09:23:44 +0000 Subject: [PATCH] docs: complete docker page and translate it to french closes #230 --- docs/src/fr/getting-started/docker.md | 66 ++++++++++++++---------- docs/src/getting-started/docker.md | 22 ++++++-- docs/src/nn-NO/getting-started/docker.md | 32 ++++++++---- docs/src/pt-BR/getting-started/docker.md | 32 ++++++++---- 4 files changed, 101 insertions(+), 51 deletions(-) diff --git a/docs/src/fr/getting-started/docker.md b/docs/src/fr/getting-started/docker.md index 53cc6dcf..6e0b0dce 100644 --- a/docs/src/fr/getting-started/docker.md +++ b/docs/src/fr/getting-started/docker.md @@ -1,29 +1,32 @@ --- -title: Official Docker images +title: Images Docker officielles sidebarDepth: 3 --- -# Official Docker images +# Images Docker officielles -Castopod pushes 2 Docker images to the Docker Hub during its automated build -process: +Castopod publie 2 images Docker sur Docker Hub grâce à l'automatisation de la +construction des images par la chaîne d'intégration GitLab : -- [**`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 +- [**`castopod/app`**](https://hub.docker.com/r/castopod/app): l'application + avec toutes les dépendances de Castopod +- [**`castopod/web-server`**](https://hub.docker.com/r/castopod/web-server): un + serveur Nginx avec une configuration adaptée à Castopod -## Supported tags +De plus, Castopod nécessite une base de donnée compatible avec MySQL. Une base +de donnée Redis peut être utilisée pour gérer le cache. -- `develop` [unstable], latest development branch build +## Tags disponibles -// stable tags to come… +- `develop` [instable], dernière version de développement de Castopod -## Example usage +// d'autres tags sont à venir ! -1. Install [docker](https://docs.docker.com/get-docker/) and +## Exemple d'utilisation + +1. Installez [docker](https://docs.docker.com/get-docker/) et [docker-compose](https://docs.docker.com/compose/install/) -2. Create a `docker-compose.yml` file with the following: +2. Créez un fichier `docker-compose.yml` contenant : ```yml version: "3.7" @@ -75,8 +78,6 @@ process: redis: image: redis:7.0-alpine container_name: "castopod-redis" - ports: - - 6379:6379 volumes: - castopod-cache:/data networks: @@ -92,20 +93,33 @@ process: castopod-db: ``` -3. Setup a reverse proxy for TLS (SSL/HTTPS), using caddy for example: + Vous devez adapter la configuration à vos besoins (e.g. `CP_BASEURL`, + `MYSQL_ROOT_PASSWORD`, `MYSQL_PASSWORD` and `CP_ANALYTICS_SALT`). - // TODO +3. Mettre en place un reverse proxy pour gérer TLS (SSL/HTTPS) -4. Run `docker-compose up`, wait for it to initialize and head on to - `https://castopod.example.com/cp-install` to finish the setting up Castopod! + TLS est obligatoire pour faire fonctionner ActivityPub. Cette tâche peut + facilement être déléguée à un reverse proxy, par exemple avec + [Caddy](https://caddyserver.com/): -5. You're all set, start podcasting! 🎙️🚀 + ``` + #castopod + castopod.example.com { + reverse_proxy localhost:8080 + } + ``` -## Environment Variables +4. Lancez la commande `docker-compose up -d`, attendez l'initialisation et + rendez-vous sur `https://castopod.example.com/cp-install` pour finir + l'installation de Castopod ! + +5. Tout est bon à présent, à vos podcasts ! 🎙️🚀 + +## Variables d'environnement - **castopod/app** - | Variable name | Type (`default`) | + | Nom de le variable | Type (`default`) | | -------------------------- | ----------------------------------- | | **`CP_BASEURL`** | string (`undefined`) | | **`CP_MEDIA_BASEURL`** | ?string (`(empty)`) | @@ -125,6 +139,6 @@ process: - **castopod/web-server** - | Variable name | Type (`default`) | - | --------------------- | ---------------- | - | **`CP_APP_HOSTNAME`** | ?string (`app`) | + | Nom de la variable | Type (`default`) | + | --------------------- | ----------------- | + | **`CP_APP_HOSTNAME`** | ?string (`"app"`) | diff --git a/docs/src/getting-started/docker.md b/docs/src/getting-started/docker.md index ec5f6f20..1a057fe4 100644 --- a/docs/src/getting-started/docker.md +++ b/docs/src/getting-started/docker.md @@ -13,6 +13,9 @@ process: - [**`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 @@ -75,8 +78,6 @@ process: redis: image: redis:7.0-alpine container_name: "castopod-redis" - ports: - - 6379:6379 volumes: - castopod-cache:/data networks: @@ -92,11 +93,22 @@ process: castopod-db: ``` -3. Setup a reverse proxy for TLS (SSL/HTTPS), using caddy for example: + You have to adapt some variables to your needs (e.g. `CP_BASEURL`, + `MYSQL_ROOT_PASSWORD`, `MYSQL_PASSWORD` and `CP_ANALYTICS_SALT`). - // TODO +3. Setup a reverse proxy for TLS (SSL/HTTPS) -4. Run `docker-compose up`, wait for it to initialize and head on to + 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! 🎙️🚀 diff --git a/docs/src/nn-NO/getting-started/docker.md b/docs/src/nn-NO/getting-started/docker.md index 53cc6dcf..1a057fe4 100644 --- a/docs/src/nn-NO/getting-started/docker.md +++ b/docs/src/nn-NO/getting-started/docker.md @@ -13,11 +13,14 @@ process: - [**`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 -// stable tags to come… +// more tags to come! ## Example usage @@ -75,8 +78,6 @@ process: redis: image: redis:7.0-alpine container_name: "castopod-redis" - ports: - - 6379:6379 volumes: - castopod-cache:/data networks: @@ -92,12 +93,23 @@ process: castopod-db: ``` -3. Setup a reverse proxy for TLS (SSL/HTTPS), using caddy for example: + You have to adapt some variables to your needs (e.g. `CP_BASEURL`, + `MYSQL_ROOT_PASSWORD`, `MYSQL_PASSWORD` and `CP_ANALYTICS_SALT`). - // TODO +3. Setup a reverse proxy for TLS (SSL/HTTPS) -4. Run `docker-compose up`, wait for it to initialize and head on to - `https://castopod.example.com/cp-install` to finish the setting up Castopod! + 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! 🎙️🚀 @@ -125,6 +137,6 @@ process: - **castopod/web-server** - | Variable name | Type (`default`) | - | --------------------- | ---------------- | - | **`CP_APP_HOSTNAME`** | ?string (`app`) | + | Variable name | Type (`default`) | + | --------------------- | ----------------- | + | **`CP_APP_HOSTNAME`** | ?string (`"app"`) | diff --git a/docs/src/pt-BR/getting-started/docker.md b/docs/src/pt-BR/getting-started/docker.md index 53cc6dcf..1a057fe4 100644 --- a/docs/src/pt-BR/getting-started/docker.md +++ b/docs/src/pt-BR/getting-started/docker.md @@ -13,11 +13,14 @@ process: - [**`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 -// stable tags to come… +// more tags to come! ## Example usage @@ -75,8 +78,6 @@ process: redis: image: redis:7.0-alpine container_name: "castopod-redis" - ports: - - 6379:6379 volumes: - castopod-cache:/data networks: @@ -92,12 +93,23 @@ process: castopod-db: ``` -3. Setup a reverse proxy for TLS (SSL/HTTPS), using caddy for example: + You have to adapt some variables to your needs (e.g. `CP_BASEURL`, + `MYSQL_ROOT_PASSWORD`, `MYSQL_PASSWORD` and `CP_ANALYTICS_SALT`). - // TODO +3. Setup a reverse proxy for TLS (SSL/HTTPS) -4. Run `docker-compose up`, wait for it to initialize and head on to - `https://castopod.example.com/cp-install` to finish the setting up Castopod! + 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! 🎙️🚀 @@ -125,6 +137,6 @@ process: - **castopod/web-server** - | Variable name | Type (`default`) | - | --------------------- | ---------------- | - | **`CP_APP_HOSTNAME`** | ?string (`app`) | + | Variable name | Type (`default`) | + | --------------------- | ----------------- | + | **`CP_APP_HOSTNAME`** | ?string (`"app"`) |