starred/BookStack
1
0
Fork 0
mirror of https://github.com/BookStackApp/BookStack.git synced 2026-02-05 00:29:48 +03:00
Code Issues 304 Packages Projects Releases 10 Wiki Activity

"Suggested Optimizations" and "Health Check" on Maintenance page #1200

New Issue
Closed
opened 2026-02-05 00:14:07 +03:00 by OVERLORD · 2 comments
OVERLORD commented 2026-02-05 00:14:07 +03:00
Owner
Copy Link

Originally created by @DeftNerd on GitHub (May 23, 2019).

There are various optional things administrators can do to improve the functionality of BookStack, as well as things that might cause problems for users if they're not configured right.

It would be nice if the Maintenance page had a section where some "Suggested Optimizations" and "Health Problems" could be displayed.

This would allow users to improve the responsiveness and dependability of their BookStack Installation. I'm happy to take a crack at building the initial framework and features for this section along with a few basic checks, and then let the community decide what optimizations/health checks should be included down the line.

Many of these items are easy enough to accomplish, but would require the community of wonderful volunteer translators to help with some pretty technical phrasing.

Some possible things that could be included (open to removing some, or adding others, this is more about seeing if the general concept is welcome):

Suggested Optimizations

  • Installing 'wkhtmltopdf' can improve the quality and speed of PDF generation. (help link)
  • You can improve speed and responsiveness by using Memcache or Redis to cache information (help link)
  • You can improve speed by upgrading your PHP version from 7.0 to 7.4 (help link)
  • You are running BookStack v0.25.1. The latest version is v0.26.2. It's suggested that you update. (help link)
  • You can improve speed and responsiveness by caching your routes and config (help link)
  • PHP is configured to only allow uploads of under 1mb. It's suggested that you increase this. (help link)
  • Nginx is configured to only allow uploads of under 1mb. It's suggested that you increase this. (help link)

Health Check

  • Permissions: PHP is running as 'www-user' but some files do not have the proper ownership set. (help link)
  • You have dependency package updates available. It's suggested you run 'composer update' (help link)
  • You have outstanding database migrations that need to be run. (help link)
  • You are using an unencrypted connection to LDAP for authentication. It's suggested that you use encrypted connections (help link)
  • Your database was created a while ago and needs to be upgraded to support UTF8mb4/Emoji's. (help link)
Originally created by @DeftNerd on GitHub (May 23, 2019). There are various optional things administrators can do to improve the functionality of BookStack, as well as things that might cause problems for users if they're not configured right. It would be nice if the Maintenance page had a section where some "Suggested Optimizations" and "Health Problems" could be displayed. This would allow users to improve the responsiveness and dependability of their BookStack Installation. I'm happy to take a crack at building the initial framework and features for this section along with a few basic checks, and then let the community decide what optimizations/health checks should be included down the line. Many of these items are easy enough to accomplish, but would require the community of wonderful volunteer translators to help with some pretty technical phrasing. Some possible things that could be included (open to removing some, or adding others, this is more about seeing if the general concept is welcome): > **Suggested Optimizations** > > * Installing 'wkhtmltopdf' can improve the quality and speed of PDF generation. (help link) > * You can improve speed and responsiveness by using Memcache or Redis to cache information (help link) > * You can improve speed by upgrading your PHP version from 7.0 to 7.4 (help link) > * You are running BookStack v0.25.1. The latest version is v0.26.2. It's suggested that you update. (help link) > * You can improve speed and responsiveness by caching your routes and config (help link) > * PHP is configured to only allow uploads of under 1mb. It's suggested that you increase this. (help link) > * Nginx is configured to only allow uploads of under 1mb. It's suggested that you increase this. (help link) > > **Health Check** > * Permissions: PHP is running as 'www-user' but some files do not have the proper ownership set. (help link) > * You have dependency package updates available. It's suggested you run 'composer update' (help link) > * You have outstanding database migrations that need to be run. (help link) > * You are using an unencrypted connection to LDAP for authentication. It's suggested that you use encrypted connections (help link) > * Your database was created a while ago and needs to be upgraded to support UTF8mb4/Emoji's. (help link) > >
OVERLORD added the 🔨 Feature Request label 2026-02-05 00:14:07 +03:00
OVERLORD commented 2026-02-05 00:14:10 +03:00
Author
Owner
Copy Link

@ssddanbrown commented on GitHub (May 25, 2019):

Thanks for the suggestion @DeftNerd.

I can see the use-case, but I'm worried many of these types of checks will be quite system-dependant and frail where there can be a lot of variance in system-level setup, leading to a lot of support and maintenance of such a system.

I can see this being more worthwhile if we focused it on the installation process for now, with checks being more BookStack-config focused instead of system focused. So things like "Database connection found" and "Mail configuration set". It could be command-line focused for now to prevent needing to maintain extra UI.

@ssddanbrown commented on GitHub (May 25, 2019): Thanks for the suggestion @DeftNerd. I can see the use-case, but I'm worried many of these types of checks will be quite system-dependant and frail where there can be a lot of variance in system-level setup, leading to a lot of support and maintenance of such a system. I can see this being more worthwhile if we focused it on the installation process for now, with checks being more BookStack-config focused instead of system focused. So things like "Database connection found" and "Mail configuration set". It could be command-line focused for now to prevent needing to maintain extra UI.
OVERLORD commented 2026-02-05 00:14:14 +03:00
Author
Owner
Copy Link

@ssddanbrown commented on GitHub (Sep 8, 2025):

Since there's been little further desire for this I'm going to go ahead and close it off.
Thanks for the original request @DeftNerd!

@ssddanbrown commented on GitHub (Sep 8, 2025): Since there's been little further desire for this I'm going to go ahead and close it off. Thanks for the original request @DeftNerd!
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
🎨 Design
📖 Docs Update
🐛 Bug
🐛 Bug
:cat2:🐈 Possible duplicate
💿 Database
☕ Open to discussion
💻 Front-End
🐕 Support
🚪 Authentication
🌍 Translations
🔌 API Task
🏭 Back-End
⛲ Upstream
🔨 Feature Request
🛠️ Enhancement
🛠️ Enhancement
🛠️ Enhancement
❤️ Happy feedback
🔒 Security
🔍 Pending Validation
💆 UX
📝 WYSIWYG Editor
🌔 Out of scope
🔩 API Request
:octocat: Admin/Meta
🖌️ View Customization
❓ Question
🚀 Priority
🛡️ Blocked
🚚 Export System
♿ A11y
🔧 Maintenance
> Markdown Editor
No Label 🔨 Feature Request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
OVERLORD
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/BookStack#1200
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?