-
-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Description
Describe the feature you'd like
I think the Theme Module system introduced in BookStack v26.03 is an excellent feature.
After trying it out, I'd like to propose a couple of usability improvements as feature requests.
All requests below concern the behavior of php artisan bookstack:install-module when installing from a ZIP.
- When a ZIP contains a single top-level folder, attempt to locate the module from within that folder.
- When installing from a URL, handle redirect responses.
Describe the benefits this would bring to existing BookStack users
Supporting the points above would make it much easier to install modules directly from repository hosting services.
Services such as GitHub and Codeberg provide a way to download a repository as a ZIP.
If those ZIP URLs could be used for installation, module authors would only need to publish their module in a repository to make it distributable, and module users could rely on the repository contents as the ZIP contents, which would be very convenient.
ZIP files downloadable from those services typically include a top-level directory named after the repository.
In addition, GitHub’s ZIP download link on the web UI returns an HTTP 302 redirect.
Because of these factors, the current implementation cannot install those ZIPs directly.
Workarounds or alternative steps are required today, but adding the requested support would remove that extra effort.
Can the goal of this request already be achieved via other means?
It is possible to work around this by placing a properly structured ZIP in a dedicated distribution repository.
Redirects can be avoided by using the final redirected URL directly.
Users can also download and extract the ZIP locally to inspect its contents.
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
No response