Coming soon. The Wiki is in active development, so features and these docs may still change. Early adopters: contact us for access.

Storage

Where the Wiki keeps files, storage credentials, upload limits, and the check that every server uses the same storage

1. Overview

The Wiki keeps files (page attachments such as images, videos and subtitles, Q&A images, logos, avatars, plugin packages, log exports) in one storage location chosen during setup: a directory on the server, Amazon S3, MinIO or another S3-compatible service, or Azure Blob Storage. Super admins can change it later under Settings → Storage. Every server of a cluster uses the same storage. Available on every license tier.

2. Change the settings

The top of the page shows the storage in use: its backend, where it points, a status (Healthy, Not shared, Another installation or Not checked) and the storage ID, which you can copy. Below it are the settings to change.

Settings → Storage: the backend cards, local disk, Amazon S3, MinIO and Azure Blob
Settings → Storage: the backend cards, local disk, Amazon S3, MinIO and Azure Blob
  1. Backend and location — Pick the backend from its card (Local disk, Amazon S3, MinIO or Azure Blob) and say where the files are: a directory, a bucket and region, an endpoint and bucket, or a storage account and container.
  2. Credentials — Access keys for S3 and MinIO, an account key for Azure. They're stored encrypted and never shown again; leave a key empty to keep the saved one. On AWS and Azure you can leave them empty to use the server's IAM role or managed identity: clear the S3 access key (the saved secret key goes with it) or choose Remove saved key for Azure. For S3 you can also give a role to assume (below).
  3. Uploads — The default upload limit (50 MB) applies to logos, avatars, plugins and other uploads; page attachments have their own fixed limits (below). The part size (5 MB) is how large files are sent to S3 and Azure: larger parts mean fewer requests and more memory per upload in progress.
  4. Test — Test connection, beside the storage in use, writes a small file with the settings below (without saving them), reads it back and deletes it, so a key without write, read or delete access is caught before you save. The result shows under the storage in use.
  5. Save — The bar at the bottom says when there are unsaved changes, and reminds you to test first when you switch backend. Saving runs the same test. The server you're on switches at once; the others within a minute, without a restart.

An upload over its limit is stopped as soon as it passes the limit, and nothing of it is kept.

3. Page attachment limits

Files attached to pages have their own limits, the same on every server:

WhatLimit
ImagesUp to 20 MB, at most 16,384 pixels on a side and 50 million pixels in all
Videos (MP4, WebM)Up to 200 MB
Subtitles (WebVTT)Up to 512 KB
Per pageAt most 500 attachments and 1 GB in all
Per person60 uploads a minute (bursts of 20); 30 large uploads an hour (bursts of 4)

Adding and removing an attachment raise page.attachment.create and page.attachment.delete (see Events).

4. Using an IAM role for S3

The Wiki can reach S3 without stored keys, with the AWS credentials the server already has: an EC2 instance profile, an ECS task role, or an EKS service account role (IRSA or Pod Identity). Leave Access key ID and Secret access key empty and choose Test connection.

Under Assume a role (optional), give a Role ARN to make the Wiki assume that role — with the keys, or with the server's own role when there are none. Use it for a bucket in another AWS account or a role narrower than the server's. Add an External ID when the role's trust policy asks for one. The Wiki renews the role's temporary credentials before they expire.

  • Every server of a cluster needs the same access: the same instance or task role, or permission to assume the role (sts:AssumeRole).
  • The role (or the server's role) needs s3:PutObject, s3:GetObject, s3:DeleteObject and s3:ListBucket on the bucket.
  • Running the Wiki in Docker on EC2 with IMDSv2: set the instance's metadata hop limit to 2, or containers can't reach the instance role.
  • When credentials can't be had, the test says so: the server has no role, or the role can't be assumed (check its trust policy and the external ID).
storage:
  backend: s3
  s3:
    bucket: wiki-files
    region: eu-west-1
    role_arn: arn:aws:iam::123456789012:role/wiki-storage      # optional
    external_id: wiki-prod                                     # optional

The same fields are in the setup wizard and in the setup configuration file (role_arn, external_id).

5. The storage ID

Each installation writes a storage ID to its storage (in a .depotex folder) and to its database. A server checks the two match when it starts, and the status beside the storage in use shows the result:

SituationWhat happens
A second server of a cluster can't find the IDIts storage isn't the cluster's shared storage — for example a local directory that isn't a shared volume. The server refuses to start; mount the shared volume or bucket and start it again.
The storage holds another installation's IDTwo installations must never share storage. In a cluster the server refuses to start; on a single server it starts so you can fix the settings and the system check reports a problem.
The only server finds no IDThe storage is new or was emptied; the ID is written again.

The system check tests this on every server (Shared storage).

6. Moving to another location

Changing the location doesn't move files. Copy every file to the new location first, including the .depotex folder, then save the new settings.

If the new location doesn't hold this installation's storage ID, the test (or saving) says so and Confirm the new location appears: tick that the files were copied there (or that there are none yet) before Save works. A location holding another installation's ID is always refused.

7. Events

storage.settings.update (before and after, blocking) is raised when the settings change; it carries the backend, location, endpoint, region and limits, never credentials. See Events.

8. Permissions

PermissionWhoAllows
storage:adminSuper admins onlyViewing, testing and changing the storage settings

Every change and every test is recorded in the audit log.