docs-by-racso

Dropship

Una herramienta simple de CI/CD para desplegar tu código en un servidor.

Pre-requisitos

1. Apache y PHP 8.0 o superior.

2. Git. Para instalarlo, ejecuta:

    sudo apt-get install git
   

3. Una cuenta de GitHub, y un token de acceso personal con el alcance repo. Consulta aquí para más información, o haz clic aquí para crear un token.

Instalación

1. Copia todos los archivos del proyecto a una carpeta accesible desde la web de tu servidor.

2. Establece el propietario de la carpeta Dropship a www-data (o el usuario con el que se ejecute tu servidor web), y sus permisos a 750:

    sudo chown -R www-data:www-data /path/to/dropship
    sudo chmod -R 750 /path/to/dropship
   

3. Renombra el archivo .example.config a .config y edítalo. Añade un token de acceso administrativo:

    TOKEN=tu_token_de_acceso
   

   Se recomienda utilizar un generador de contraseñas para generar un token seguro. Puedes utilizar Random.org para generar uno rápidamente.

4. Renombra deploy.example.json a deploy.json.
5. En tu navegador web, navega a la ruta donde está instalado Dropship. Inicia sesión con tu token de acceso.
6. Tras iniciar sesión, navega a /check y valida que todas las verificaciones pasen.

Añadir un repositorio: manual

Estos primeros pasos añadirán un repositorio que podrás actualizar de forma manual.

1. Edita el archivo deploy.json de tu instalación de Dropship y añade la siguiente información:
   1. Añade la información de tu usuario de GitHub: nombre de usuario y token de acceso personal con alcance repo.

   2. Añade la información de tu repositorio: URL del repositorio, rama a desplegar, y ruta del servidor a donde se desplegará el código. Usa los ejemplos del archivo como referencia.

      Por el momento, ignora el valor secret; lo utilizarás más adelante si quieres configurar un despliegue automático.

Listo. Ya puedes desplegar manualmente el código de tu repositorio. Ve a la sección Despliegue manual para más información.

Añadir un repositorio: automático

Estos pasos automatizarán el despliegue de tu código cada vez que hagas un push a tu repositorio.

1. En el repositorio de GitHub que quieres desplegar, ve a Settings > Webhooks > Add webhook.
   1. En el campo Payload URL, introduce la URL de tu instalación de Dropship, seguida de /notify. Por ejemplo: https://example.com/dropship/notify.
   2. Establece el Content type a application/json.
   3. Establece el Secret a una cadena aleatoria. Nuevamente, te sugerimos usar Random.org para generar uno rápidamente.
   4. Selecciona el evento push.
   5. Haz clic en Add webhook.
2. Edita el archivo deploy.json de tu instalación de Dropship y añade el Secret de tu repositorio en el campo secret correspondiente.

Listo. Cada vez que hagas un push a tu repositorio en la rama indicada en deploy.json, Dropship desplegará automáticamente la última versión de tu código en tu servidor.

Pro-tip: si solo quieres usar el despliegue automático (no manual), puedes eliminar el campo token del archivo deploy.json para deshabilitar el inicio de sesión.

Despliegue manual

Dropship incluye una interfaz web para desplegar manualmente el código de tu repositorio. Para desplegar manualmente, sigue estos pasos:

1. Inicia sesión en Dropship.
2. En el panel de control encontrarás los repositorios que tienes registrados. Identifica el repositorio que quieres desplegar.
3. En el recuadro, introduce el hash del commit que quieres desplegar (e.g. af3719eba1628, o el nombre de la rama remota (e.g. origin/main).
4. Haz clic en Desplegar. Dropship desplegará el código en tu servidor.
5. Tras desplegar, Dropship te mostrará el resultado del despliegue. Si todo salió bien, verás un mensaje de éxito. Si algo salió mal, verás un mensaje de error.