nocodb/README.md

NocoDB

The Open Source Airtable Alternative

Turns any MySQL, PostgreSQL, SQL Server, SQLite & MariaDB into a smart spreadsheet.

Website • Discord • Community • Twitter • Reddit • Documentation

See other languages »

Installation

There are different ways to start using NocoDB. You can either signup on NocoDB Cloud or self-host it. The self-hosting can be done using Docker, Docker Compose, Binaries, or using the script.

One-Click Install

This script installs NocoDB with PostgreSQL, Redis, and Minio (for file storage) using Docker Compose.

bash <(curl -sSL http://install.nocodb.com/noco.sh) <(mktemp)

Docker

# with PostgreSQL
docker run -d --name nocodb-postgres \
-v "$(pwd)"/nocodb:/usr/app/data/ \
-p 8080:8080 \
-e NC_DB="pg://host.docker.internal:5432?u=root&p=password&d=d1" \
-e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \
nocodb/nocodb:latest

# with SQLite : mounting volume `/usr/app/data/` is crucial to avoid data loss.
docker run -d --name nocodb \
-v "$(pwd)"/nocodb:/usr/app/data/ \
-p 8080:8080 \
nocodb/nocodb:latest

Binaries

🚥 Binaries are intended for ONLY quick trials or testing purposes and are not recommended for production use.

OS	Architecture	Command
macOS	arm64	curl http://get.nocodb.com/macos-arm64 -o nocodb -L && chmod +x nocodb && ./nocodb
macOS	x64	curl http://get.nocodb.com/macos-x64 -o nocodb -L && chmod +x nocodb && ./nocodb
Linux	x64	curl http://get.nocodb.com/linux-x64 -o nocodb -L && chmod +x nocodb && ./nocodb
Linux	arm64	curl http://get.nocodb.com/linux-arm64 -o nocodb -L && chmod +x nocodb && ./nocodb
Windows	x64	iwr http://get.nocodb.com/win-x64.exe -o Noco-win-x64.exe &&.\Noco-win-x64.exe
Windows	arm64	iwr http://get.nocodb.com/win-arm64.exe -o Noco-win-arm64.exe && .\Noco-win-arm64.exe

Docker Compose

We provide different docker-compose.yml files under this directory. Here are some examples.

git clone https://github.com/nocodb/nocodb
cd nocodb/docker-compose/pg

GUI

Access Dashboard using: http://localhost:8080/dashboard

Screenshots

Table of Contents

• Quick try
• Installation
  • One-Click Install
  • Binaries
  • Docker
  • Docker Compose
• GUI
• Join Our Community
• Screenshots
• Table of Contents
• Features
  • Rich Spreadsheet Interface
  • App Store for Workflow Automations
  • Programmatic Access
  • Sync Schema
  • Audit
• Production Setup
  • Environment variables
• Development Setup
• Contributing
• Why are we building this?
• Our Mission
• License
• Contributors

Features

Rich Spreadsheet Interface

• ⚡  Basic Operations: Create, Read, Update and Delete Tables, Columns, and Rows
• ⚡  Fields Operations: Sort, Filter, Group, Hide / Unhide Columns
• ⚡  Multiple Views Types: Grid (By default), Gallery, Form, Kanban and Calendar View
• ⚡  View Permissions Types: Collaborative Views, & Locked Views
• ⚡  Share Bases / Views: either Public or Private (with Password Protected)
• ⚡  Variant Cell Types: ID, Links, Lookup, Rollup, SingleLineText, Attachment, Currency, Formula, User, etc
• ⚡  Access Control with Roles: Fine-grained Access Control at different levels
• ⚡  and more ...

App Store for Workflow Automations

We provide different integrations in three main categories. See App Store for details.

• ⚡  Chat: Slack, Discord, Mattermost, and etc
• ⚡  Email: AWS SES, SMTP, MailerSend, and etc
• ⚡  Storage: AWS S3, Google Cloud Storage, Minio, and etc

Programmatic Access

We provide the following ways to let users programmatically invoke actions. You can use a token (either JWT or Social Auth) to sign your requests for authorization to NocoDB.

• ⚡  REST APIs
• ⚡  NocoDB SDK

Sync Schema

We allow you to sync schema changes if you have made changes outside NocoDB GUI. However, it has to be noted then you will have to bring your own schema migrations for moving from one environment to another. See Sync Schema for details.

Audit

We are keeping all the user operation logs in one place. See Audit for details.

Environment variables

Please refer to the Environment variables

Contributing

Please refer to Contribution Guide.

Why are we building this?

Most internet businesses equip themselves with either spreadsheet or a database to solve their business needs. Spreadsheets are used by Billion+ humans collaboratively every single day. However, we are way off working at similar speeds on databases which are way more powerful tools when it comes to computing. Attempts to solve this with SaaS offerings have meant horrible access controls, vendor lock-in, data lock-in, abrupt price changes & most importantly a glass ceiling on what's possible in the future.

Our Mission

Our mission is to provide the most powerful no-code interface for databases that is open source to every single internet business in the world. This would not only democratise access to a powerful computing tool but also bring forth a billion+ people who will have radical tinkering-and-building abilities on the internet.

License

This project is licensed under AGPLv3.

Join Our Team

Join Our Community

Contributors

Thank you for your contributions! We appreciate all the contributions from the community.