Instalación

libredesk se puede instalar con Docker, mediante un binario precompilado o compilándolo desde el código fuente. Docker es la opción recomendada para la mayoría de las instalaciones.

libredesk se ejecuta en el puerto 9000 de forma predeterminada. Después de instalarlo, inicia sesión en http://localhost:9000 con el correo electrónico System y la contraseña que hayas establecido.

Instalar con Docker

Esta es la forma recomendada de ejecutar libredesk. Solo necesitas Docker y Docker Compose. PostgreSQL y Redis están incluidos en el archivo de Compose.

1. Descarga el archivo de Compose y la configuración de ejemplo.

curl -LO https://github.com/abhinavxd/libredesk/raw/main/docker-compose.yml
curl -LO https://github.com/abhinavxd/libredesk/raw/main/config.sample.toml

2. Copia la configuración de ejemplo y edítala según sea necesario.

cp config.sample.toml config.toml

3. Inicia los servicios.

docker compose up -d

4. Establece la contraseña del usuario System.

docker exec -it libredesk_app ./libredesk --set-system-user-password

Abre http://localhost:9000 e inicia sesión como System.

Instalar desde un binario

Necesitas PostgreSQL 13 o posterior y Redis en ejecución.

1. Descarga el binario de la versión más reciente para tu plataforma desde la página de versiones.

2. Descarga la configuración de ejemplo y cópiala.

curl -LO https://github.com/abhinavxd/libredesk/raw/main/config.sample.toml
cp config.sample.toml config.toml

3. Crea el directorio de archivos subidos.

mkdir uploads
chmod 755 uploads

4. Instala las tablas de la base de datos.

./libredesk --install

También puedes establecer la contraseña del usuario System durante la instalación.

LIBREDESK_SYSTEM_USER_PASSWORD=your_password ./libredesk --install

5. Establece la contraseña del usuario System si no lo hiciste antes.

./libredesk --set-system-user-password

6. Ejecuta libredesk.

./libredesk

Compilar desde el código fuente

Necesitas PostgreSQL 13 o posterior, Redis, una versión reciente de Go, Node.js 18 o posterior y pnpm.

1. Clona el repositorio.

git clone [email protected]:abhinavxd/libredesk.git
cd libredesk

2. Compila la aplicación.

make

3. Descarga la configuración de ejemplo y cópiala.

curl -LO https://github.com/abhinavxd/libredesk/raw/main/config.sample.toml
cp config.sample.toml config.toml

4. Crea el directorio de archivos subidos.

mkdir uploads
chmod 755 uploads

5. Instala las tablas de la base de datos y establece la contraseña del usuario System.

./libredesk --install
./libredesk --set-system-user-password

6. Ejecuta libredesk.

./libredesk

Configuración con variables de entorno

Cada ajuste de config.toml también se puede definir con una variable de entorno. Usa el prefijo LIBREDESK_ y dos guiones bajos para las claves anidadas.

LIBREDESK_DB__HOST=localhost

Ejecutar detrás de nginx

Se recomienda usar un proxy inverso en producción. Instala nginx primero.

sudo apt update && sudo apt install nginx

En Fedora o RHEL:

sudo dnf install nginx && sudo systemctl enable --now nginx

Después, usa una configuración como esta.

server {
    listen 80;
    server_name your-domain.com;
    client_max_body_size 30M;

    location / {
        proxy_pass http://localhost:9000;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection 'upgrade';
        proxy_set_header Host $host;

        proxy_set_header X-Client-IP $remote_addr;
        # If behind Cloudflare (or another CDN), forward the CDN's real-client header
        # instead, AND firewall nginx to only accept connections from the CDN's IP range,
        # otherwise clients can bypass the CDN and spoof this header directly.

        # proxy_set_header X-Client-IP $http_cf_connecting_ip;   # Cloudflare

        proxy_cache_bypass $http_upgrade;
    }
}

El proxy debe establecer X-Client-IP como $remote_addr. La limitación de solicitudes y los registros de auditoría leen la IP del cliente desde ese encabezado.

Activa el sitio y recarga nginx.

sudo ln -s /etc/nginx/sites-available/libredesk /etc/nginx/sites-enabled/
sudo nginx -t && sudo systemctl reload nginx