Skip to content
flowplanDocumentationCommunityMarketplaceStart page

Sign-in and administration

Administering the instance

Whoever administers the instance sees Administration in the sidebar: the instance's first account and everyone it gives the admin right to – with single sign-on also the members of the group in OIDC_ADMIN_GROUP.

13 min read

On this page
  1. Overview
  2. Set up the instance
  3. Workspaces
  4. Storage & backup
  5. Limits & retention
  6. Workflows
  7. Markdown & Git export
  8. E-mail
  9. Push notifications
  10. Chat apps
  11. AI
  12. Extensions & domains
  13. Encryption
  14. Activity log
  15. Monitoring
  16. Maintenance & notices
  17. Instance
  18. Demo

More on this topic: Managing users

Overview

The administration opens with an overview. At the top is the state of the instance: problems and notices (linked to the area concerned), six live figures – people active now, people active today (different people since midnight), requests per minute, error rate of the last hour, sign-ins today and the response time (p95: how long the slowest 5 % of the last hour's requests took) – and the requests of the last 24 hours as a chart. The figures refresh every 15 seconds while the page is visible (“Live”). Below, one tile per area with its state and, where it fits, a figure with its trend: active people (Users), the fullest quota (Workspaces), storage of the last 30 days, AI tokens today, changes in the activity log, requests or errors (Monitoring). Errors are marked red, notices yellow. On phones the tiles are a list with a small trend on the right.

The sections are grouped into People (Users, Sign-in & SSO, Workspaces), Data (Storage & backup, Limits & retention, Markdown & Git export), Services (E-mail, Push notifications, AI, Extensions & domains), Security (Threats & incidents, Encryption, Activity log – see Security) and Operations (Monitoring, Maintenance & notices, Instance). Every section starts with a status line – e.g. “Scheduled backup off” with a link to the switch, or “S3 off” with a link to the guide. Every setting has exactly one home. Switches and choices save at once, with “Saving …” or “Saved” next to them; single text fields show Save once you have changed them. Every section has its own address, e.g. /#admin/storage or /#admin/monitoring.

Set up the instance Since 0.9.7

Admins first see the step Set up the instance in the introduction: a traffic light for the basics, in the order you set up a new instance – Address and HTTPS (APP_URL), E-mail delivery, Backup, Sign-in (SSO) and AI provider. Red means tackle it first (for example no scheduled backup, no e-mail delivery, or Flowplan over unencrypted http); yellow is optional or worth a look (no APP_URL set, the first backup is still to come, only accounts with e-mail and password, no AI); green is set up. Each line leads with Set up (View when green) to the matching section of the administration. Later the command palette (⌘/CtrlK) opens the overview again with "Set up the instance".

Workspaces

All workspaces with members, pages, usage (a bar when there is a quota) and Own quota – saved when you leave the field. Empty = default, 0 = unlimited. The default is set under Limits & retention.

Storage & backup

The one place for backups:

  • Backups: S3 mirror and Litestream with their state, the scheduled Daily database backup – a consistent copy of the database per day, with S3 in the bucket under backups/, otherwise in the data folder –, Hourly instead of daily (meant for encrypted backups in place of Litestream, see Encryption; keep more copies then, e.g. 72 for three days), Backups kept, the last backup and Back up now. The Markdown export still runs once a day.
  • Usage: what is local and what is in the bucket, by kind, and how the database is split.
  • Whole instance → Download creates a verified copy of the database and files while running. With FLOWPLAN_ENCRYPTION_KEY the file is encrypted (.zip.enc).
  • Content: how many workspaces, pages, databases, records, files, accounts and comments there are.
  • Move instance: on the old instance Prepare the move (a move token, visible once, valid for 24 hours, revocable; confirmed with your password or a fresh sign-in), then read-only, "moved to …" and Redirect the web interface. On the new instance, also in red, Take over from another instance: first copy with progress, pre-flight check of the settings (names and check values only), Make the source read-only and fetch the last state and Apply on the next restart (previous state as pre-move-…). Guide: Moving an instance.
  • At the very end, in red: Restore from backup. An uploaded backup is checked and applied on the next restart; the previous state stays as pre-restore-… in the data directory. An encrypted backup is decrypted with the current or an earlier key. With PostgreSQL it also takes a scheduled backup (flowplan-….dump) – then only the database is replaced, the files stay.

Details: Storage and backups.

Limits & retention

SettingEffect
Storage per workspaceFor workspaces without a quota of their own.
Storage per personFor people without a limit of their own; everything they upload or copy.
Own workspaces per personHow many workspaces a person may own.
Largest uploadThe limit per file in MB. Also applies to importing an AFFiNE workspace file (at least 100 MB; FLOWPLAN_IMPORT_MAX_MB takes precedence).
Keep versionsDays after which automatic versions are deleted.
Empty the trash afterDays after which deleted pages, spaces, database records and templates are deleted permanently with their files (1–3650, default 30, 0 = never automatically). See Trash.

Empty fields fall back to the environment variables. Everyone sees their limits and the storage they use under Settings → Account & security → Your limits.

Workflows

Limits & retention → Workflows holds the limits of workflows: runs per minute (per workflow and workspace), steps per run, cascade depth, items per “For each”, AI tokens and e-mails per workflow and day, how long runs are kept, the longest wait, active workflows per workspace, the HTTP node (on/off, only certain hosts, internal addresses) and e-mails to addresses outside the members. … also to addresses from placeholders Since 0.10.0 allows such e-mail to addresses from form answers, inbound e-mails or AI answers as well – off by default, because otherwise anyone sending such data could direct the instance's e-mail to an address of their choice. The update to 0.10.0 leaves the switch on when active or paused workflows already send such e-mail; a note lists them until you decide here. A value from the environment or an earlier decision is left alone. Left empty, the value from the environment applies. Next to it, monitoring shows the load: active workflows, runs per minute, waiting and running steps, the oldest step due, the failure rate and today's AI tokens.

Markdown & Git export

Choose pages and databases for the Markdown export, switch on the Git export of spaces, and the (deprecated) instance Git repository – see Markdown export and Git.

E-mail

Sending e-mail shows the configured server, the sender, the queue and the last error; without SMTP a note with the variables (E-mail (SMTP)). Test e-mail checks the connection right away.

Push notifications

Whether notifications can reach the apps and through which service (/#admin/push). The overview's tile shows the relay with a green, yellow or red badge – e.g. “Reachable (85 ms)” – and the deliveries of the last 24 hours; the same tile is under Monitoring → Health.

  • Push relay: the address in use – the official https://push.flowplan.org or your own from PUSH_RELAY_URL (credentials in the address are never shown) –, whether it is on and otherwise exactly why not (PUSH_RELAY=off, APP_URL not an HTTPS address, PUSH_RELAY_URL invalid), the APP_URL the relay knows the instance by, and whether /.well-known/flowplan-push is published.
  • Reachability: the instance requests GET <relay>/healthz – at most 5 seconds, HTTPS only, following no redirects – and shows “Reachable” with the response time (and the relay's version if it names one) or the reason: timeout, connection refused, DNS, TLS, redirect, HTTP status. It also fetches its own /.well-known/flowplan-push at APP_URL, as the relay does, and checks that the current signing key is listed. If that fails from inside, it is only a warning: behind NAT or a proxy that does not resolve its own address internally this is normal – what counts is that the relay reaches it from outside (test notification). A result is kept for a minute; Check now checks again at once.
  • Signing key: key ids with their status (signing, waiting, retiring) and dates. Rotate key … asks first and rotates as described in Push relay and end-to-end encryption, optionally immediately.
  • Deliveries of the last 24 hours per channel (relay, Expo, Web Push) and result (delivered, gone, forbidden, invalid, rate limited, error), the last delivery through the relay, the last error as a code (e.g. signature HTTP 401 or unreachable), the queue and the registered devices per channel. Counted only while the usage statistics are on (see Monitoring).
  • Expo and Web Push: MOBILE_PUSH on or off, what MOBILE_PUSH_CONTENT sends along, where the VAPID keys come from and whether WEB_PUSH_SUBJECT is set.

The answers never contain tokens, keys or push addresses. /api/admin/push is for signed-in administrators only, never for API tokens.

Chat apps

Administration → Chat apps governs notifications to chat apps. At the top: allowed services, the instance's bot, active connections and those switched off after errors, and the deliveries of the last 24 hours.

  • Allowed services: Telegram, Gotify, ntfy and Matrix can be switched off one by one (default: FLOWPLAN_MESSENGERS). Services switched off get no more messages; people's connections stay stored and resume when the service is switched on again.
  • Instance Telegram bot: bot token from @BotFather and optionally an own API address (Bot API server or relay/proxy, also in the own network). Check and save asks Telegram for the bot with getMe and stores the token only when it is accepted – encrypted, shown only as “…abcd”. Remove bot deletes it (a token from FLOWPLAN_TELEGRAM_BOT_TOKEN then applies again). A conflict with a webhook or another program polling the bot shows under Last error.
  • Server addresses: empty allows any public server; otherwise only the hosts listed, one per line (*.example.org for subdomains). api.telegram.org and ntfy.sh always work. Internal addresses need FLOWPLAN_MESSENGER_ALLOW_PRIVATE=true.

Changing the bot is recorded as the security event “Instance Telegram bot changed”, changing services and hosts as “Security-relevant setting changed” – both also in the activity log.

AI

Optional and off by default: provider (Ollama, OpenAI-compatible, Anthropic, Gemini), who may use AI, individual features and users' own keys. A switch of its own: On-device AI (Apple) – allowed by default because nothing leaves the device. Everything in AI.

Quotas limit AI through the instance's provider per day, week, month and year – for the whole instance, groups and people (AI quotas). New in 0.10.2, in the :beta image

Extensions & domains

Block extensions from any HTTPS address (off: only from PLUGIN_ALLOWED_ORIGINS) and Custom domains for publications – see Block extensions and Coolify and reverse proxies.

Marketplace: switch publishing to and taking over from the Flowplan Marketplace on or off for the whole instance.

Encryption

The key ID, earlier keys, how many files in the bucket are not yet encrypted with this key (Encrypt existing objects catches up), and what leaves the server unencrypted regardless (Litestream, Git export). See Encryption.

Activity log

The latest changes with person, action and affected resource – such as shares, role changes, deletions, settings and the billing status of time entries –, searchable and filtered by person and kind, a list on phones. Under Export, optionally pick a from and to date (UTC, as stored) and download the log as CSV (semicolons, with BOM, for Excel) or as JSON. In the CSV, values a spreadsheet would run as a formula start with an apostrophe. Only signed-in administrators can export, never API tokens.

Monitoring

Health, usage and events of the instance – live: five key figures at the top (Active 24 h, Storage, Deliveries 7 days, AI tokens 14 days, Errors 24 h) with their trend and, where it fits, a comparison with the period before, below them cards in two columns with charts, queues, background workers, refused requests, alerts by webhook and the usage statistics. Details under Operations and troubleshooting.

Maintenance & notices

Notice for everyone – a banner for everyone until you clear it – the maintenance notice with start and end, which disappears by itself afterwards, and banners to click away that each person sees until they close them – e.g. for the apps or your Discord server (Maintenance & notices).

Instance

SettingEffect
Instance nameShown when signing in, in the sidebar and in the browser tab.
Public demoVisitors try Flowplan without an account, see Demo.
VersionRunning version, commit (linked to GitHub) and build date. Docker images from our workflow know their commit; with Coolify it comes from SOURCE_COMMIT. For your own build pass --build-arg GIT_COMMIT=$(git rev-parse HEAD), otherwise it says "commit unknown". When a newer version is out, a notice with How to update shows there.
Admin groupThe SSO or LDAP group from OIDC_ADMIN_GROUP.
What's new after updates for new accountsWhat new accounts start with for What's new after updates: Show all (default), Only breaking changes or Never. Only for accounts created afterwards; existing accounts keep their setting, and everyone can change it under Appearance & language. You set it per person under Users; accounts on Instance default follow this setting. Since 0.9.7
Settings level for new accountsWhich settings new accounts see: Beginner the essentials, Normal (default) most of them, Expert all (Settings levels). The search in Settings always finds all of them, and everyone can change their level at the top of Settings; you set it per person under Users. Accounts that existed before this setting keep seeing everything (Expert). Since 0.9.7
Default formatting toolbarThe formatting toolbar everyone gets who hasn't customized theirs – with the same editor as in your own settings. Their Reset goes back to it; here it restores the built-in bar. Since 0.9.7
Starter content for new accountsA space whose pages every new account gets in its personal workspace, instead of the built-in examples; see Starter content for new accounts. New in 0.10.2, in the :beta image
Features of this instanceA switch On for this instance per feature. Switched off, the feature is off for everyone – on the server as well; see Features of this instance. New in 0.10.2, in the :beta image
Features for new accountsWhich features new accounts see, a switch per feature. Hidden only removes the way in; existing pages and permissions stay. Everyone can change it; existing accounts see everything. Apply to all puts every existing account on this default after a confirmation; their own choices are lost. New in 0.10.2, in the :beta image

Everyone sees version, licence and source code under Settings → About Flowplan; for our images it also says whether it is a beta or a release (own builds: --build-arg FLOWPLAN_CHANNEL=beta or release). If you run modified code, name its source with FLOWPLAN_SOURCE_URL; FLOWPLAN_HIDE_SPONSOR=true hides the link to GitHub Sponsors (Configuration).

Below, More instance settings leads to the sections that earlier instance settings moved to.

Demo

The demo is off on every instance until an administrator switches it on under Administration → Instance → Public demo.

Then the address /demo of your instance starts a demo (on flowplan.org the button Try the demo links there). Without an account it creates a demo guest with an example workspace of its own. Every demo gets fresh example pages that show all features: a welcome page, an editor tour with all blocks, a project database with relation, rollup, formula, recurrence and all views (table, board, calendar, timeline, gallery, list, feed, chart, form), a whiteboard, a journal and a small wiki.

  • The demo ends with End demo, on signing out, after 45 minutes without activity and after three hours at the latest. Then the account, workspace, pages and files are deleted completely.
  • Demo guests cannot take anything outside: no publishing, no share links, no invitations, no further workspaces, no public forms, no administration.
  • Every demo workspace has 25 MB of storage. New demos are limited to five per hour and address and 40 at the same time.
  • Running and total started demos are shown under Administration → Monitoring → Instance in numbers.
Was this helpful?
YesThanks!
No – tell us what's missing

Found a mistake or something missing?Edit on GitHub