Skip to content

Add STORAGE_<LOCATION>_HEALTHCHECK_WRITE_INTERVAL to docs#670

Open
NickNovoselov wants to merge 1 commit intodirectus:mainfrom
NickNovoselov:main
Open

Add STORAGE_<LOCATION>_HEALTHCHECK_WRITE_INTERVAL to docs#670
NickNovoselov wants to merge 1 commit intodirectus:mainfrom
NickNovoselov:main

Conversation

@NickNovoselov
Copy link
Copy Markdown

Add STORAGE_<LOCATION>_HEALTHCHECK_WRITE_INTERVAL environment variable documentation

Summary

Documents the new optional environment variable STORAGE_<LOCATION>_HEALTHCHECK_WRITE_INTERVAL. This variable allows users to throttle health‑check write operations (PUT) to cloud storage backends (like S3), dramatically reducing the number of PUT requests and helping stay within free‑tier limits.

Related PR

Link to the corresponding PR in the main Directus repository (once created).

Changes

  • Added a row to the Storage configuration describing the new variable, its behaviour, and its default value (0 – meaning always write).
  • Clarified that the health check reads the existing health‑check file (GET) during the interval, and only performs a full write (PUT) when the interval expires or the read fails.
  • Provided guidance that setting the variable to a non‑zero value (e.g. 60000 for one minute) significantly cuts PUT operations while still reliably monitoring storage health.

Checklist

  • Variable name matches the implementation
  • Description accurately reflects the throttling and fallback logic
  • Default value documented
  • Awaiting merge of the main Directus PR (or PR number for cross‑reference)

@NickNovoselov NickNovoselov requested a review from a team as a code owner May 4, 2026 09:47
@vercel
Copy link
Copy Markdown

vercel Bot commented May 4, 2026

@NickNovoselov is attempting to deploy a commit to the Directus Team on Vercel.

A member of the Team first needs to authorize it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant