Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update common_settings.py for precompressing static files #2411 #3898

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from

Conversation

ShaunTheProgrammer
Copy link

@ShaunTheProgrammer ShaunTheProgrammer commented Sep 30, 2024

Fixes #2411

STATICFILES_STORAGE:

We specify whitenoise.storage.CompressedManifestStaticFilesStorage as the storage backend. This storage class automatically compresses static files during the collectstatic process, creating .gz (gzip) and .br (Brotli) versions of each file.
WHITENOISE_USE_BROTLI:

This setting enables Brotli compression for static files. Brotli typically achieves better compression ratios compared to gzip, so this helps with performance.
COMPRESS_PRECOMPRESS_GZIP and COMPRESS_PRECOMPRESS_BROTLI:

These ensure that both .gz (gzip) and .br (Brotli) compressed versions of static files are created during the collectstatic process.
Serving Precompressed Files:

WhiteNoise will automatically serve precompressed versions of static files if the client supports the respective compression formats (i.e., Brotli or gzip). This reduces the load on the webserver (Caddy) since it doesn’t need to compress responses dynamically.
Caching with WHITENOISE_MAX_AGE:

Static files are served with a cache-control header that allows browsers to cache them for one year, reducing the load on your server and improving performance.
By using WhiteNoise in this manner, we ensure that static files are compressed during the deployment process (e.g., with collectstatic) and served efficiently with support for both Brotli and gzip without requiring the webserver (Caddy) to compress them on the fly.
Technical details

Screenshots

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the develop branch of the repository
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@pavish pavish self-assigned this Oct 1, 2024
@pavish pavish added the pr-status: review A PR awaiting review label Oct 1, 2024
@pavish pavish self-requested a review October 1, 2024 12:32
@pavish
Copy link
Member

pavish commented Oct 1, 2024

@ShaunTheProgrammer Thanks for the PR!

Our team is overextended at the moment since we're working towards our Beta release. It might take a few weeks before I get to reviewing the PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-status: review A PR awaiting review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Precompress static files
2 participants