castopod/docs/src/es/getting-started/install.md

224 lines
8.5 KiB
Markdown
Raw Normal View History

2022-04-14 15:11:07 +02:00
---
2022-04-22 09:56:31 +02:00
title: Instalación
2022-04-14 15:11:07 +02:00
sidebarDepth: 3
---
2022-04-22 09:56:31 +02:00
# ¿Cómo instalar Castopod?
2022-04-14 15:11:07 +02:00
2022-07-04 15:27:21 +02:00
Castopod está pensado para ser fácil de instalar. Ya sea usando un alojamiento
dedicado o compartido, puedes instalarlo en la mayoría de servidores web
2022-04-22 09:56:31 +02:00
compatibles con PHP-MySQL.
2022-04-14 15:11:07 +02:00
2022-09-06 16:55:46 +02:00
::: tip Nota
2022-04-14 15:11:07 +02:00
2022-09-06 16:55:46 +02:00
¡Hemos publicado imágenes oficiales de Docker para Castopod!
2022-08-22 17:56:51 +02:00
2022-09-06 16:55:46 +02:00
Si prefieres usar Docker, puedes saltarte esto e ir directamente a la
[documentación sobre docker](./docker.md) para Castopod.
2022-04-14 15:11:07 +02:00
2022-07-04 15:27:21 +02:00
:::
2022-09-06 16:55:46 +02:00
## Requisitos
2022-07-04 15:27:21 +02:00
- PHP v8.1 o superior
2022-07-04 15:27:21 +02:00
- MySQL versión 5.7 o superior o MariaDB versión 10.2 o superior
- Soporte HTTPS
2023-03-16 17:45:41 +01:00
- An [ntp-synced clock](https://wiki.debian.org/NTP) to validate federation's
incoming requests
2022-04-14 15:11:07 +02:00
### PHP v8.1 o superior
2022-07-04 15:27:21 +02:00
Se requiere PHP versión 8.1 o superior con las siguientes extensiones
2022-09-06 16:55:46 +02:00
instaladas:
2022-04-14 15:11:07 +02:00
- [intl](https://php.net/manual/en/intl.requirements.php)
- [libcurl](https://php.net/manual/en/curl.requirements.php)
- [mbstring](https://php.net/manual/en/mbstring.installation.php)
2022-07-04 15:27:21 +02:00
- [gd](https://www.php.net/manual/en/image.installation.php) con librerias
**JPEG**, **PNG** y **WEBP**.
2022-04-14 15:11:07 +02:00
- [exif](https://www.php.net/manual/en/exif.installation.php)
2022-09-06 16:55:46 +02:00
Además, asegúrate de que las siguientes extensiones están habilitadas en tu PHP:
2022-04-14 15:11:07 +02:00
2022-07-04 15:27:21 +02:00
- json (habilitada por defecto - no la desactives)
- xml (habilitada por defecto - no la desactives)
2022-04-14 15:11:07 +02:00
- [mysqlnd](https://php.net/manual/en/mysqlnd.install.php)
2022-07-04 15:27:21 +02:00
### Base de datos compatible con MySQL
2022-04-14 15:11:07 +02:00
2022-09-06 16:55:46 +02:00
> Se recomienda usar [MariaDB](https://mariadb.org).
2022-04-14 15:11:07 +02:00
2022-09-06 16:55:46 +02:00
::: warning Alerta
2022-04-14 15:11:07 +02:00
2022-09-06 16:55:46 +02:00
Castopod solo funciona con base de datos compatibles con MySQL 5.7 o superior.
No funcionará por ejemplo con la version previa MySQL v5.6, ya que su vida útil
terminó el 5 de febrero de 2021.
2022-04-14 15:11:07 +02:00
:::
2022-09-06 16:55:46 +02:00
Necesitarás la dirección/nombre del servidor (hostname), el nombre de la base de
datos, el usuario y la contraseña para completar el proceso de instalación. Si
no cuentas con esta información, contacta con el administrador de tu servidor.
2022-04-14 15:11:07 +02:00
2022-07-04 15:27:21 +02:00
#### Privilegios
2022-04-14 15:11:07 +02:00
2022-12-09 16:42:46 +01:00
El usuario debe tener al menos estos privilegios en la base de datos para que
Castopod funcione: `CREATE`, `ALTER`, `DELETE`, `EXECUTE`, `INDEX`, `INSERT`,
`SELECT`, `UPDATE`, `REFERENCES`, `CREATE VIEW`.
2022-04-14 15:11:07 +02:00
2022-09-06 16:55:46 +02:00
### (Opcional) FFmpeg v4.1.8 o superior para poder generar clips de vídeo (recortes de vídeo)
2022-04-14 15:11:07 +02:00
2022-09-06 16:55:46 +02:00
Es necesario tener instalado [FFmpeg](https://www.ffmpeg.org/) versión 4.1.8 o
superior si desea generar recorte de vídeos. Se debe instalar las siguientes
extensiones:
2022-04-14 15:11:07 +02:00
2022-07-04 15:27:21 +02:00
- Librería **FreeType 2** para
2022-04-14 15:11:07 +02:00
[gd](https://www.php.net/manual/en/image.installation.php).
2022-07-04 15:27:21 +02:00
### (Opcional) Otras recomendaciones
2022-04-14 15:11:07 +02:00
2022-07-04 15:27:21 +02:00
- Redis para mejores rendimientos de caché.
- CDN para almacenamiento en caché de archivos estáticos y mejores rendimientos.
2022-09-06 16:55:46 +02:00
- Pasarela de correo para recuperación de contraseñas olvidadas.
2022-04-14 15:11:07 +02:00
2022-07-04 15:27:21 +02:00
## Instrucciones de instalación
2022-04-14 15:11:07 +02:00
2022-09-06 16:55:46 +02:00
### Pre-requisitos
2022-04-14 15:11:07 +02:00
2022-09-06 16:55:46 +02:00
0. Consigue un servidor web que cuente con todos los [requisitos](#requirements)
recomendados.
2022-07-04 15:27:21 +02:00
1. Crea una base de datos MySQL para Castopod con un usuario que tenga acceso y
privilegios de modificación (para más información, ver
2022-09-06 16:55:46 +02:00
[base de datos compatible con MySQL](#mysql-compatible-database)).
2. Activa HTTPS en tu dominio web mediante un _certificado SSL_.
3. Descarga y descomprime en tu servidor la última versión de
[Castopod](https://castopod.org/), si aún no lo has hecho.
- ⚠️ Edita la configuración de tu servidor para que el "document root" sea la
subcarpeta `castopod/public/`.
4. Añade tareas en el **cron** de tu servidor web para hacer funcionar varios
procesos de Castopod en segundo plano (reemplaza las rutas de acuerdo a la
estructura de directorios de tu servidor):
- Esta tarea se utiliza para transmitir las actividades sociales a tus
seguidores en el Fediverso:
2022-04-14 15:11:07 +02:00
```bash
2022-09-06 16:55:46 +02:00
* * * * * /ruta/al/php /ruta/a/castopod/public/index.php scheduled-activities
2022-04-14 15:11:07 +02:00
```
2022-09-06 16:55:46 +02:00
- Para que tus episodios sean transmitidos a los hubs abiertos que usan el
nuevo protocolo [WebSub](https://en.wikipedia.org/wiki/WebSub) (2018):
2022-04-14 15:11:07 +02:00
```bash
2022-09-06 16:55:46 +02:00
* * * * * /ruta/al/php /castopod/public/index.php scheduled-websub-publish
2022-04-14 15:11:07 +02:00
```
2022-09-06 16:55:46 +02:00
- Para generar Recortes de video (ver
[requisitos FFmpeg ](#ffmpeg-v418-or-higher-for-video-clips)):
2022-04-14 15:11:07 +02:00
```bash
2022-09-06 16:55:46 +02:00
* * * * * /ruta/al/php /path/to/castopod/public/index.php scheduled-video-clips
2022-04-14 15:11:07 +02:00
```
2022-09-06 16:55:46 +02:00
> Estas tareas así definidas se ejecutarán **cada minuto**. Pero puedes
> definir una frecuencia más acorde a tus necesidades: cada 5, 10 minutos o
2022-11-04 12:03:24 +01:00
> más.
2022-04-14 15:11:07 +02:00
2022-09-06 16:55:46 +02:00
### (recomendado) Asistente web de instalación
2022-04-14 15:11:07 +02:00
2022-09-06 16:55:46 +02:00
1. Ejecuta el script de instalación de Castopod visitando en tu navegador web
esta dirección: `https://tu_nombre_de_dominio.com/cp-install`
2. Sigue las instrucciones en pantalla.
3. ¡Empieza a hacer podcasting!
2022-04-14 15:11:07 +02:00
2022-09-06 16:55:46 +02:00
::: info Nota
2022-04-14 15:11:07 +02:00
2022-10-14 18:12:14 +02:00
El script de instalación crea un archivo `.env` en la raíz de castopod. If you
cannot go through the install wizard, you can create and edit the `.env` file
manually based on the `.env.example` file.
2022-04-14 15:11:07 +02:00
:::
2022-12-09 16:42:46 +01:00
### Configuración de Correo Electrónico/SMTP
2022-10-14 18:12:14 +02:00
2022-12-09 16:42:46 +01:00
La configuración del correo electrónico es necesaria para que algunas
características funcionen correctamente (por ejemplo, recuperar su contraseña
olvidada, enviando instrucciones a los suscriptores premium, …)
2022-10-14 18:12:14 +02:00
2022-12-09 16:42:46 +01:00
Puedes añadir tu configuración de correo electrónico en el archivo `.env` de tu
instancia así:
2022-10-14 18:12:14 +02:00
```ini
# […]
2022-12-09 16:42:46 +01:00
email.fromEmail="your_email_address"
email.SMTPHost="your_smtp_host"
email.SMTPUser="your_smtp_user"
email.SMTPPass="your_smtp_password"
2022-10-14 18:12:14 +02:00
```
2022-12-09 16:42:46 +01:00
#### Opciones de configuración de email
2022-10-14 18:12:14 +02:00
2022-12-09 16:42:46 +01:00
| Nombre de la variable | Tipo | Predeterminado |
| --------------------- | -------------------- | -------------- |
| **`fromEmail`** | string | `undefined` |
| **`fromName`** | string | `"Castopod"` |
| **`SMTPHost`** | string | `undefined` |
| **`SMTPUser`** | string | `undefined` |
| **`SMTPPass`** | string | `undefined` |
| **`SMTPPort`** | number | `25` |
| **`SMTPCrypto`** | [`"tls"` or `"ssl"`] | `"tls"` |
2022-10-14 18:12:14 +02:00
2023-03-16 17:45:41 +01:00
### S3
By default, files are stored in the `public/media` folder using the filesystem.
If you prefer storing your media files on an S3 compatible storage, you may
specify it in your `.env`:
```ini
# […]
media.fileManager="s3"
media.s3.endpoint="your_s3_host"
media.s3.key="your_s3_key"
media.s3.secret="your_s3_secret"
media.s3.region="your_s3_region"
```
#### S3 config options
| Variable name | Type | Default |
| ------------------------- | ------- | ----------- |
| **`endpoint`** | string | `undefined` |
| **`key`** | string | `undefined` |
| **`secret`** | string | `undefined` |
| **`region`** | string | `undefined` |
| **`bucket`** | string | `castopod` |
| **`protocol`** | number | `undefined` |
| **`path_style_endpoint`** | boolean | `false` |
2022-07-04 15:27:21 +02:00
## Paquetes de la comunidad
2022-04-14 15:11:07 +02:00
2023-03-16 17:45:41 +01:00
If you don't want to bother with installing Castopod manually, you may use one
of the packages created and maintained by the open-source community.
2022-04-14 15:11:07 +02:00
2023-03-16 17:45:41 +01:00
### Install with YunoHost
2022-04-14 15:11:07 +02:00
2023-03-16 17:45:41 +01:00
[YunoHost](https://yunohost.org/) is a distribution based on Debian GNU/Linux
made up of free and open-source software packages. It manages the hardships of
self-hosting for you.
2022-04-14 15:11:07 +02:00
<div class="flex flex-wrap items-center gap-4">
<a href="https://install-app.yunohost.org/?app=castopod" target="_blank" rel="noopener noreferrer">
2022-09-06 16:55:46 +02:00
<img src="https://install-app.yunohost.org/install-with-yunohost.svg" alt="Instalar Castopod con YunoHost." class="align-middle" />
2022-04-14 15:11:07 +02:00
</a>
2022-12-09 16:42:46 +01:00
<a href="https://github.com/YunoHost-Apps/castopod_ynh" target="_blank" rel="noopener noreferrer" class="inline-flex items-center px-4 py-[.3rem] mx-auto font-semibold text-center text-black rounded-md gap-x-1 border-2 border-solid border-[#333] hover:no-underline hover:bg-gray-100"><svg
xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="1em" height="1em"
class="text-xl"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 2A10 10 0 0 0 2 12a10 10 0 0 0 6.84 9.49c.5.09.69-.21.69-.48l-.02-1.86c-2.51.46-3.16-.61-3.36-1.18-.11-.28-.6-1.17-1.02-1.4-.35-.2-.85-.66-.02-.67.79-.01 1.35.72 1.54 1.02.9 1.52 2.34 1.1 2.91.83a2.1 2.1 0 0 1 .64-1.34c-2.22-.25-4.55-1.11-4.55-4.94A3.9 3.9 0 0 1 6.68 8.8a3.6 3.6 0 0 1 .1-2.65s.83-.27 2.75 1.02a9.28 9.28 0 0 1 2.5-.34c.85 0 1.7.12 2.5.34 1.9-1.3 2.75-1.02 2.75-1.02.54 1.37.2 2.4.1 2.65.63.7 1.02 1.58 1.02 2.68 0 3.84-2.34 4.7-4.56 4.94.36.31.67.91.67 1.85l-.01 2.75c0 .26.19.58.69.48A10.02 10.02 0 0 0 22 12 10 10 0 0 0 12 2z"/></svg>Github
Repo</a>
2022-04-14 15:11:07 +02:00
</div>