Move your existing BookStack.

01 / PREPARE THE SOURCE

What you send us

Send a database dump of the BookStack database and one archive containing the uploads and files directories. Run these commands on your server, replacing the database name and paths with your own values:

# Database dump (use either command)
mysqldump --single-transaction --routines --triggers bookstack > bookstack.sql
mariadb-dump --single-transaction --routines --triggers bookstack > bookstack.sql

# Archive the BookStack uploads and files directories
tar -czf bookstack-files.tar.gz -C /path/to/bookstack uploads files

We do not need login credentials for your server. Your old instance can continue running while we work on the new one.

02 / REBUILD THE WORKSPACE

What we do

• Provision a new BookStack instance for your workspace.
• Import the database and the uploads/files archive.
• Run BookStack's own schema update so older supported versions are brought forward.
• Rewrite absolute links from the old address to the new one.
• Rebuild the search index and permissions.
• Create a backup before every change we make.

03 / YOUR ACCEPTANCE CHECK

What you check afterwards

• The number of books, pages and attachments is correct.
• You can sign in with the credentials from your existing system. Your old passwords remain valid; our initial password expires.
• Images and attachments open correctly.
• Search finds the content you expect.

04 / PLAN THE CHANGE

Timing and switch-over

The usual process lets your old instance keep serving people while the new instance is prepared and checked. Once you are happy, the switch is a DNS or bookmark change to the new address. We do not switch anything off on your server.

05 / KNOW THE BOUNDARIES

What we do not migrate today

• External login methods such as LDAP, SAML and OIDC need to be configured again on the new instance.
• S3 and other external file storage is not imported.
• We review very old BookStack versions before starting.
• Custom server extensions do not run on our hosting.