Skip to content

docs: Document custom CloudStorage for local disk and NAS - #783

Merged
developerjamiu merged 4 commits into
serverpod:mainfrom
abdulawalarif:feat/3081-improve-custom-cloud-storage
Sep 7, 2026
Merged

docs: Document custom CloudStorage for local disk and NAS#783
developerjamiu merged 4 commits into
serverpod:mainfrom
abdulawalarif:feat/3081-improve-custom-cloud-storage

Conversation

@abdulawalarif

Copy link
Copy Markdown
Contributor

Summary

  • Adds a Custom cloud storage page that documents the two FileUploader paths: POST to the API server (storeUnverifiedFile on DatabaseCloudStorage) vs a signed provider URL (S3/GCP/R2/MinIO).
  • Includes a current-main LocalStorage sketch (extend DatabaseCloudStorage, override storeUnverifiedFile / retrieveFileWithStat) so the Jan 2025 issue snippets are no longer the documented path.
  • Documents maxRequestSize (512 KiB) silently capping API-server uploads below UploadOptions.maxFileSize (10 MB), and that FileUploader returns false on every failure.

Closes the docs side of serverpod/serverpod#3081.

Test plan

  • Preview the new Custom cloud storage page in the sidebar (should sit directly after File uploads).
  • Follow File uploads → Custom cloud storage links, Size limits, and Related entries; confirm none 404.
  • Confirm the LocalStorage example compiles against current Serverpod main (createUploadDescription, storeUnverifiedFile, CloudStorageFileNotFoundException, etc.).
  • Check that raising maxRequestSize is described in both File uploads and the configuration reference.

FileUploader uploads never call storeFile, and maxRequestSize silently
caps API-server uploads below the default maxFileSize.
Comment thread docs/06-concepts/02-endpoints-and-apis/12-custom-cloud-storage.md Outdated
Comment thread docs/06-concepts/02-endpoints-and-apis/12-custom-cloud-storage.md Outdated
@abdulawalarif

Copy link
Copy Markdown
Contributor Author

Hi Jamiu, applied both suggestions (file renumbering + MiB units).

Comment thread docs/06-concepts/02-endpoints-and-apis/08-custom-cloud-storage.md Outdated
@abdulawalarif

Copy link
Copy Markdown
Contributor Author

Hi Jamiu, applied your suggestion

@developerjamiu
developerjamiu merged commit de1aec0 into serverpod:main Sep 7, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants