Getting Started
FlowDeck is your private, self-hosted Notion-style workspace — pages, databases, and Git-forge (Gitea / GitHub) integration in one app.
First steps
- Open Workspaces (
/workspaces) to pick or create a workspace — local or connected to a forge.
- Click + New page in the sidebar to start writing, or press Ctrl+N.
- Use the Agent & IA section in Settings to plug an LLM provider (OpenAI, Ollama, DeepInfra…) if you want AI features.
The sidebar
- The workspace header (top-left) switches workspaces and opens your account menu.
- Tabs Home / Chat / Meetings / Inbox swap the sidebar content; pages are a drag-and-drop tree.
- On mobile the sidebar is a drawer: open it with the hamburger button, close it by tapping outside or swiping left.
Pages & Editor
Notion-style block editor: every line is a block you can drag, convert, and nest.
Blocks
- Type
/ for the slash menu — headings, callouts, toggles, code, math (KaTeX), tables, images, embeds, ToC…
- Markdown shortcuts as you type:
# heading, - bullet, 1. numbered, > quote, [] todo, ``` code.
- Drag the handle left of a block to move or nest it; Tab/Shift+Tab indent/outdent.
- Inline formatting: bold, italic, code, links, colors via the selection toolbar.
Page features
- Cover image and icon on every page (click the top of the page).
- Inline databases: add a table/board/calendar collection directly in a page.
- Comments (threaded), page history with snapshots, backlinks.
- Right-click any sidebar item for context menu: duplicate, rename, move, delete.
Databases & Views
Collections are databases with a JSON schema, independent of Gitea. 21 property types: title, text, number, select, multi-select, status, date, person, checkbox, url, email, phone, files, unique_id, relation, rollup, formula, and auto-properties.
Views
- Table — sortable columns, inline editing.
- Board (Kanban) — group by select/status, drag & drop between columns.
- Calendar — month grid by date property.
- Gallery — visual cards, configurable card size.
- List — compact rows with preview.
- Timeline — Gantt bars from date ranges.
- Status Overview / Team Load — donut + stacked-bar dashboards.
Relations, rollups, formulas
- Relations are bidirectional: link rows across collections.
- Rollups aggregate related rows (12 aggregations: sum, count, average, min, max…).
- Formulas support 19 functions over row properties.
- Filters, sorts and grouping apply per-view.
Tasks & Dependencies
- Todo blocks anywhere in pages become checkboxes; the My Tasks page aggregates every task in every collection you can access.
- My Tasks views: All / Today / Overdue / Next 7 days.
- Sub-items: unlimited hierarchy — a parent row is Done when all children are Done (status aggregate).
- Dependencies: Blocking / Blocked by between rows; transitioning a blocked task is refused until its blocker is done.
Workspaces & Forges
Organize work into separate workspaces, each with its own page tree, collections and members.
- Local Pages and files stored on your server (SQLite under
/data).
- Gitea Connect your Gitea account (Settings → Integrations): repos appear as workspaces, browse the file tree in the sidebar, create/edit files with commit messages, sync labels as tags.
- GitHub Connect via Settings → Integrations for repo browsing.
- Gitea legacy boards are auto-adapted into FlowDeck collections (GiteaBoardCompat).
- The Private section appears when a remote workspace is active — those pages stay local.
Collaboration
- Roles: workspace members are admin / editor / commenter / viewer.
- Sharing: the Share button (top-right of a page) — share with specific users or publish a read-only public link (
/p/your-slug).
- Teamspaces (wiki): shared knowledge spaces with their own pages.
- Meetings: meeting notes with an action-items panel.
- Sprints: time-box collections of tasks, with burndown-ready statuses.
- Notifications: bell in the topbar for mentions, assignments, comments.
- Live editing: changes propagate to other open tabs (real-time sync).
Library, Trash & Search
- Library (
/library) — tabs for Recents, Favorites, Shared, Published, with filtering.
- Trash (
/trash) — soft-deleted pages, 30-day retention, restore or purge.
- Ctrl+K — command palette: fuzzy search across pages, jump anywhere, start an AI answer.
- Full-text search API:
/api/v2/search.
AI Agent & Automations
- Chat sidebar (Chat tab): conversations with your configured LLM; pages can be attached as context.
- Agent panel on pages: propose edits, generate content, answer questions about the workspace.
- Skill marketplace: export/import portable skills, install presets from the
/ gallery.
- Automations (Settings → Automations): visual pipeline of trigger → condition → delay → action (webhook, notification, page update…), with run history and legacy JSON conversion.
- Configure providers in Settings → Agent & IA: per-provider API keys, model lists, offline mode without any provider.
Integrations & API
- Public API v2 —
/api/v2: CRUD on collections, pages, properties, views, comments, notifications, favorites, tags, sharing, sprints, templates. Bearer tokens (Settings → API tokens) with scopes read/write/admin, pagination, filters, sorting, idempotency keys, RFC 7807 errors. Interactive docs at /docs.
- Agent API —
/api/v2/agents/*: agents, conversations, synchronous JSON run, action journal with rollback, external trigger.
- Webhooks: outgoing events (create/update/delete) managed in Settings → Integrations; incoming Gitea webhooks keep boards in sync.
- Web Clipper — browser extension (Manifest V3): clip article / selection / bookmark / screenshot straight into FlowDeck.
- Import / Export: CSV import, JSON/CSV/Markdown export.
Offline mode (PWA)
FlowDeck is a Progressive Web App: pages you visited stay available offline and your edits are saved locally, then synchronised when the connection returns.
- Install: browser menu → Install app (Chrome/Edge) or Add to Home Screen (Safari/iOS).
- Offline editing: while offline, the editor stores changes in the browser (IndexedDB) and shows an offline banner with the number of pending changes. A ⟳ icon marks pages with unsynced edits.
- Reconnection: the queue is replayed automatically (and via Background Sync); a spinner badge appears while syncing, then a confirmation toast.
- Conflicts: the latest edit wins with a notice; server-side-deleted pages are recreated as orphan pages; title collisions get an “…(copie offline)” suffix.
Accounts & SSO
Local Email + password — create an account on the login page.
Gitea OAuth / GitHub OAuth — sign in with your forge; your repos become workspaces. You can link a forge to an existing local account — your identity stays local.
SSO Enterprise SSO — in Settings → Admin → SSO / Enterprise:
- SAML 2.0 — paste IdP Entity ID, SSO URL and signing certificate; give the IdP your
/auth/saml/metadata link.
- OpenID Connect — Issuer URL, Client ID and Client Secret (PKCE, scopes
openid profile email).
- Just-in-time provisioning, IdP groups mapped to workspace roles, SSO only mode disables local login (admins keep their door). Every attempt is audited in the login history.
Sessions and API tokens are managed in Settings → Sessions / API tokens.
Keyboard Shortcuts
Ctrl+K
Command palette / quick find
Ctrl+O
New AI chat (footer)
/
Slash command menu (in editor)
Delete
Move selected item to trash
Tab / Shift+Tab
Indent / outdent block
Escape
Close modal / cancel editing
Tips
- Toggle the desktop sidebar with the « button; collapsed, hover the left edge to peek it.
- Ctrl+Click / Shift+Click multi-select in the sidebar tree.
- Hover any sidebar item for quick actions (favorite, share, delete).
- Drag pages into the tree to reorganize; drop onto a page to nest it.
- The section ⋮ menus reorder or hide sidebar sections to taste.
- Dark/light theme toggle is in the topbar and persists across reloads.