4
Home
groales edited this page 2025-12-04 16:52:46 +01:00

BookStack Wiki

Documentación completa para el despliegue y gestión de BookStack con Docker.

📑 Índice

Inicio Rápido

Modos de Despliegue

  • Traefik - Proxy inverso con SSL automático
  • NPM - Nginx Proxy Manager

Configuración y Uso


¿Qué es BookStack?

BookStack es una plataforma de documentación y wiki de código abierto que organiza el contenido en una estructura jerárquica intuitiva: Libros → Capítulos → Páginas.

Características Principales

  • 📚 Organización Jerárquica: Libros, capítulos y páginas
  • ✏️ Editor Dual: WYSIWYG y Markdown
  • 🔍 Búsqueda Potente: Indexación completa del contenido
  • 🔐 Control de Acceso: Permisos granulares por rol
  • 📝 Historial de Cambios: Seguimiento completo de ediciones
  • 🖼️ Gestión de Imágenes: Biblioteca de medios integrada
  • 🔗 Integración: LDAP, SAML 2.0, OAuth (Google, GitHub, etc.)
  • 🌍 Multi-idioma: Soporte para múltiples idiomas incluido español

Casos de Uso

  • Documentación técnica: Manuales, guías, procedimientos
  • Base de conocimiento: Wiki corporativa, FAQ
  • Documentación de proyectos: Desarrollo de software
  • Políticas y procedimientos: Compliance, ISO, GDPR
  • Notas colaborativas: Equipos distribuidos

Inicio Rápido

Requisitos

  • Docker Engine
  • Portainer (recomendado)
  • Red proxy creada
  • MariaDB 12 (incluido en el compose)

Generar Claves y Contraseñas

ANTES de desplegar, genera las claves necesarias:

# APP_KEY (BookStack)
docker run -it --rm --entrypoint /bin/bash lscr.io/linuxserver/bookstack:latest appkey

# DB_PASSWORD (MariaDB)
openssl rand -base64 32

⚠️ Importante: Si la contraseña contiene caracteres especiales ($, !, etc.), usa comillas simples en el .env:

DB_PASSWORD='tu_password_con_$_especiales'

Despliegue Básico

  1. Crea el stack en Portainer con Git Repository:

    • URL: https://git.ictiberia.com/groales/bookstack
    • Compose path: docker-compose.yml
  2. Añade variables de entorno:

    APP_KEY=base64:tu_clave_generada
    DB_PASSWORD=password_generado
    DOMAIN_HOST=bookstack.tudominio.com
    
  3. Deploy y espera 1-2 minutos (BookStack inicializa la BD)

  4. Accede y configura según tu proxy inverso:

    • Traefik: https://bookstack.tudominio.com
    • NPM: Configura Proxy Host primero
    • Login: Email admin@admin.com + password password ¡CÁMBIALO INMEDIATAMENTE!

Arquitectura

┌─────────────────────────────────────────────────┐
│          Traefik / NPM (Proxy)                  │
│              HTTPS / SSL                        │
└────────────────┬────────────────────────────────┘
                 │
       ┌─────────▼──────────┐
       │     BookStack      │  Puerto 80
       │  (LinuxServer)     │
       └─────────┬──────────┘
                 │
           ┌─────▼──────┐
           │  MariaDB   │
           │     11     │
           └────────────┘
          (Base Datos)

Componentes

  • BookStack: Aplicación PHP Laravel (puerto 80)
  • MariaDB 12: Base de datos MySQL
  • Proxy: Traefik o NPM para HTTPS

Volúmenes

  • bookstack_config: Configuración, uploads, imágenes
  • bookstack_db: Base de datos MariaDB

Próximos Pasos

  1. Elige tu modo de despliegue:

    • Traefik - Recomendado para múltiples servicios
    • NPM - Más simple para configurar
  2. Configura BookStack:

  3. Protege tus datos:

  4. Mantén actualizado:


Recursos Oficiales