addon-bookstack icon indicating copy to clipboard operation
addon-bookstack copied to clipboard
verified publisher icon hassio-addons

Update max file size to 200M

Open illuzn opened this issue 1 year ago • 1 comments

Proposed Changes

This increases the maximum upload file size to 200M.

Related Issues

A year ago now I PR'd an increase to the file limit in #280 Trying again with a more sane file limit of 200M. Not entirely sure how many people are using bookstack in the same way that I am but I upload all of the manuals for my appliances to bookstack and some of them exceed 100M in size. I do note that this is inconsistent with the 4G maximum file size configured in NGINX: https://github.com/illuzn/addon-bookstack/blob/86704a940f1c567c85fa63dabe4eaf74ac75e6bf/bookstack/rootfs/etc/nginx/nginx.conf#L28C5-L28C32 This is the reason that I specified 4G previously. Although, it would make sense to reduce the NGINX value to a more sane 200M as an alternative.

Note that issues #238 and https://github.com/BookStackApp/BookStack/issues/4306 are related. These issues document a potential PHP out of memory issue that arises when bookstack attempts to rescale large images. This issue can arise with a jpeg as small as 1.5MB (with a high level of compression) and, accordingly, is already affected by the existing maximum file size of 64M.

Summary by CodeRabbit

  • New Features

    • Increased maximum upload size for files from 64MB to 200MB.

  • Documentation

    • Documented a known issue related to PHP out of memory errors during large image uploads.

illuzn avatar Jul 02 '24 13:07 illuzn

Walkthrough

The changes improve the BookStack application’s ability to handle large file uploads by increasing upload and post size limits in both Nginx and PHP configurations. This addresses a known issue with PHP out-of-memory errors when rescaling large images.

Changes

File Path Change Summary
bookstack/DOCS.md Documented a new known issue regarding large image uploads causing PHP crashes.
bookstack/rootfs/etc/nginx/includes/server_params.conf Increased client_max_body_size from 64M to 200M to support larger file uploads.
bookstack/rootfs/etc/php83/php-fpm.d/www.conf Increased post_max_size and upload_max_filesize from 64M to 200M for PHP.

Poem

In BookStack's land, where documents rise,
Large images no longer face demise.
With memory to spare, they scale with grace,
Uploads soar high in ample space.
Thanks to the tweaks in code’s embrace,
PHP and Nginx uphold their place. ✨🐰📚

[!TIP]

Early access features: enabled

We are currently testing the following features in early access:

  • OpenAI gpt-4o model for code reviews and chat: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available.

Note:

  • You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
  • Please join our Discord Community to provide feedback and report issues.
  • OSS projects are currently opted into early access features by default.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Jul 02 '24 13:07 coderabbitai[bot]

The original comment hasn't been addressed; which is also the reason why the original PR was closed eventually.

Going to do the same here. Feel free to re-open when the requested change is in there and I'm happy to take a look at that point in time.

../Frenck

frenck avatar Sep 30 '24 19:09 frenck