BookStack is an opinionated wiki system that provides a pleasant and simple out of the box experience. New users to an instance should find the experience intuitive and only basic word-processing skills should be required to get involved in creating content on BookStack. The platform should provide advanced power features to those
that desire it but they should not interfere with the core simple user experience.

BookStack is not designed as an extensible platform to be used for purposes that differ to the statement above.

In regards to development philosophy, BookStack has a relaxed, open & positive approach. Put simply, At the end of the day this is free software developed and maintained by people donating their own free time.

This chart bootstraps a Bookstack deployment on a Kubernetes cluster using the Helm package manager. It also uses the MariaDB chart which satisfies the database requirements of the application.

 

Translations

 

As part of BookStack v0.14 support for translations has been built in. All text strings can be found in the resources/lang folder where each language option has its own folder. To add a new language you should copy the en folder to an new folder (eg. fr for french) then go through and translate all text strings in those files, leaving the keys and file-names intact.

If a language string is missing then the en translation will be used. To show the language option in the user preferences language drop-down you will need to add your language to the options found at the bottom of the resources/lang/en/settings.php file. A system-wide language can also be set in the .env file like so: APP_LANG=en.

 

Prerequisites

 

  • Kubernetes 1.9+ with Beta APIs enabled
  • PV provisioner support in the underlying infrastructure

Code Standards

 

PHP code within BookStack is generally to PSR-2 standards. From the BookStack root folder you can run ./vendor/bin/phpcs to check code is formatted correctly and ./vendor/bin/phpcbf to auto-fix non-PSR-2 code.

Tell us about a new Kubernetes application

Newsletter

Never miss a thing! Sign up for our newsletter to stay updated.

About

Discover and learn about everything Kubernetes

Navigation