Skip to content

Add documentation for Neon Object Storage #692

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.

Sign up for GitHub

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

Merged
dkocher merged 3 commits into from
Nov 10, 2026
Merged

Add documentation for Neon Object Storage #692

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7cbf9bb
Create neon.md
rishi-raj-jain Nov 10, 2026
3b0957d
Rename protocols/neon.md to protocols/s3/neon.md
rishi-raj-jain Nov 10, 2026
a56cd47
Update providers.md
rishi-raj-jain Nov 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions protocols/s3/neon.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
Neon Object Storage
====

> [Neon Object Storage](https://neon.com/docs/storage/overview) is S3 compatible object storage included with Neon projects. Each branch has its own storage endpoint.

## Connecting

### Connection Profile

:::{note}
Connection profiles can be installed from *Preferences → Profiles*.
:::

{download}`Download<https://profiles.cyberduck.io/Neon%20Object%20Storage.cyberduckprofile>` the *Neon Object Storage Connection Profile* for preconfigured settings.

:::{tip}
Set *Server* to the storage endpoint of your branch, like `br-<branch>.storage.c-<n>.<region>.aws.neon.tech`. In the [Neon Console](https://console.neon.tech/), click *Connect* and open the *Storage* tab to copy the endpoint.
:::

### Access Keys

Credentials are scoped to a branch and its child branches.

1. Log in to the [Neon Console](https://console.neon.tech/) and select your project.
2. Click *Connect* and open the *Storage* tab.
3. Click *Reveal credential* or *Copy credentials*. You can also create a credential with `storage:read` and `storage:write` scopes in *Settings → Credentials*.
4. Enter the token ID (`nak_live_…`) for *Access Key ID* and the secret (`nsk_live_…`) for *Secret Access Key*.

## Limitations

- ACLs are read only. Renaming a file fails after the copy because the ACL of the source file cannot be applied to the target.
- Versioning and lifecycle configurations are not enforced.
- Bucket logging, website configuration and transfer acceleration are not supported.

## References

- [Neon Object Storage documentation](https://neon.com/docs/storage/overview)
- [S3 compatibility](https://neon.com/docs/storage/s3-compatibility)
3 changes: 2 additions & 1 deletion protocols/s3/providers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ ionos
linode
mega
minio
neon
oraclecloud
pilvio
polycloud
Expand Down Expand Up @@ -52,4 +53,4 @@ Connection profiles can be installed from *Preferences → Profiles*.
- [OVH](../openstack/ovh.md)
- [Seeweb](https://www.seeweb.it/)
- [Swisscom S3 Dynamic Storage](https://www.swisscom.ch/en/business/enterprise/offer/cloud-data-center/dynamic-computing-services.html)
- [Vultr Object Storage](https://www.vultr.com/docs/vultr-object-storage#Cyberduck_GUI_tool)
- [Vultr Object Storage](https://www.vultr.com/docs/vultr-object-storage#Cyberduck_GUI_tool)
Loading