logo
AFFiNE Docs
Try Online
Try Online
logo
AFFiNE Docs
Get Started

Core Concepts

Blocks that assemble your next docs, tasks kanban or whiteboard

Elements of AFFiNE

Blocks
Docs
Page Mode
Doc info
Blocks with Databases
Collections
Workspaces
Members
Settings
frames & groups
Slash command
Roadmap
What AFFiNE is Not

Self-host AFFiNE

Install

Requirements
Docker Compose [Recommend]
After Installation
Configuration
Upgrade

Features

Basic User Quota
Team License

Administer

Naming
Domain and HTTPS
Backup and Restore
Email Notifications
OAuth 2.0
Postgres
Redis
Storage
User management
Monitoring

Upgrade Guides

To 0.21

References

Environment Variables
.env
docker-compose.yml

Develop [WIP]

Architecture
Project

Frontend

Setup
Electron
iOS
Android
i18n
Testing

Backend

Setup
Database Migrations
Testing

BlockSuite [WIP]

Architecture

Store

Block Model
Block Reactive
Transformer & Adapter
Contributing
Code Of Conduct

Releases

Version and Releases

Overview

Install

Requirements

  • Hardware
  • Optional Components

Docker Compose [Recommend]

  • Prerequisites
  • Steps
  • Next steps

After Installation

  • Create the first Admin account
  • Optional - Connect your AFFiNE in Desktop App
  • What's next

Configuration

  • Admin Panel
  • Config File

Upgrade

  • Before upgrading
  • Docker compose

Features

Basic User Quota

  • Workspace Seats
  • Workspace Blobs Quota
  • Copilot(AI) Quota

Team License

  • Team Plan
  • Installable License

Administer

Naming

    Domain and HTTPS

    • Terms
    • Reverse Proxy
    • App links

    Backup and Restore

    • Postgres
    • Blobs
    • Configuration

    Email Notifications

    • SMTP Settings

    OAuth 2.0

    • Google
    • Github
    • OIDC

    Postgres

    • Upgrade Postgres major version in Docker
    • Use standalone Postgres

    Redis

    • Databases
    • Use standalone Redis

    Storage

    • Cloudflare R2

    User management

    • Import Users
    • Delete/Ban Users

    Monitoring

      Upgrade Guides

      To 0.21

      • Overview
      • Important Notice
      • Preparation before the upgrade
      • Upgrade method

      References

      Environment Variables

      • Docker Compose
      • Server
      • Database(Postgres)
      • Redis
      • Email

      .env

        docker-compose.yml