Maintenance/Service Mode #5249

New Issue

OVERLORD · 2026-02-05T09:51:18+03:00

OVERLORD commented

2026-02-05 09:51:18 +03:00

Originally created by @Jeffrey-FB on GitHub (Apr 7, 2025).

Describe the feature you'd like

In Maintenance Mode

Describe the benefits this would bring to existing BookStack users

We would like to be able to have a feature to have a 'Maintenance Mode' Pop-up when users login, which disables the user from making changes. So updates can be applied and tested on a Branch.

This would mean that there would be no downtime of bookstack while updating and users can continue to browse the library as required.

Can the goal of this request already be achieved via other means?

Not with out down time of our bookstack site.

Have you searched for an existing open/closed issue?

I have searched for existing issues and none cover my fundamental request

How long have you been using BookStack?

1 to 5 years

Additional context

When this is enabled Users will not be able to make changes to bookstack. Except for Users in the Maintenance Group.

This would allow us to use our our git/bitbucket to branch out our bookstack, apply updates.
Then test all the features are working correctly.
Then commit this branch as the master.
Once turned off. The Maintenance Mode uses can continue to work as normal.

This would mean that there would be no downtime of bookstack and users can continue to browse the library as required.

Originally created by @Jeffrey-FB on GitHub (Apr 7, 2025). ### Describe the feature you'd like In Maintenance Mode ### Describe the benefits this would bring to existing BookStack users We would like to be able to have a feature to have a 'Maintenance Mode' Pop-up when users login, which disables the user from making changes. So updates can be applied and tested on a Branch. **This would mean that there would be no downtime of bookstack while updating and users can continue to browse the library as required.** ### Can the goal of this request already be achieved via other means? Not with out down time of our bookstack site. ### Have you searched for an existing open/closed issue? - [x] I have searched for existing issues and none cover my fundamental request ### How long have you been using BookStack? 1 to 5 years ### Additional context When this is enabled Users will not be able to make changes to bookstack. Except for Users in the Maintenance Group. This would allow us to use our our git/bitbucket to branch out our bookstack, apply updates. Then test all the features are working correctly. Then commit this branch as the master. Once turned off. The Maintenance Mode uses can continue to work as normal. This would mean that there would be no downtime of bookstack and users can continue to browse the library as required.

OVERLORD added the 🔨 Feature Request label 2026-02-05 09:51:18 +03:00

OVERLORD commented

2026-02-05 09:51:21 +03:00

@ssddanbrown commented on GitHub (Apr 7, 2025):

Thanks for the suggestion @Jeffrey-FB.
Personally, I don't feel it'd be worthwhile to maintain a read-only mode like that, for what hasn't really been reported to be much of an issue. Generally the update process should be relatively quick and I try to prioritise stability in our upgrade path, but it sounds like you may have a bit more going on than a usual instance.

Depending on your scenario/use-case, having a staging instance work-flow (production clone to test updates upon), may be an alternative.

If it helps, there is a basic (prevents access with a message) maintenance mode built into the framework, used by BookStack, via commands ran from your BookStack install:

# Take the site down
php artisan down

# Bring the site back up
php artisan up

# Take the site down, but generate a secret path which will provide access for testing
php artisan down --with-secret

@ssddanbrown commented on GitHub (Apr 7, 2025): Thanks for the suggestion @Jeffrey-FB. Personally, I don't feel it'd be worthwhile to maintain a read-only mode like that, for what hasn't really been reported to be much of an issue. Generally the update process should be relatively quick and I try to prioritise stability in our upgrade path, but it sounds like you may have a bit more going on than a usual instance. Depending on your scenario/use-case, having a staging instance work-flow (production clone to test updates upon), may be an alternative. If it helps, there is a basic (prevents access with a message) maintenance mode built into the framework, used by BookStack, via commands ran from your BookStack install: ```bash # Take the site down php artisan down # Bring the site back up php artisan up # Take the site down, but generate a secret path which will provide access for testing php artisan down --with-secret ```

OVERLORD commented

2026-02-05 09:51:23 +03:00

@Jeffrey-FB commented on GitHub (Apr 8, 2025):

Thanks @ssddanbrown we'll give that ago.

@Jeffrey-FB commented on GitHub (Apr 8, 2025): Thanks @ssddanbrown we'll give that ago.

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/BookStack#5249