BookStack op engem Managed VPS hosten: Är Dokumentatioun bei Iech

Wat BookStack mécht

BookStack ass eng Dokumentatiounsplattform, déi geduecht ass, einfach ze bleiwen: säi README zielt op eng direkt Handhabung of, mat einfache Notioune vun der Textveraarbechtung. Är Equippe schreiwen do hir Prozeduren, hir Dokumentatioun an hir Wëssensbasis, an engem Browser, op Franséisch, wa se wëllen.

• Véier Niveaue vum Ranger: d’Regaler versammele Bicher, d’Bicher droen Kapitelen a Säiten, d’Kapitele sinn fakultativ, an den Inhalt lieft an de Säiten.
• Zwee Editeuren: e visuellen Editeur als Standard, an e Markdown-Editeur mat Live-Apercu, zu deenen d’Schemaen vun diagrams.net derbäikommen.
• D’Sich: an engem Buch, oder iwwer all d’Bicher, Kapitelen a Säiten.
• D’Rechter: Rollen fir dat ganzt System, a Permissiounen, déi engem Regal, engem Buch, engem Kapitel oder enger Säit eegen sinn.
• D’Verbindungen: E-Mail a Passwuert, OpenID Connect, SAML 2.0, LDAP, mat enger Zwee-Faktor-Authentifiséierung duerch eng App oder duerch Noutcoden, déi een pro Roll opzwénge kann.
• D’Verfolgung an d’Austausch: de Verlaf vun de Revisioune vun all Säit, eng REST-API, an den Export an HTML, PDF, Text, Markdown oder portabelen ZIP.

De Projet steet zu senge Wahlen: säi README preziséiert, datt BookStack net als Plattform konzipéiert ass, déi sech fir aner Notzunge erweideren léisst, an et bleift der Dokumentatioun verflicht. Säi PDF-Rendering geet iwwer dompdf, ouni zousätzlech Installatioun, mat limitéierte Kapazitéiten; de Projet dokumentéiert aner Moteuren mat EXPORT_PDF_COMMAND.

Wat d’MIT-Lizenz erlaabt

BookStack gëtt ënner der MIT-Lizenz vum Dan Brown an de Contributeure vum Projet publizéiert. Si erlaabt all Notzung, all Ännerung an all Verdeelung, ënner enger Bedingung: de Copyright-Hiweis an den Text vun der Lizenz an all Kopie vun der Software ze behalen. D’FAQ vum Projet preziséiert, datt dës Attributioun de Code betrëfft, deen Dir deelt: näischt verflicht Iech, den Numm oder d’Logo vu BookStack op Ärer Instanz unzeweisen.

De Projet hält eng eenzeg Versioun, fräi a gratis: hie bitt keng Entreprise-Editioun un, an hie huet keen offiziellen Hosting, nach de Plang, een opzemaachen. Hie verkeeft allerdéngs Support-Formelen, déi mat de Spenden a Parrainagen zu senger Finanzéierung bäidroen. BookStack installéiert sech also op Ärem Server, ouni eng Lizenz ze kafen.

D’Viraussetzunge vu BookStack

Docker bleift fakultativ. De Projet publizéiert keng offiziell Image: d’Installatioune vu Containeren kommen vu Gemeinschaftsprojeten, LinuxServer.io a solidnerd. Dëse Guide follegt dem offizielle Wee, PHP a MySQL direkt um Server, deen näischt méi verlaangt.

D’Dokumentatioun schléisst gedeelten PHP-Hosting aus: BookStack verlaangt e Server, deen Dir administréiert. Si gëtt weder Aarbechtsspäicher nach Prozessor un, déi néideg sinn. Op engem Managed VPS beschreift eis Äre Gebrauch, d’Zuel vu Leit an de Volumen vu Biller an Unhäng, a mir recommandéieren Iech déi passend Gréisst.

D’Installatioun vu BookStack

De Projet proposéiert zwee Weeër: e Skript fir Ubuntu, dee kuerzsten op engem neie Server, an eng manuell Installatioun fir all aner Fäll.

Mam Skript vum Projet, op engem brandneien Ubuntu

wget https://codeberg.org/bookstack/devops/raw/branch/main/scripts/installation-ubuntu-24.04.sh
chmod a+x installation-ubuntu-24.04.sh
sudo ./installation-ubuntu-24.04.sh

Dës Skripte si fir e frësch installéierte System reservéiert: si kënnen eng bestoend Web-Konfiguratioun iwwerschreiwen. Si loossen och zwee Themen eraus, d’E-Mail-Astellungen an d’Sécherheet vum System, déi separat ze plangen sinn.

D’Skript setzt BookStack an /var/www/bookstack. Dat fir Ubuntu 26.04 freet no der Domain an der Adress vum Kont vum Administrateur, a weist dann um Enn e Passwuert un, dat zoufälleg gezunn ass an net a sengem Logbuch steet: notéiert et. Mat engem anere Skript liest d’Zougäng of, déi um Enn ugewise ginn, an ännert all Standardzougang vun der éischter Verbindung un.

Vun Hand, op all anerer Maschinn

Fänkt mat der Datebank un: eng Datebank, an e Benotzer, deen op dës Datebank limitéiert ass. D’Skript vum Projet geet esou vir, mat dem Passwuert no Ärer Wiel amplaz vun change-me:

sudo mysql -u root --execute="CREATE DATABASE bookstack;"
sudo mysql -u root --execute="CREATE USER 'bookstack'@'localhost' IDENTIFIED BY 'change-me';"
sudo mysql -u root --execute="GRANT ALL ON bookstack.* TO 'bookstack'@'localhost';FLUSH PRIVILEGES;"

Hëlt dann d’Branche release, setzt d’Rechter, déi d’Dokumentatioun fir /var/www/bookstack gëtt, an installéiert dann d’Ofhängegkeeten:

cd /var/www
sudo git clone https://source.bookstackapp.com/bookstack.git --branch release --single-branch bookstack
sudo chown -R $USER:www-data /var/www/bookstack
sudo chmod -R 755 /var/www/bookstack
sudo chmod -R 775 /var/www/bookstack/storage /var/www/bookstack/bootstrap/cache /var/www/bookstack/public/uploads
cd bookstack
composer install --no-dev
cp .env.example .env
sudo chmod 640 .env

Fëllt d’Datebank an d’Adress an .env aus:

APP_URL=https://docs.example.com
DB_HOST=localhost
DB_DATABASE=bookstack
DB_USERNAME=bookstack
DB_PASSWORD=change-me

php artisan key:generate
php artisan migrate

Setzt schliisslech d’Web-Wuerzel op den Dossier public: DocumentRoot ënner Apache, root ënner Nginx. Ouni Apache, oder wann d’Fichieren .htaccess desaktivéiert sinn, setzt d’Reegele fir d’Ëmschreiwe vun den Adressen derbäi: de Projet publizéiert Beispiller fir Apache a fir Nginx.

Eng manuell Installatioun mécht sech mam Kont admin@admin.com an dem Passwuert password op. Ännert d’Adress an d’Passwuert vun der éischter Verbindung un.

HTTPS an APP_URL

D’Besucher kommen op de Ports 80 an 443 un, ënner dem Domainnumm vum Server. Erstellt fir dësen Numm A- an AAAA-Enregistremer, a frot dann d’Zertifikat un: d’Skript vun Ubuntu 26.04 konfiguréiert Apache nëmmen um Port 80, an d’Installatiounssäit léisst HTTPS Iech iwwer. Certbot setzt d’Zertifikat vu Let’s Encrypt, passt Apache un an erneiert d’Zertifikat vu sech aus. Ënner Nginx ersetzt --apache duerch --nginx.

sudo snap install --classic certbot
sudo ln -s /snap/bin/certbot /usr/local/bin/certbot
sudo certbot --apache -d docs.example.com

Setzt dann d’Adress an .env op HTTPS. APP_URL muss exakt der Besuchsadress entspriechen, Präfix abegraff: en Ënnerscheed gesäit een u fehlende Stiler, iwwerdriwwene Ikonen a futtise Menüen. Eng Adress a https aktivéiert vu sech aus déi séier Cookies.

APP_URL=https://docs.example.com

Wann et schonn Säite gëtt, behalen hir Linken déi al Adress an der Datebank. Séchert d’Datebank, a lancéiert dann de Befehl vum Projet:

php artisan bookstack:update-url http://docs.example.com https://docs.example.com

BookStack gëtt op der Wuerzel vun enger Domain oder Subdomain servéiert, an d’Dokumentatioun beschreift och eng Installatioun ënner engem Ënnerdossier, wéi example.com/bookstack. Wann e Reverse Proxy virun Apache kënnt, deklaréiert seng Adress an APP_PROXIES: ouni si gesi d’Audit-Logbuch an d’Limitatioun vum Débit d’Adress vum Proxy amplaz vun där vun de Besucher. D’Dokumentatioun reservéiert APP_PROXIES="*" der Diagnos.

Wou Är Donnéeën liewen

Behält déiselwecht APP_KEY iwwer d’Zäit an séchert se. BookStack benotzt se, fir ënner anerem d’Geheimnisser vun der Zwee-Faktor-Authentifiséierung ze verschlësselen: se ze änneren kann dës Funktiounen futti maachen, an zënter der Versioun 26.09 gëtt d’Applikatioun e Feeler zeréck, wann si feelt.

D’Biller sinn standardméisseg ëffentlech

Mam Standardspäicher servéiert de Webserver d’Biller direkt, wat séier geet, a jiddereen, deen hir Adress kennt, ka se opmaachen. Fir eng intern Dokumentatioun gëtt d’Wiel an STORAGE_TYPE gemaach:

Fir déi schwéier Fichieren stëmmen dräi Astellungen openeen of: FILE_UPLOAD_SIZE_LIMIT an .env, post_max_size an upload_max_filesize an php.ini, an client_max_body_size ënner Nginx, dat standardméisseg 1 MB ass.

Zwou Astellunge zielen och fir eng liewegt Dokumentatioun: all Säit behält standardméisseg 100 Revisiounen (REVISION_LIMIT), an de Pabeierkuerf hält déi geläscht Elementer 30 Deeg (RECYCLE_BIN_LIFETIME).

D’E-Mailen: SMTP a Waardeschlaang

BookStack schéckt E-Mailen fir d’Bestätegung vun den Adressen, d’Vergiesse vum Passwuert, d’Invitatiounen an d’Notifikatiounen. Vun engem Simafri-VPS aus geet de Versand iwwer e authentifizéierte SMTP-Relais, um Port 587: d’Adress vun engem E-Mail-Kont, deen Dir schonn hutt, oder Simafri Suite.

MAIL_DRIVER=smtp
MAIL_HOST=smtp.example.com
MAIL_PORT=587
MAIL_ENCRYPTION=tls
MAIL_USERNAME=bookstack@example.com
MAIL_PASSWORD=change-me
MAIL_FROM=bookstack@example.com
MAIL_FROM_NAME=BookStack

Kontrolléiert d’Resultat ënner „Settings“, „Maintenance“, mat der Aktioun „Send a Test Email“, déi d’Feeler weist, déi opgetruede sinn. E Feeler bei enger Invitatioun weist sech um Ecran, wärend e Feeler bei enger Notifikatioun am Logbuch vun der Applikatioun bleift.

Am Hannergrond schécken

Standardméisseg schéckt BookStack E-Mailen a Webhooks wärend der Ufro, wat d’Säiten lues maache ka. Fir an den Hannergrond ze wiesselen, schreift QUEUE_CONNECTION=database an .env a looss e Service lafen, mam Beispill, dat d’Dokumentatioun fir eng Ubuntu-Installatioun mat Skript gëtt:

[Unit]
Description=BookStack Queue Worker

[Service]
User=www-data
Group=www-data
Restart=always
ExecStart=/usr/bin/php /var/www/bookstack/artisan queue:work --sleep=3 --tries=1 --max-time=3600

[Install]
WantedBy=multi-user.target

sudo systemctl daemon-reload
sudo systemctl enable bookstack-queue.service
sudo systemctl start bookstack-queue.service

Är BookStack-Instanz ofsécheren

D’Sécherheetsdokumentatioun gëtt eng Lëscht, déi vun der Installatioun un opzehuelen ass:

1. Ännert d’Adress an d’Passwuert vum éischten Administrateur.
2. Kontrolléiert, datt de Webserver just den Dossier public servéiert, virun allem wann BookStack ënner /var/www lieft.
3. Limitéiert de Benotzer vun der Datebank op déi eenzeg Datebank vu BookStack.
4. Fëllt APP_URL aus, fir datt d’Adressen, déi vum System generéiert ginn, net manipuléiert kënne ginn.
5. Liest d’Astellunge fir d’Umeldung an den ëffentlechen Zougang nei, dann d’Rollen.

D’Zwee-Faktor-Authentifiséierung léisst sech duerno pro Roll opzwénge. Mellt Iech och bei der Sécherheets-Verdeelerlëscht vum Projet un, fir seng Alerten ze kréien. D’Adress /status déngt enger Iwwerwaachung: si äntwert 200, wann alles gutt geet, an e Feelercode vu 400 oder méi soss.

PHP zielt esou vill wéi BookStack. De Projet huet den 21. Oktober 2026 eng Alert iwwer eng kritesch Aktualiséierung vu PHP publizéiert, korrigéiert an 8.5.12, 8.4.27, 8.3.36 an 8.2.35. Ubuntu publizéiert dës Korrekture ënner senge eegene Paketnummeren, wéi 8.3.6-0ubuntu0.24.04.13 fir Ubuntu 24.04.

Fir Är Inhalter looss de Filter aktivéiert, deen et standardméisseg ass, a reservéiert seng Lockerung fir d’Instanzen, wou just Leit vum Vertrauen schreiwen. Wann e Kont vum Administrateur verluer geet, erstellt php artisan bookstack:create-admin en anert, an php artisan bookstack:reset-mfa hëlt d’Zwee-Faktor-Authentifiséierung vun engem Benotzer ewech.

Backups an Aktualiséierungen

Eng komplett Backup versammelt d’Datebank an déi véier Plaze vu Fichieren, déi Ärer Instanz eegen sinn. D’Exporter vum Inhalt déngen zu enger anerer Saach: d’Dokumentatioun preziséiert, datt si eng Backup net ersetzen.

sudo mysqldump -u root bookstack > bookstack.backup.sql
tar -czvf bookstack-files-backup.tar.gz .env public/uploads storage/uploads themes

Déi éischt Zeil zielt op eng Installatioun mat Skript, wou de root vu MySQL sech iwwer sudo verbënnt; anzwousch anescht schreift mysqldump -u bookstack -p bookstack. Leet dës zwee Fichieren separat of, am beschte op enger anerer Maschinn. D’Archiv enthält .env, also APP_KEY an Är Passwierder: behandelt se wéi e Geheimnis.

Restauréieren

Installéiert BookStack op enger neier Maschinn, ouni php artisan migrate ze lancéieren, e Schrëtt, deen am Skript ze kommentéiere ass, wann Dir et benotzt, restauréiert dann d’Datebank an d’Fichieren, andeems Dir déi ursprénglech APP_KEY behält:

sudo mysql -u root bookstack < bookstack.backup.sql
tar -xvzf bookstack-files-backup.tar.gz

Wann déi installéiert Versioun méi nei ass wéi d’Backup, lancéiert duerno php artisan migrate. Setzt d’Schreifrechter vum Webserver op de restauréierten Dossieren erëm. Wann d’Adress geännert huet, korrigéiert APP_URL a lancéiert bookstack:update-url.

Aktualiséieren

Séchert d’Datebank an d’Fichieren virun all Aktualiséierung, dann, aus dem Dossier vu BookStack:

git pull origin release
composer install --no-dev
php artisan migrate
php artisan cache:clear
php artisan config:clear
php artisan view:clear

D’Skript fir Ubuntu 26.04 installéiert BookStack ouni Composer. D’Säit vun den Aktualiséierunge proposéiert dann, als Beta, ./bookstack-system-cli download-vendor amplaz vun composer install --no-dev. Dëst selwecht Werkzeug kann och séchere a restauréieren, awer de Projet hält et nach net fir produktiounsreif: testt et, ier Dir Iech drop verléisst.

D’Dokumentatioun hält eng Lëscht vu Consignen, déi all Versioun eegen sinn, déi fir déi visééiert Versioun ze liesen ass. E puer Beispiller:

• Versioun 26.09: APP_KEY gëtt obligatoresch.
• Versioun 26.05: den Dossier storage/fonts muss fir de Webserver beschreifbar bleiwen, soss kënnen d’PDF-Exporter feelschloen.
• Versioun 26.03: probéiert de Versand vun E-Mailen no der Aktualiséierung.
• Versioun 25.11: grouss Ännerunge bei der Datebank, där hir Migratioun bei enger grousser Instanz e puer Minutte daueren kann.

D’Lécken ginn a Maintenance-Versiounen korrigéiert, wéi d’26.09.3 vum 11. November 2026: d’Biller an d’Zeechnunge vun enger Säit, déi nach en Entworf war oder am Dreckskuerf louch, bloufen zougänglech an ännerbar, an de perséinlechen Entworf vun engem Redakter konnt fir aner Leit siichtbar ginn.

Wien mécht wat op engem Managed VPS

Selwer hosten heescht, de Server zousätzlech zur Applikatioun ze halen. Op engem Managed VPS huelen eis Equippen de Server an d’Hand a verfollegen Är Instanz proaktiv; BookStack bleift Är Software, mat senge Astellungen an Donnéeën.

Wann Dir léiwer wëllt, datt eis Equippen an der Applikatioun selwer intervenéieren, gëtt dës Prestatioun op Stonnebasis oder pauschal verrechent, mat engem Käschtevirschlag, deen Iech virun der Interventioun matgedeelt gëtt.