Documentation (installation) — BookStack

Cited by

Facts read from this source

• Php requirement Report an error

  “PHP >= 8.2”

• Php extensions required Report an error

  “Required Extensions: curl, dom, gd, iconv, mbstring, mysqlnd, openssl, pdo, pdo_mysql, tokenizer, xml, zip.”

• Php extensions optional Report an error

  “Optional Extensions: ldap (If wanting to use LDAP Auth), exif (For accurate image rotation handling).”

• Database requirement Report an error

  “MySQL >= 8.0 or MariaDB >= 10.6”

• Composer requirement Report an error

  “Composer >= v2.2.0”

• Git requirement Report an error

  “Git Version Control For application of updates when following our standard process.”

• Shared hosting support Report an error

  “BookStack does not currently support shared PHP hosting.”

• Default admin credentials Report an error

  “Done! You can now login using the default admin details admin@admin.com with a password of password. You should change these details immediately after logging in for the first time.”

• Self hosted Report an error

  “Below you can find details on how to install BookStack on your own hosting.”

• Ubuntu 2604 script Report an error

  “We provide a script to install BookStack on a fresh instance of Ubuntu 26.04. This script is ONLY FOR A FRESH OS, it will install Apache, MySQL 8.4 & PHP 8.5 and could OVERWRITE any existing web setup on the machine.”

• Ubuntu 2404 script Report an error

  “A script to install BookStack on a fresh instance of Ubuntu 24.04 is available. This script is ONLY FOR A FRESH OS, it will install Apache, MySQL 8.0 & PHP 8.3 and could OVERWRITE any existing web setup on the machine.”

• Ubuntu 2204 script Report an error

  “A script to install BookStack on a fresh instance of Ubuntu 22.04 is available. This script is ONLY FOR A FRESH OS, it will install Apache, MySQL 8.0 & PHP 8.4 and could OVERWRITE any existing web setup on the machine.”

• Scripts official ubuntu only Report an error

  “We only officially provide scripts and guidance for the above in-support Ubuntu LTS operating systems.”

• Community guides unsupported Report an error

  “Keep in mind we don’t specifically provide support for these scripts or listed environments.”

• Docker community setups Report an error

  “Community docker setups are available for those that would prefer to use a containerised version of BookStack:”

• High availability support Report an error

  “High availability is not something we assure to support. There may be scenarios that will not allow availability.”

• Storage default filesystem Report an error

  “Uploaded files use the local filesystem by default. You could instead use S3 or an S3 like storage system for these files.”

• Sessions cache default Report an error

  “Sessions and Cache use the local filesystem by default. The database/memcached/redis options allow sharing across instances.”

• Status endpoint Report an error

  “A simplistic health-check endpoint can be found at the /status URI.”

• Release branch stable channel Report an error

  “This project currently uses the release branch of the BookStack code repository as a stable channel for providing updates.”

• Ubuntu 2604 script no default credentials Report an error

  “Compared to our previous scripts, this will not result in default login credentials. You’ll provide an admin user account email address while running the script, and an initial randomly generated password will be provided at the end of the script.”

• Third party hosting options unsupported Report an error

  “Note: These are not tested, vetted nor supported by the official BookStack project in any manner.”

Scores citing this record

• The Engineering Lead Import, export & self-hosting
• The Engineering Lead European sovereignty
• The IT Administrator Import, export & self-hosting
• The IT Administrator European sovereignty
• The Operations Lead Import, export & self-hosting
• The Operations Lead European sovereignty
• The Quality Manager Import, export & self-hosting
• The Skeptic Import, export & self-hosting
• The Support Knowledge Manager Import, export & self-hosting
• The Support Knowledge Manager European sovereignty