Skip to content

docs(cloud): Add a storage concept page - #771

Merged
developerjamiu merged 5 commits into
mainfrom
docs/cloud-buckets
Sep 22, 2026
Merged

developerjamiu merged 5 commits into
mainfrom
docs/cloud-buckets

Conversation

@Isakdl

@Isakdl Isakdl commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Adds cloud_docs/concepts/storage.md, a concept page for Serverpod Cloud storage.

It covers the two storages every project starts with, choosing access, using storage from server code, managing storages and their files from the CLI and the console, and what happens at a plan limit.

The blockers listed on this PR are resolved. The provider API shipped in Serverpod 4.0.0, projects are created with both default storages, and the console Storage tab is live and no longer gated. The page is updated against Serverpod 4.0.0 and Cloud CLI 1.0.0:

  • Server-side wiring uses ServerpodCloudProvider.private() and .public(), which serverpod create already adds to new projects, and the session.storage examples use the shipped method names.
  • Adds the serverpod cloud storage commands, which the first draft did not cover, including creating and deleting a storage.
  • Keeps custom storages reachable from server code, and says plainly that Cloud connects the two defaults for you while a storage you add has no ready-made helper, with a pointer to how storage providers are registered.
  • Limits are scoped to the plans that set caps, and describe what a lockout affects and how access comes back.
  • Treats private and public as storage ids named after their access rather than as fixed categories.

The console workflow, its labels, the storage id rules, and the type-the-storage-id delete confirmation were all checked against source.

Covers the two default storages, choosing private vs public, registering a
storage on the server, adding one in the console, the file browser,
deletion, and plan limits.

The ServerpodCloudStorage class has not landed in the framework yet, so the
two registration snippets carry TODO markers to be replaced with the real
class, package, and import before this merges.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01N237K5XruApUeGphztg8nc
@developerjamiu
developerjamiu marked this pull request as ready for review September 17, 2026 08:37
@developerjamiu

developerjamiu commented Sep 17, 2026

Copy link
Copy Markdown
Contributor

Reworked against Serverpod 4.0.0 and Cloud CLI 1.0.0.

  • The placeholder class is now ServerpodCloudProvider.private() and .public(), and three session.storage method names are corrected.
  • Added the serverpod cloud storage commands.
  • Limits now scope the lockout to the plans that set caps.

Your blockers are resolved: the provider API shipped, projects get both default storages, and the Storage tab is live and ungated.

I first cut the custom-storage registration step, thinking server code could reach only private and public. That was wrong, so it is back, worded to say there is no ready-made helper for a custom storage id.

@SandPod SandPod left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have a couple of questions for you before I approve.

I assume that all has been tested with the latest version of the CLI/Console.

Comment thread cloud_docs/concepts/storage.md
Comment thread cloud_docs/concepts/storage.md Outdated
Comment thread cloud_docs/concepts/storage.md Outdated

@Isakdl Isakdl left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good, but added some clarification comments on some section that I think needs a rework.

Comment thread cloud_docs/concepts/storage.md Outdated
Comment thread cloud_docs/concepts/storage.md Outdated
Comment thread cloud_docs/concepts/storage.md Outdated
Comment thread cloud_docs/concepts/storage.md Outdated

@SandPod SandPod left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good from my perspective.

But still unsure about the code examples from the Framework. Easy that this gets outdated. Perhaps this is better suited for a guide?

@developerjamiu

Copy link
Copy Markdown
Contributor

The code left here is Cloud's own wiring, not the framework API. The API lives on the file-uploads page (#857), and the CDN and passwords pages carry the same kind of snippet.

@developerjamiu
developerjamiu merged commit a1ca324 into main Sep 22, 2026
5 checks passed
@developerjamiu
developerjamiu deleted the docs/cloud-buckets branch September 22, 2026 10:41
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.

3 participants