AppFlowy Web
⭐️ The Open Source Notion Alternative ⭐️

Use AppFlowy right in your browser

Bring projects, wikis, and teams together with AI

Web • Apps • Discord • Twitter • Reddit • Forum

Table of Contents

• Use Cases
• Features
• Installation
• Development
• Deployment
• Documentation
• License

Use cases

• Build and maintain a knowledge base for your team
• Create and publish documentation for your customers and audience
• Write, publish, and manage content with AI
• Manage tasks and projects for yourself and your team

Features

• Write beautiful documents with rich content types
• Create custom Grid & Kanban Board-view databases to manage and digest data
• Add a Quick Note to jot down lists, ideas, or to-dos
• Invite members to your workspace for seamless collaboration
• Create multiple public and private spaces to better organize your content

Installation

Cloud: we host AppFlowy for you

Sign up for a free account on appflowy.com—it's the fastest way to get started with AppFlowy without hassles

Self-hosted: host AppFlowy on your own server

Take charge of your data; no vendor lock-in. Follow our deployment guide to get started. Join our Discord server to get help!

Docker Deployment (Recommended for Self-Hosting)

For a simple and flexible deployment, you can use the provided Docker Compose setup. This is the recommended method for self-hosting, especially in a homelab environment with a reverse proxy.

Prerequisites

• Docker
• Docker Compose

Quick Start

1. Clone the repository:

   git clone [https://github.com/AppFlowy-IO/AppFlowy-Web.git](https://github.com/AppFlowy-IO/AppFlowy-Web.git)
   cd AppFlowy-Web

2. Configure your environment: Copy the example environment file:

   cp .env.example .env

   You can edit the .env file to change the port the application is exposed on or to add other configurations as needed.

3. Run with Docker Compose:

   docker-compose up -d

The application will be available at http://localhost:3001 by default.

Reverse Proxy Integration

The Docker setup is designed to work with a reverse proxy. The docker-compose.yml file is configured to connect the container to an external Docker network named proxy. If you use a different network name for your reverse proxy, update the networks section in the docker-compose.yml file accordingly.

Built with 🛠️

Development

Check out the development guide for more details

Deployment

Once AppFlowy Cloud has been setup, you can follow the deployment guide to deploy AppFlowy Web.

Documentation

• Deployment Guide - Detailed environment configuration, architecture diagrams, and troubleshooting
• AppFlowy Cloud Repository - Backend setup and configuration
• Official Documentation - Complete AppFlowy documentation

License

Distributed under the AGPLv3 License. See LICENSE.md for more information.