Repository files navigation

Colanode is an all-in-one platform for easy collaboration, built to prioritize your data privacy and control. Designed with alocal-first approach, it helps teams communicate, organize, and manage projects—whether online or offline. With Colanode, you get the flexibility of modern collaboration tools, plus the peace of mind that comes from owning your data.

• Real-Time Chat: Stay connected with instant messaging for teams and individuals.
• Rich Text Pages: Create documents, wikis, and notes using an intuitive editor, similar to Notion.
• Customizable Databases: Organize information with structured data, custom fields and dynamic views (table, kanban, calendar).
• File Management: Store, share, and manage files effortlessly within secure workspaces.

Built for both individuals and teams, Colanode adapts to your needs, whether you're running a small project, managing a team, or collaborating across an entire organization. With its self-hosted model, you retain full control over your data while enjoying a polished, feature-rich experience.

Colanode includes a client app (web or desktop) and a self-hosted server. You can connect to multiple servers with a single app, each containing one or moreworkspaces for different teams or projects. After logging in, you pick a workspace to start collaborating—sending messages, editing pages, or updating database records.

All changes you make are saved to a local SQLite database first and then synced to the server. A background process handles this synchronization so you can keep working even if your computer or the server goes offline. Data reads also happen locally, ensuring immediate access to any content you have permissions to view.

Colanode relies onConflict-free Replicated Data Types (CRDTs) - powered byYjs - to allow real-time collaboration on entries like pages or database records. This means multiple people can edit at the same time, and the system gracefully merges everyone's updates. Deletions are also tracked as specialized transactions. Messages and file operations don't support concurrent edits and use simpler database tables.

The easiest way to start using Colanode is through ourweb app, accessible instantly atapp.colanode.com. Simply log in to get started immediately, without any installation.Please note, the web app is currently in early preview and under testing; you may encounter bugs or compatibility issues in certain browsers.

For optimal performance, you can install ourdesktop app, available from ourdownloads page. Both the web and desktop apps allow you to connect to any of our free beta cloud servers:

• Colanode Cloud (EU) – hosted in Europe.
• Colanode Cloud (US) – hosted in the United States.

Both cloud servers are currently available in beta and free to use; pricing details will be announced soon.

If you prefer to host your own Colanode server, check out thehosting/ folder which contains the Docker Compose file and deployment configurations. For Kubernetes deployments, see thehosting/kubernetes/ folder which includes Helm charts and additional documentation. Here's what you need to run Colanode yourself:

• Postgres with thepgvector extension.
• Redis (any Redis-compatible service will work, e.g., Valkey).
• Storage backend for user files. Colanode defaults to local filesystem storage, but you can switch toS3-compatible,Google Cloud Storage, orAzure Blob Storage backends by settingSTORAGE_TYPE.
• Colanode server API, provided as a Docker image.

All required environment variables for the Colanode server can be found in thehosting/docker/docker-compose.yaml file orhosting/kubernetes/README.md for Kubernetes deployments.

To run Colanode locally in development mode:

1. Clone the repository:

   git clone https://github.com/colanode/colanode.gitcd colanode

2. Install dependencies at the project root:

   npm install

3. Start the apps you want to run locally:

   Server

   cd apps/server# Copy the environment variable template and adjust values as neededcp .env.example .envnpm run dev

   To spin up the local dependencies (Postgres, Redis, and Mail server) with Docker Compose—using filesystem storageby default—run this fromthe project root:

   docker compose -f hosting/docker/docker-compose.yaml up -d

   When you prefer an S3-compatible backend locally, enable the optional MinIO service with thes3 profile:

   docker compose -f hosting/docker/docker-compose.yaml --profile s3 up -d

   The compose file includes aserver service. When you want to run the API locally withnpm run dev, commentout (or override) that service so only the supporting services are started.

   Web

   cd apps/webnpm run dev

   Desktop

   cd apps/desktopnpm run dev

Colanode is released under theApache 2.0 License.