Atlantisboard Wiki

Official documentation for deploying, configuring, and using Atlantisboard.

Atlantisboard Wiki

Welcome to the official Atlantisboard documentation. Whether you are deploying Atlantisboard for the first time, configuring it for your team, or learning how to get the most out of your boards, you will find everything you need here.

Atlantisboard is a self-hosted, real-time collaborative Kanban board designed for teams that want full control over their project management data. This wiki covers installation, administration, day-to-day usage, and advanced customisation.

Tip: Every page in this wiki is indexed and searchable from the sidebar. Use the search bar to quickly find what you need.

---

Table of Contents

Getting Started

• What is Atlantisboard? — Product overview, core vocabulary, and technology stack.
• System Requirements — Hardware, software, network, and browser requirements.

Deployment & Installation

• npm install (atlantisboard) — Interactive Whiptail wizard (npm or GitHub release zip).
• Debian installation (auto setup) — Recommended Debian path with atlantisboard-setup and Docker full stack.
• Docker Compose Installation (Recommended) — Step-by-step Docker Compose setup from a git clone.
• Environment Variables Reference — Complete reference for every .env configuration variable.
• Reverse Proxy Setup (Nginx / Caddy) — Production-ready Nginx and Caddy configurations with WebSocket support.
• Manual (Non-Docker) Installation — Installing without Docker, including a systemd service example.
• Updating & Maintenance — How to update Atlantisboard and roll back if needed.

First-Time Setup

• Creating the First Admin Account — First user registration and automatic admin promotion.
• Initial Configuration Walkthrough — Recommended order for configuring a new installation.

Admin Configuration

• General Settings — Global application preferences.
• Login Options — Authentication methods, registration modes, Google OAuth, and database verification.
• Permissions & Roles — Role-based access control, built-in roles, custom roles, and the 15 permission categories.
• User Management — User table, capabilities, bulk actions, and account management.
• Email (SMTP) Configuration — Provider presets, SMTP settings, and test emails.
• Database Maintenance — Statistics, collection sizes, and cleanup tools.
• Backup & Restore — Scheduled backups, restore points, and retention policies.
• System Monitor — CPU, memory, disk, and runtime metrics dashboard.

Admin Customisation

• Login Branding — Logo, colours, backgrounds, and login page preview.
• App Branding — Navbar icon, colours, homepage background, and default font.
• Email Branding — Email template colours, footer, and preview.
• Custom Fonts — Upload fonts, manage the font catalog, and set the default UI font.

Accounts & Authentication

• Registration & Sign-In — Registration flow, password requirements, and email verification.
• Password Reset & Email Verification — Forgot password, reset tokens, and verification emails.
• Google OAuth Sign-In — OAuth setup, account merge, and error handling.

User Account & Profile

• Profile Settings — Display name, avatar, and language selector.
• Password & Security — Change password, account lockout, and appearance preferences.
• Notification Preferences — Per-category notification toggles and delivery methods.

Home Screen & Workspaces

• The Home Page — Board tiles, quick actions, starred boards, and layout overview.
• Workspaces — Workspace management, colours, drag reorder, and context menu.
• Creating & Managing Boards — Board creation, context menu actions, and board card management.

Boards

• Board Overview — Anatomy of a board, navbar, member avatars, and responsive layout.
• Lists & Columns — Creating, renaming, deleting, and configuring list columns.
• Cards — Card preview anatomy, creating/editing/archiving cards.
• Card Detail — Full card modal with description, labels, dates, checklists, comments, attachments, and reminders.
• Drag & Drop — Custom pointer event system, cross-list dragging, mobile gestures, and scroll zones.
• Filtering & Search — Board filter bar with text, label, member, and date filters.
• Real-Time Collaboration — MongoDB Change Streams, Socket.io, and live updates.

Board Settings

• Card Settings — Card display toggles, card size, and default card colour.
• List Settings — Card count, descriptions, collapse, lock, and default positions.
• Labels — Label management and the 18 built-in label colours.
• Users & Permissions — Board member roles and per-member management.
• Invites & Sharing — Invite links, email invites, and pending invites.
• Theme & Colouring — Theme catalog, system vs custom themes, and Intelligent Contrast.
• Background — Background modes, image upload, scale modes, and opacity slider.
• Audit Log — Member activity events, pagination, and retention.

Themes

• Default Themes — The 8 built-in themes and the 20-slot colour palette system.
• Custom Theme Editor — Creating custom themes with the visual editor and live preview.
• Sharing & Managing Themes — Theme permissions, duplicating, and applying themes.

Import & Export

• Importing Boards — Supported formats (Atlantisboard, Trello®, WeKan®, CSV), import flow, and user management.
• Exporting Boards — CSV, Trello®, WeKan®, and Atlantisboard export formats with column configuration.

More

• Offline & PWA — Progressive Web App installation, offline caching, and sync.
• Keyboard Shortcuts & Tips — Keyboard interactions, mobile gestures, and accessibility notes.

---

This wiki is a living document. If you spot an error or have a suggestion, open an issue on the project repository.