Skip to content
Docs for Flare rolling (v2.1.0) Updated c9105238Build details ↗Versions & changes
Rolling preview · Unreleased

These docs describe a rolling build, not a stable release.

Read stable docs
View docs

Administer your instance ​

Flare gives administrators control over who can join, how files are stored, what the site looks like, and how account recovery works. Open Settings for instance-wide choices, Users for account management, and Roles for reusable permission groups. Each area and action follows your assigned permissions. Your own upload defaults, tokens, and account preferences remain in Profile.

Find the right control ​

SectionWhat you can doDetailed guide
Settings → GeneralEnable background image OCR, show credits, inspect installed version and update informationGeneral
Settings → AccessOpen/close registration, set the closed-registration message, configure OIDCUsers, SSO
Settings → StorageSelect local/S3 storage, set maximum file size, enable storage quotasStorage
Settings → AppearanceBrand the instance, design light/dark themes and share pages, import/export packs, edit legacy colors/favicon and custom CSS/HTMLAppearance
Settings → EmailConfigure SMTP, test delivery, enable recovery and verification, inspect the outboxEmail
RolesCreate, organize, and combine permission groups; delegate account, content, or settings workRoles and permissions
Audit logSearch instance events and inspect actors, filenames, processing outcomes, and administrative changes; requires audit.readAudit log
UsersCreate/edit accounts, change roles, moderate content, remove avatars, inspect email accessUsers and roles

Settings lives at /dashboard/settings; Users at /dashboard/users; Roles at /dashboard/roles; Audit log at /dashboard/audit. Settings links can open a section directly, for example /dashboard/settings?section=storage. Older section=about links lead to General's instance information; section=advanced leads to Appearance's custom styles.

Choose Documentation in the Settings header to open the handbook in a new tab. The link stays available in every settings section, including on phones, so you can read a guide while keeping unsaved changes in the original tab.

Stable builds open the archive for their installed release; rolling builds open the published rolling handbook. During setup, versions before 2.1.0 open their archive homepage for the original setup instructions; newer versions open the dedicated setup guide. Rolling documentation follows the latest published rolling commit, so it may be ahead of an older rolling installation. An unknown or other prerelease version opens Versions for you to choose. Custom builds use their package version and configured release channel; see build identity if those do not match your source.

Open Documentation from the settings header without leaving your working form.
Settings on desktop with a Documentation link above the General controls

Open Documentation from the settings header without leaving your working form.

Find the link on a phone
The handbook is also one tap away in mobile settings.
Settings on a phone with the Documentation link in its header

The handbook is also one tap away in mobile settings.

General ​

Reading instance settings needs settings.read; changing General needs settings.general. Access/SSO uses settings.security, Storage uses settings.storage, Email uses settings.email, and instance appearance uses appearance.manage. Custom CSS/head HTML requires Administrator because it can execute browser code. Give the read permission alongside the relevant edit permission when delegating dashboard settings work.

Background image OCR ​

OCR extracts text from uploaded images so it can be searched and used by OCR-based tag rules. It is enabled by default. Disable Background OCR Processing if you do not need it or want to reduce processing work on a small server.

OCR processing outcomes can be investigated in Audit log; the audit details do not include extracted text. Changing this switch does not erase existing OCR text. Upload options can opt individual uploads out of OCR, and extracting text is asynchronous. A successful upload does not mean text recognition is already finished or that the image contains recognizable text.

Credits ​

Show Credits Footer controls the instance's Flare credit footer. Share pages can inherit that choice or explicitly show/hide their footer through the appearance studio. The studio's footer text is a separate design field.

Instance information ​

View the installed version and release channel. Official rolling images include a commit identity and check for newer rolling releases. A custom image needs the corresponding build metadata to show it accurately. Update notices are informational; deploy a new image through your hosting system to upgrade.

Save changes deliberately ​

Most Settings forms maintain a working copy until you save. Changed fields are marked and can be discarded before saving. The appearance studio has its own Save draft / Publish appearance workflow, and Email has dedicated testing, policy review, and save behavior. A saved studio draft does not alter the live site.

Environment-managed email controls are read-only in the dashboard. Adjust the deployment override or remove it to restore the saved fallback. Configuration precedence explains the distinction.

A good first-day checklist ​

  1. Complete setup and keep a working local administrator login.
  2. Confirm local persistence or S3 access with an upload/download/delete test.
  3. Choose registration and quota policies before inviting users.
  4. Set your public domain and verify generated links use it.
  5. If enabling email, verify the administrator's recovery address before requiring verification for everyone.
  6. Publish an appearance after checking light, dark, mobile, and protected-file previews.
  7. Create and restore a backup.

What administration means for privacy ​

Accounts with content.read, including Administrator, can inspect private and password-protected files. Content changes and deletion have separate permissions. File privacy is an application access rule, not encryption that hides bytes from the server operator. Grant administrator roles only to people who should control the whole instance.

Every account inherits Everyone and can hold multiple additional roles. Assign narrowly scoped roles for moderation, account support, or appearance design. The roles guide explains additive grants, hierarchy, immediate revocation, and recovery protection. There are no per-user numeric quota overrides or built-in account suspension states.