Skip to main content

BookStack - Instalace a Konfigurace

Návod pro instalaci a konfiguraci BookStack wiki pro Debian GNU/Linux s využitím Apache web serveru. Instalace je založená dle návodu k manuální instalaci na bookstackapp.com/docs/admin/installation/#manual. Veškeré proměnné, hesla apod jsou zde uvedeny jako příklad.. rozhodně si nastavte vlastní, jiné hesla.

Příprava

Systém

  • Prvně je potřeba opatřit si balíčky bez kterých se neobejdeme. 
    apt -yq update
apt install \
 sudo \
 curl \
 git \
 openssl \
 composer \
 mariadb-server \
 apache2 libapache2-mod-php \
 php php-common \
 php-ldap php-apcu php-fpm php-curl php-gd php-dompdf php-iconv php-mbstring php-mysql php-pdo-mysql php-tokenizer php-xml php-tidy php-zip

PHP

  • Nastavíme si v /etc/php/< verze php >/apache2/php.ini pro Apache větší paměťový limit a časové pásmo. 
    date.timezone = Europe/Amsterdam
memory_limit = 512M
  • V souboru /etc/php/< verze php >/fpm/php.ini si zvětšíme limit pro možnost uploadování větších souborů než 2MB. V mém případě beze strachu na 5GB 
    upload_max_filesize = 5000M
post_max_size = 5000M
memory_limit = 2048M

Apache

  • Aktivujeme Apache moduly: 
    a2enmod proxy_fcgi setenvif rewrite
  • Aktivujeme Apache konfigurační soubor pro naši verzi php, třeba 8.2: 
    a2enconf php8.2-fpm

Instalace

MariaDB

  • Za předpokladu že máme balíček mariadb-server, můžeme spustit příkaz mariadb-secure-installation který nás interaktivně provede instalací. V mém případě jsem odpovídal takto:
    • Switch to unix_socket authentication [Y/n] n
    • Change the root password? [Y/n] n
    • Remove anonymous users? [Y/n] Y
    • Disallow root login remotely? [Y/n] Y
    • Remove test database and access to it? [Y/n] Y
    • Reload privilege tables now? [Y/n] Y

Databázový server máme připravený, jdeme si jej nakonfigurovat.

  • Spustit příkaz: mariadb
    • Vytvoříme si databázi pro naši wiki, v mém případě baliwki: 
      CREATE DATABASE baliwiki;
    • Teď budeme potřebovat uživatele, který se k databázi bude připojovat. Vytvoříme si uživatele baliwiki s heslem abrakadabra a udělíme mu plné oprávnění na databázi baliwki: 
      CREATE USER baliwiki@localhost IDENTIFIED BY 'abrakadabra';
GRANT ALL ON baliwiki.* TO baliwiki@localhost WITH GRANT OPTION;

      🗒️ Nemělo by být potřeba, ale pokud se oprávnění neaplikují, odeslat příkaz: FLUSH PRIVILEGES;

    • Zobrazíme si oprávnění uživatele (pro kontrolu): 
      SHOW GRANTS FOR baliwiki@localhost;
    • Tady jsme hotovi, ukončíme pomocí: quit

BookStack

V mém případě jej umisťuji do /srv/http/bookstack, kde bude vystaven na portu 80 (http). Do internetu je aplikace přístupná přes webovou proxy (ukážeme si později).

  • Vytvořit adresáře a přejít do "webrootu": 
    mkdir -p /srv/http/{.config,.cache}
cd /srv/http

    🗒️ Adresáře .config a .cache slouží pro composer, lze je umístit jinde..

  • Stáhnout BookStack z GitHubu, z větve release. 
    git clone https://github.com/BookStackApp/BookStack.git --branch release --single-branch bookstack
  • Předat rekurzivně vlastnictví uživateli www-data, skupině www-data: 
    chown -R www-data:www-data {bookstack,config,cache}
  • Přejít do složky bookstack a zkopírovat si příklad(/základ) souboru .env: 
    cd bookstack
cp .env.example .env
  • Oeditovat si soubor .env svým oblíbeným texťákem, kde
    • APP_URL odkazuje na koncový bod. V mém případě schovávám server za reverzní proxy a musím uvést adresu té proxy, NE serveru. 
      APP_URL=https://baliwiki.balonkluk.cz

      ⚠️ Po každé změně této proměnné je nutné spustit příkaz k migraci URI v databázi.
      Například když migruji z interní adresy na http na reverzní proxy s https:
      php artisan bookstack:update-url http://baliwiki.in.balonkluk.cz https://baliwiki.balonkluk.cz.

      Nakonec ještě vyčistím cache: php artisan cache:clear

    • DB_HOST => localhost (pokud mám MariaDB na stejném serveru).
    • DB_DATABASE => baliwiki.
    • DB_USERNAME => baliwiki. Tohoto uživatele jsem si vytvářel při instalaci MariaDB.
    • DB_PASSWORD => abrakadabra. Toto heslo jsem nastavoval při instalaci MariaDB.
    • MAIL_DRIVER => smtp
    • MAIL_FROM_NAME => "BaliWiKi"
    • MAIL_FROM => baliwiki@balonkluk.cz (Z této emailové adresy budou chodit notifikace).
    • MAIL_HOST => mail.balonkluk.cz (Tento server bude použit jako SMTP relay pro odesílání e-mailů).
    • MAIL_PORT => 25. Server definovaný v MAIL_HOST bude kontaktován přes port 25.
    • FILE_UPLOAD_SIZE_LIMIT => 5000. Chtěl bych uploadovat až 5GB/5000MB velké soubory.
  • Nastavit jako uživatel www-data proměnnou COMPOSER_HOME do /srv/http a spustit update.

    ⚠️ Pokud jste adresáře .config a .cache vytvářeli jinde, změňte si adekvátně hodnotu proměnné.

    sudo -u www-data COMPOSER_HOME=/srv/http composer update
  • Spustit instalaci composera: 
    sudo -u www-data composer install --no-dev --no-plugins
  • Vygenerovat klíč aplikace. Tento klíč bude uložen v souboru .env v proměnné APP_KEY: 
    php artisan key:generate --no-interaction --force
  • Zmigrovat databázi do MariaDB (prvotně vytvořit): 
    php artisan migrate --no-interaction --force
  • Nastavit oprávnění tak, aby bylo vše jak má být: 
    chown www-data:www-data -R bootstrap/cache public/uploads storage 
chmod u+rw bootstrap/cache public/uploads storage
chmod -R 640 .env

Apache

  • Přepsat výchozí konfigurační soubor Apache: 
    cat > /etc/apache2/sites-available/000-default.conf << EOL
ServerName baliwiki.balonluk.cz
ServerAdmin balonluk@balonluk.cz

<VirtualHost *:80>
  DocumentRoot /srv/http/bookstack/public/
  <Directory /srv/http/bookstack/public/>
      Options Indexes FollowSymLinks
      AllowOverride None
      Require all granted
      <IfModule mod_rewrite.c>
          <IfModule mod_negotiation.c>
              Options -MultiViews -Indexes
          </IfModule>
          RewriteEngine On
          # Handle Authorization Header
          RewriteCond %{HTTP:Authorization} .
          RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]
          # Redirect Trailing Slashes If Not A Folder...
          RewriteCond %{REQUEST_FILENAME} !-d
          RewriteCond %{REQUEST_URI} (.+)/$
          RewriteRule ^ %1 [L,R=301]
          # Handle Front Controller...
          RewriteCond %{REQUEST_FILENAME} !-d
          RewriteCond %{REQUEST_FILENAME} !-f
          RewriteRule ^ index.php [L]
      </IfModule>
  </Directory>

  ErrorLog ${APACHE_LOG_DIR}/baliwiki-error.log
  CustomLog ${APACHE_LOG_DIR}/baliwiki-access.log combined
</VirtualHost>
EOL
  • Otestovat, že je konfigurace v pořádku: 
    apachectl configtest
  • Restartovat webserver: 
    systemctl restart apache2
Back to top