Documentation (backup and export) — BookStack

Cited by

Facts read from this source

• Backup builtin Report an error

  “While BookStack does not currently have a built-in way to backup and restore content, it can usually be done via the command line with relative ease.”

• Backup database method Report an error

  “The easiest way to backup the database is via mysqldump:”

• Backup file locations Report an error

  “.env - File, contains important configuration information. public/uploads - Folder, contains any uploaded images. storage/uploads - Folder, contains uploaded page attachments. themes - Folder, contains any configured visual/logical themes.”

• Restore database method Report an error

  “To restore the database you simply need to execute the sql in the output file from the mysqldump you performed above.”

• Restore migrate requirement Report an error

  “If you are restoring to a new version of BookStack you will have to run php artisan migrate after restore to perform any required updates to the database.”

• App key importance Report an error

  “you should use the APP_KEY value of the old .env file since this is used for various features like the encryption of multi-factor authentication credentials. Changing the APP_KEY may cause such features to break.”

• URL restore command Report an error

  “Within the .env config file update the APP_URL value to exactly match your new base URL. Run the “Update System URL” command to update your database content to use your new URL.”

• Backup docker support Report an error

  “If you are using a docker-container-based set-up, restore the database before running the BookStack container. An example of the process using a linuxserver.io-based docker-compose setup can be seen in our video here.”

Scores citing this record

• The Engineering Lead Import, export & self-hosting
• The Quality Manager Import, export & self-hosting
• The Skeptic Import, export & self-hosting
• The Support Knowledge Manager Import, export & self-hosting