Skip to content

Follower Node Storage Policy Tutorial

What this page covers

This page explains how to use an already connected follower node as a storage policy backend: create an ingress target, create a remote storage policy, configure policy group rules, bind users or teams, and verify real uploads and downloads.

If you have not connected the follower node to the primary node yet, start with Follower Nodes.
If you run follower nodes with Docker, start with Deploy a Follower Node with Docker.

When to Use It

Follower nodes are suitable for these scenarios:

  • The primary node handles login, the admin console, sharing, and WebDAV, while real objects are written to another machine
  • You have an extra storage machine at home, in the office, or in a server room
  • You want to route large files or files from a specific team to an independent node
  • You want a follower node to write to its own local disk or to S3 / MinIO that it can access

It is not a multi-primary cluster or automatic failover. The primary node is still the only control plane.

The current version requires the primary node to access the follower node

The current remote storage policy still requires the primary node to actively access the follower node's base_url.

If the follower node is behind NAT, CGNAT, or a private-only network, and it can only actively access the primary node while the primary node cannot connect back to it, enrollment may still complete, but later capability probes, ingress target synchronization, and object reads and writes will fail.

This type of "outbound-only" follower node access requires a reverse connection channel and is being tracked in issue #136. Before that capability lands, make the follower node reachable by the primary node through a public domain, routable private network, VPN, WireGuard, frp, or a reverse proxy.

First, Separate the Three Layers

text
Follower node record
  |
  +-- Ingress target
      |
      +-- remote storage policy
          |
          +-- Policy group rule
              |
              +-- User or team bound to the policy group

Each layer is responsible for something different:

LayerResponsibilityEntry
Follower node recordThe primary node knows which follower node exists and how to access itAdmin -> Follower Nodes
Ingress targetWhether the follower node writes received objects to local storage or S3Admin -> Follower Nodes -> Node Details
remote storage policyWhich follower node is selected during uploadAdmin -> Storage Policies
Policy groupWhich users / teams / file sizes match this policyAdmin -> Policy Groups

The primary node and follower currently use internal remote storage protocol v2. Before creating a remote policy or switching policy groups, have the primary node test the node connection once; the test result includes the protocol version, server version, and capability summary.

1. Confirm the Follower Node Is Ready

In the primary node admin console, open:

text
Admin -> Follower Nodes

Confirm that the target node meets these conditions:

  • Enrollment is complete
  • It is enabled
  • base_url is an address the primary node can access
  • The current network is not a "follower node can only make outbound connections, and the primary node cannot connect back" scenario
  • "Test Connection" succeeds
  • The internal protocol version in the capability summary is compatible with the current primary node; currently v2 is required
  • /health/ready returns successfully

If base_url is empty, you can complete enrollment first, but the node cannot actually receive remote storage traffic. Before production, you must fill in an HTTP(S) address that the primary node can access.

2. Create the Default Ingress Target

Open the target follower node details and find:

text
Primary-managed ingress targets

For the first setup, create a local ingress target.

Example:

FieldRecommendation
Namedefault-local
Driverlocal
Base pathdefault
Default ingress targetEnabled

The base path of a local ingress target can only be a relative path.
It is ultimately placed under the follower node's own:

text
server.follower.managed_ingress_local_root

For example, if the follower node configuration is:

toml
[server.follower]
managed_ingress_local_root = "/data/managed-ingress"

And the ingress target base path is:

text
default

Objects are ultimately written to:

text
/data/managed-ingress/default

Without a default ingress target, a remote policy cannot actually write data

Successful enrollment only means the primary and follower identities are bound. Before receiving real objects, the follower node also needs an applied default ingress target.

3. Choose local or s3 for the Ingress Target

Ingress targetBest forNotes
localFollower node local disks or NAS-mounted directoriesThe base path must be relative and is restricted under the follower ingress root directory
s3Object storage that the follower node's network can accessCredentials and endpoint are stored in the follower node ingress target configuration

For the first integration, use local to prove the path from the primary node to the follower node.
After confirming it is stable, switch the follower ingress target to s3 if needed.

4. Create a remote Storage Policy

Open:

text
Admin -> Storage Policies -> New Policy

Choose the driver type:

text
remote

Fill in:

FieldRecommendation
NameA name that identifies the node, such as Remote Follower A
Follower nodeSelect the node you just connected and tested successfully
Single-file size limitSet this according to the test scenario first; 0 means unlimited
Chunk sizeKeep the default for the first setup
Upload modeUse relay_stream for the first setup
Download modeUse relay_stream for the first setup

Save it first, then run a connection test.

5. Choosing Upload and Download Modes

First Choice: relay_stream

Upload path:

text
Browser -> Primary node -> Follower node -> Ingress target

Download path:

text
Ingress target -> Follower node -> Primary node -> Browser

Advantages:

  • The browser only needs to access the primary node
  • The troubleshooting path is clear
  • The follower node requires less public exposure

Trade-off:

  • The primary node still carries upload and download bandwidth

Advanced: presigned

During upload or download, the browser directly accesses a short-lived URL generated by the follower node.

Suitable when:

  • You want to reduce bandwidth pressure on the primary node
  • The browser can reliably access the follower node base_url
  • The reverse proxy already exposes the follower node correctly

Before using it, confirm:

  • The follower node base_url is reachable from the browser
  • The HTTPS certificate is trusted
  • The reverse proxy does not intercept upload / download paths or required response headers
  • The follower node ingress target has been applied successfully
  • The primary node connection test shows that the follower supports browser_presigned_cors

If the primary node can access the follower node, but user browsers cannot, do not use remote presigned.

Browser CORS requirements for remote presigned are stricter than ordinary primary-node relaying:

DirectionRequired request headersResponse headers that must be exposed
Upload PUTcontent-typeETag
Download GET / RangerangeAccept-Ranges, Content-Range, Content-Length

The follower's default internal protocol capabilities declare content-type, range, and expose the GET headers Accept-Ranges, Cache-Control, Content-Disposition, Content-Length, Content-Range, Content-Type, ETag, plus the PUT header ETag. If nginx, Caddy, Traefik, or a CDN sits in front, confirm that it does not drop these response headers.

6. Create a Test Policy Group

Do not directly modify the default policy group. Create a test policy group first:

text
Admin -> Policy Groups -> New Policy Group

Example:

text
Remote Test Group

Add a rule:

FieldRecommendation
Storage policyThe remote policy you just created
PriorityKeep the default or set it to match first
File size rangeCover all sizes for the first test

7. Bind a Test User or Team

Bind a User

Open:

text
Admin -> Users -> User Details

Change the test user's policy group to Remote Test Group.

Bind a Team

Open:

text
Admin -> Teams -> Team Details

Change the test team's policy group to Remote Test Group.

Team space uploads match the team policy group, not the individual user's policy group.

8. Run a Real Acceptance Check

Log in as the test user and verify, in order:

  1. Upload a small file
  2. Upload a large file
  3. Download the file
  4. Create and open a share link
  5. Delete the file, then restore it from the trash
  6. If previews are enabled, open an image or PDF once
  7. On the follower node, check whether objects appear in the ingress target directory or object storage
  8. Return to Admin -> Follower Nodes on the primary node and test the connection again, confirming that the protocol version and capability summary are still normal

If all of these pass, then consider moving real users or teams to the remote policy group.

9. Route by Size to a Follower Node

A common pattern:

text
Small files -> Primary local storage or S3
Large files -> Follower node

Configure multiple rules in the policy group, for example:

RuleFile size rangeStorage policy
Small files0 to 100 MiBLocal policy
Large filesAbove 100 MiBremote policy

After saving, upload small and large files separately and confirm that the matched storage policy is as expected.

10. Move Real Users or Teams

After confirming the test works, choose a migration method:

ScenarioMethod
Only a few users should use the follower nodeBind policy groups one by one under Admin -> Users
A specific team should use the follower nodeBind a policy group under Admin -> Teams
New users should use the follower node by defaultSet the remote policy group as the default policy group for new users
Gradual migrationAdjust bindings in batches while watching tasks, logs, and follower node health

Changing a policy group only affects future uploads. Old files are still read through their original storage policies.

11. Routine Maintenance

Check regularly:

  • Whether the connection test from the primary node to the follower node succeeds
  • Whether the follower node /health/ready is normal
  • Whether the default ingress target is still applied
  • Whether the follower ingress root directory has enough disk space
  • If the follower writes to S3, whether the S3 credentials are still valid
  • Whether the remote policy group is still enabled
  • Whether there have been recent errors related to remote uploads / downloads

The follower node's local ingress directory is formal data and must be included in the backup strategy.
If the ingress target is S3, handle it according to the backup and versioning strategy for object storage.

Released under the MIT License