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 305 Packages Projects Releases 10 Wiki Activity

Minio Implementation for Amazon S3 #967

New Issue
Closed
opened 2026-02-04 23:13:21 +03:00 by OVERLORD · 3 comments
OVERLORD commented 2026-02-04 23:13:21 +03:00
Owner
Copy Link

Originally created by @armouredking on GitHub (Dec 23, 2018).

Describe the feature you'd like
Bookstack does not apparently allow you to set a URL for S3. I'm not 100% certain about the STORAGE_URL field, but given the Laravel logs I have to assume it does not do what I'm thinking it would/should.

Describe the benefits this feature would bring to BookStack users
Minio is a compatible stack, and given that quite a few people using BookStack will be self hosted, supporting Minio should be implemented. And it should be fairly easily done. RocketChat accomplishes this simply by allowing you to specify the link (instead of trying to magic it into existence as it seems is currently done).

Additional context
Log entry:

[2018-12-23 02:28:23] production.ERROR: Encountered a permanent redirect while requesting https://bookstack.s3.us-west-1.amazonaws.com/?prefix=uploads%2Fimages%2Fuser%2F2018-12-Dec%2Ftest.jpg%2F&max-keys=1&encoding-type=url. Are you sure you are using the correct region for this bucket? {"userId":1,"email":"admin@admin.com","exception":"[object] (Aws\\S3\\Exception\\PermanentRedirectException(code: 0): Encountered a permanent redirect while requesting https://bookstack.s3.us-west-1.amazonaws.com/?prefix=uploads%2Fimages%2Fuser%2F2018-12-Dec%2Ftest.jpg%2F&max-keys=1&encoding-type=url. Are you sure you are using the correct region for this bucket? at /var/www/html/vendor/aws/aws-sdk-php/src/S3/PermanentRedirectMiddleware.php:49)
[stacktrace]

.env File:

# Storage
STORAGE_TYPE=s3
# Amazon S3 Config
STORAGE_S3_KEY=ihaveaworkingkeyhere
STORAGE_S3_SECRET=andaworkingsecrethere
STORAGE_S3_REGION=us-west-1
STORAGE_S3_BUCKET=bookstack
# Storage URL
# Used to prefix image urls for when using custom domains/cdns
STORAGE_URL=https://bucket.trustmeit.exists/bookstack

Entries are of course sterilized. Similar entry / Relevant information: #1192 and Rocket.Chat Documentation

Originally created by @armouredking on GitHub (Dec 23, 2018). **Describe the feature you'd like** Bookstack does not apparently allow you to set a URL for S3. I'm not 100% certain about the STORAGE_URL field, but given the Laravel logs I have to assume it does not do what I'm thinking it would/should. **Describe the benefits this feature would bring to BookStack users** Minio is a compatible stack, and given that quite a few people using BookStack will be self hosted, supporting Minio should be implemented. And it should be fairly easily done. RocketChat accomplishes this simply by allowing you to specify the link (instead of trying to magic it into existence as it seems is currently done). **Additional context** Log entry: ``` [2018-12-23 02:28:23] production.ERROR: Encountered a permanent redirect while requesting https://bookstack.s3.us-west-1.amazonaws.com/?prefix=uploads%2Fimages%2Fuser%2F2018-12-Dec%2Ftest.jpg%2F&max-keys=1&encoding-type=url. Are you sure you are using the correct region for this bucket? {"userId":1,"email":"admin@admin.com","exception":"[object] (Aws\\S3\\Exception\\PermanentRedirectException(code: 0): Encountered a permanent redirect while requesting https://bookstack.s3.us-west-1.amazonaws.com/?prefix=uploads%2Fimages%2Fuser%2F2018-12-Dec%2Ftest.jpg%2F&max-keys=1&encoding-type=url. Are you sure you are using the correct region for this bucket? at /var/www/html/vendor/aws/aws-sdk-php/src/S3/PermanentRedirectMiddleware.php:49) [stacktrace] ``` .env File: ``` # Storage STORAGE_TYPE=s3 # Amazon S3 Config STORAGE_S3_KEY=ihaveaworkingkeyhere STORAGE_S3_SECRET=andaworkingsecrethere STORAGE_S3_REGION=us-west-1 STORAGE_S3_BUCKET=bookstack # Storage URL # Used to prefix image urls for when using custom domains/cdns STORAGE_URL=https://bucket.trustmeit.exists/bookstack ``` Entries are of course sterilized. Similar entry / Relevant information: #1192 and [Rocket.Chat Documentation](https://rocket.chat/docs/administrator-guides/file-upload/minio/)
OVERLORD added the 🛠️ Enhancement📖 Docs Update🏭 Back-End labels 2026-02-04 23:13:21 +03:00
OVERLORD commented 2026-02-04 23:13:27 +03:00
Author
Owner
Copy Link

@armouredking commented on GitHub (Dec 23, 2018):

So looking around on Flysystem, it seems like the default plugin has a few bugs the developer has not corrected with regards to Minio usage. There is another repo here that purports fixes of the Flysystem adapter to include Minio support. Not sure if that's what is also needed for doing CEPH endpoints like #1192 wants.

At a minimum it seems you need the endpoint parameter, and the fork includes an additional parameter not present in the Flysystem plugin for "path style".

@armouredking commented on GitHub (Dec 23, 2018): So looking around on Flysystem, it seems like the default plugin has a few bugs the developer has not corrected with regards to Minio usage. There is another repo [here](https://github.com/coraxster/flysystem-aws-s3-v3-minio) that purports fixes of the Flysystem adapter to include Minio support. Not sure if that's what is also needed for doing CEPH endpoints like #1192 wants. At a minimum it seems you need the endpoint parameter, and the fork includes an additional parameter not present in the Flysystem plugin for "path style".
OVERLORD commented 2026-02-04 23:13:34 +03:00
Author
Owner
Copy Link

@ssddanbrown commented on GitHub (Dec 29, 2018):

https://github.com/BookStackApp/BookStack/issues/1192#issuecomment-450435087 details potential steps.

@ssddanbrown commented on GitHub (Dec 29, 2018): https://github.com/BookStackApp/BookStack/issues/1192#issuecomment-450435087 details potential steps.
OVERLORD commented 2026-02-04 23:13:39 +03:00
Author
Owner
Copy Link

@ssddanbrown commented on GitHub (Jan 20, 2019):

As per https://github.com/BookStackApp/BookStack/issues/1192#issuecomment-455875603, Will close this. #1230 has been opened to deal with proxy issues.

@ssddanbrown commented on GitHub (Jan 20, 2019): As per https://github.com/BookStackApp/BookStack/issues/1192#issuecomment-455875603, Will close this. #1230 has been opened to deal with proxy issues.
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 📖 Docs Update 🏭 Back-End 🛠️ Enhancement
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#967
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?