diff --git a/.github/workflows/bats-test.yml b/.github/workflows/bats-test.yml index 222399ff7e..1c965c22a6 100644 --- a/.github/workflows/bats-test.yml +++ b/.github/workflows/bats-test.yml @@ -3,7 +3,7 @@ name: Run BATS Tests on: push: paths: - - 'docker-compose/setup-script/noco.sh' + - 'docker-compose/1_Auto_Upstall/noco.sh' workflow_dispatch: jobs: diff --git a/README.md b/README.md index 640fed6ca0..74576b8672 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

- +
NocoDB @@ -10,15 +10,9 @@

-Turns any MySQL, PostgreSQL, SQL Server, SQLite & MariaDB into a smart spreadsheet. +NocoDB is the fastest and easiest way to build databases online.

-
- -[![Node version](https://img.shields.io/badge/node-%3E%3D%2018.19.1-brightgreen)](http://nodejs.org/download/) -[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-green.svg)](https://conventionalcommits.org) - -

Website โ€ข @@ -49,10 +43,6 @@ Turns any MySQL, PostgreSQL, SQL Server, SQLite & MariaDB into a smart spreadshe -# Join Our Team - -

- # Join Our Community @@ -61,50 +51,63 @@ Turns any MySQL, PostgreSQL, SQL Server, SQLite & MariaDB into a smart spreadshe [![Stargazers repo roster for @nocodb/nocodb](http://reporoster.com/stars/nocodb/nocodb)](https://github.com/nocodb/nocodb/stargazers) -# Quick try -## Docker +# Installation -```bash -# 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 with SQLite -## Docker Compose +```bash +docker run -d --name noco + -v "$(pwd)"/nocodb:/usr/app/data/ + -p 8080:8080 + nocodb/nocodb:latest +``` + +## Docker with PG +```bash +docker run -d --name noco + -v "${pwd}"/nocodb:/usr/app/data/ + -p 8080:8080 + # replace with your pg connection string + -e NC_DB="pg://host.docker.internal:5432?u=root&p=password&d=d1" + # replace with a random secret + -e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" + nocodb/nocodb:latest +``` -We provide different docker-compose.yml files under [this directory](https://github.com/nocodb/nocodb/tree/master/docker-compose). Here are some examples. +## Auto-upstall +Auto-upstall is a single command that sets up NocoDB on a server for production usage. +Behind the scenes it auto-generates docker-compose for you. ```bash -git clone https://github.com/nocodb/nocodb -cd nocodb/docker-compose/pg +bash <(curl -sSL http://install.nocodb.com/noco.sh) <(mktemp) ``` -# GUI +Auto-upstall does the following : ๐Ÿ•Š +- ๐Ÿณ Automatically installs all pre-requisites like docker, docker-compose +- ๐Ÿš€ Automatically installs NocoDB with PostgreSQL, Redis, Minio, Traefik gateway using Docker Compose. ๐Ÿ˜ ๐Ÿ—„๏ธ ๐ŸŒ +- ๐Ÿ”„ Automatically upgrades NocoDB to the latest version when you run the command again. +- ๐Ÿ”’ Automatically setups SSL and also renews it. Needs a domain or subdomain as input while installation. +> install.nocodb.com/noco.sh script can be found [here in our github](https://raw.githubusercontent.com/nocodb/nocodb/develop/docker-compose/setup-script/noco.sh) + + + +## Other Methods + +> Binaries are only for quick testing locally. -Access Dashboard using: [http://localhost:8080/dashboard](http://localhost:8080/dashboard) +| Install Method | Command to install | +|-------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ๐Ÿ MacOS arm64
(Binary) | `curl http://get.nocodb.com/macos-arm64 -o nocodb -L && chmod +x nocodb && ./nocodb` | +| ๐Ÿ MacOS x64
(Binary) | `curl http://get.nocodb.com/macos-x64 -o nocodb -L && chmod +x nocodb && ./nocodb` | +| ๐Ÿง Linux arm64
(Binary) | `curl http://get.nocodb.com/linux-arm64 -o nocodb -L && chmod +x nocodb && ./nocodb` | +| ๐Ÿง Linux x64
(Binary) | `curl http://get.nocodb.com/linux-x64 -o nocodb -L && chmod +x nocodb && ./nocodb` | +| ๐ŸชŸ Windows arm64
(Binary) | `iwr http://get.nocodb.com/win-arm64.exe -o Noco-win-arm64.exe && .\Noco-win-arm64.exe` | +| ๐ŸชŸ Windows x64
(Binary) | `iwr http://get.nocodb.com/win-x64.exe -o Noco-win-x64.exe && .\Noco-win-x64.exe` | + + +> When running locally access nocodb by visiting: [http://localhost:8080/dashboard](http://localhost:8080/dashboard) # Screenshots ![2](https://github.com/nocodb/nocodb/assets/86527202/a127c05e-2121-4af2-a342-128e0e2d0291) @@ -122,40 +125,16 @@ Access Dashboard using: [http://localhost:8080/dashboard](http://localhost:8080/ ![11](https://user-images.githubusercontent.com/35857179/194844903-c1e47f40-e782-4f5d-8dce-6449cc70b181.png) ![12](https://user-images.githubusercontent.com/35857179/194844907-09277d3e-cbbf-465c-9165-6afc4161e279.png) -# Table of Contents - -- [Quick try](#quick-try) - - [Docker](#docker) - - [Docker Compose](#docker-compose) -- [GUI](#gui) -- [Join Our Community](#join-our-community) -- [Screenshots](#screenshots) -- [Table of Contents](#table-of-contents) -- [Features](#features) - - [Rich Spreadsheet Interface](#rich-spreadsheet-interface) - - [App Store for Workflow Automations](#app-store-for-workflow-automations) - - [Programmatic Access](#programmatic-access) - - [Sync Schema](#sync-schema) - - [Audit](#audit) -- [Production Setup](#production-setup) - - [Environment variables](#environment-variables) -- [Development Setup](#development-setup) -- [Contributing](#contributing) -- [Why are we building this?](#why-are-we-building-this) -- [Our Mission](#our-mission) -- [License](#license) -- [Contributors](#contributors) - # Features ### Rich Spreadsheet Interface - โšก  Basic Operations: Create, Read, Update and Delete Tables, Columns, and Rows -- โšก  Fields Operations: Sort, Filter, Hide / Unhide Columns -- โšก  Multiple Views Types: Grid (By default), Gallery, Form View and Kanban View +- โšก  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, LinkToAnotherRecord, Lookup, Rollup, SingleLineText, Attachment, Currency, Formula, etc +- โšก  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 ... @@ -174,26 +153,6 @@ We provide the following ways to let users programmatically invoke actions. You - โšก  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. - -# Production Setup - -By default, SQLite is used for storing metadata. However, you can specify your database. The connection parameters for this database can be specified in `NC_DB` environment variable. Moreover, we also provide the below environment variables for configuration. - -## Environment variables - -Please refer to the [Environment variables](https://docs.nocodb.com/getting-started/self-hosted/environment-variables) - -# Development Setup - -Please refer to [Development Setup](https://docs.nocodb.com/engineering/development-setup) - # Contributing Please refer to [Contribution Guide](https://github.com/nocodb/nocodb/blob/master/.github/CONTRIBUTING.md). @@ -212,6 +171,8 @@ Our mission is to provide the most powerful no-code interface for databases that This project is licensed under AGPLv3.

+ + # Contributors Thank you for your contributions! We appreciate all the contributions from the community. diff --git a/docker-compose/1_Auto_Upstall/README.md b/docker-compose/1_Auto_Upstall/README.md new file mode 100644 index 0000000000..53794b8160 --- /dev/null +++ b/docker-compose/1_Auto_Upstall/README.md @@ -0,0 +1,15 @@ +# NocoDB : Auto-upstall script + +### Usage + +```bash +./noco.sh +```` + +### Notes + +This simple command : ๐Ÿ•Š +- ๐Ÿณ Automatically installs all pre-requisites like docker, docker-compose +- ๐Ÿš€ Automatically installs NocoDB with PostgreSQL, Redis, Minio, Traefik gateway using Docker Compose. ๐Ÿ˜ ๐Ÿ—„๏ธ ๐ŸŒ +- ๐Ÿ”„ Automatically upgrades NocoDB to the latest version when you run the command again. +- ๐Ÿ”’ Automatically setups SSL and also renews it. Needs a domain or subdomain as input while installation. diff --git a/docker-compose/setup-script/noco.sh b/docker-compose/1_Auto_Upstall/noco.sh similarity index 100% rename from docker-compose/setup-script/noco.sh rename to docker-compose/1_Auto_Upstall/noco.sh diff --git a/docker-compose/setup-script/tests/configure/monitor.bats b/docker-compose/1_Auto_Upstall/tests/configure/monitor.bats similarity index 100% rename from docker-compose/setup-script/tests/configure/monitor.bats rename to docker-compose/1_Auto_Upstall/tests/configure/monitor.bats diff --git a/docker-compose/setup-script/tests/configure/restart.bats b/docker-compose/1_Auto_Upstall/tests/configure/restart.bats similarity index 100% rename from docker-compose/setup-script/tests/configure/restart.bats rename to docker-compose/1_Auto_Upstall/tests/configure/restart.bats diff --git a/docker-compose/setup-script/tests/configure/scale.bats b/docker-compose/1_Auto_Upstall/tests/configure/scale.bats similarity index 100% rename from docker-compose/setup-script/tests/configure/scale.bats rename to docker-compose/1_Auto_Upstall/tests/configure/scale.bats diff --git a/docker-compose/setup-script/tests/configure/setup.sh b/docker-compose/1_Auto_Upstall/tests/configure/setup.sh similarity index 100% rename from docker-compose/setup-script/tests/configure/setup.sh rename to docker-compose/1_Auto_Upstall/tests/configure/setup.sh diff --git a/docker-compose/setup-script/tests/configure/start.bats b/docker-compose/1_Auto_Upstall/tests/configure/start.bats similarity index 100% rename from docker-compose/setup-script/tests/configure/start.bats rename to docker-compose/1_Auto_Upstall/tests/configure/start.bats diff --git a/docker-compose/setup-script/tests/configure/stop.bats b/docker-compose/1_Auto_Upstall/tests/configure/stop.bats similarity index 100% rename from docker-compose/setup-script/tests/configure/stop.bats rename to docker-compose/1_Auto_Upstall/tests/configure/stop.bats diff --git a/docker-compose/setup-script/tests/configure/upgrade.bats b/docker-compose/1_Auto_Upstall/tests/configure/upgrade.bats similarity index 100% rename from docker-compose/setup-script/tests/configure/upgrade.bats rename to docker-compose/1_Auto_Upstall/tests/configure/upgrade.bats diff --git a/docker-compose/setup-script/tests/expects/configure/monitor.sh b/docker-compose/1_Auto_Upstall/tests/expects/configure/monitor.sh similarity index 100% rename from docker-compose/setup-script/tests/expects/configure/monitor.sh rename to docker-compose/1_Auto_Upstall/tests/expects/configure/monitor.sh diff --git a/docker-compose/setup-script/tests/expects/configure/restart.sh b/docker-compose/1_Auto_Upstall/tests/expects/configure/restart.sh similarity index 100% rename from docker-compose/setup-script/tests/expects/configure/restart.sh rename to docker-compose/1_Auto_Upstall/tests/expects/configure/restart.sh diff --git a/docker-compose/setup-script/tests/expects/configure/scale.sh b/docker-compose/1_Auto_Upstall/tests/expects/configure/scale.sh similarity index 100% rename from docker-compose/setup-script/tests/expects/configure/scale.sh rename to docker-compose/1_Auto_Upstall/tests/expects/configure/scale.sh diff --git a/docker-compose/setup-script/tests/expects/configure/start.sh b/docker-compose/1_Auto_Upstall/tests/expects/configure/start.sh similarity index 100% rename from docker-compose/setup-script/tests/expects/configure/start.sh rename to docker-compose/1_Auto_Upstall/tests/expects/configure/start.sh diff --git a/docker-compose/setup-script/tests/expects/configure/stop.sh b/docker-compose/1_Auto_Upstall/tests/expects/configure/stop.sh similarity index 100% rename from docker-compose/setup-script/tests/expects/configure/stop.sh rename to docker-compose/1_Auto_Upstall/tests/expects/configure/stop.sh diff --git a/docker-compose/setup-script/tests/expects/configure/upgrade.sh b/docker-compose/1_Auto_Upstall/tests/expects/configure/upgrade.sh similarity index 100% rename from docker-compose/setup-script/tests/expects/configure/upgrade.sh rename to docker-compose/1_Auto_Upstall/tests/expects/configure/upgrade.sh diff --git a/docker-compose/setup-script/tests/expects/install/default.sh b/docker-compose/1_Auto_Upstall/tests/expects/install/default.sh similarity index 100% rename from docker-compose/setup-script/tests/expects/install/default.sh rename to docker-compose/1_Auto_Upstall/tests/expects/install/default.sh diff --git a/docker-compose/setup-script/tests/expects/install/ip.sh b/docker-compose/1_Auto_Upstall/tests/expects/install/ip.sh similarity index 100% rename from docker-compose/setup-script/tests/expects/install/ip.sh rename to docker-compose/1_Auto_Upstall/tests/expects/install/ip.sh diff --git a/docker-compose/setup-script/tests/expects/install/redis.sh b/docker-compose/1_Auto_Upstall/tests/expects/install/redis.sh similarity index 100% rename from docker-compose/setup-script/tests/expects/install/redis.sh rename to docker-compose/1_Auto_Upstall/tests/expects/install/redis.sh diff --git a/docker-compose/setup-script/tests/expects/install/scale.sh b/docker-compose/1_Auto_Upstall/tests/expects/install/scale.sh similarity index 100% rename from docker-compose/setup-script/tests/expects/install/scale.sh rename to docker-compose/1_Auto_Upstall/tests/expects/install/scale.sh diff --git a/docker-compose/setup-script/tests/expects/install/ssl.sh b/docker-compose/1_Auto_Upstall/tests/expects/install/ssl.sh similarity index 100% rename from docker-compose/setup-script/tests/expects/install/ssl.sh rename to docker-compose/1_Auto_Upstall/tests/expects/install/ssl.sh diff --git a/docker-compose/setup-script/tests/expects/install/watchtower.sh b/docker-compose/1_Auto_Upstall/tests/expects/install/watchtower.sh similarity index 100% rename from docker-compose/setup-script/tests/expects/install/watchtower.sh rename to docker-compose/1_Auto_Upstall/tests/expects/install/watchtower.sh diff --git a/docker-compose/setup-script/tests/install/default.bats b/docker-compose/1_Auto_Upstall/tests/install/default.bats similarity index 100% rename from docker-compose/setup-script/tests/install/default.bats rename to docker-compose/1_Auto_Upstall/tests/install/default.bats diff --git a/docker-compose/setup-script/tests/install/ip.bats b/docker-compose/1_Auto_Upstall/tests/install/ip.bats similarity index 100% rename from docker-compose/setup-script/tests/install/ip.bats rename to docker-compose/1_Auto_Upstall/tests/install/ip.bats diff --git a/docker-compose/setup-script/tests/install/redis.bats b/docker-compose/1_Auto_Upstall/tests/install/redis.bats similarity index 100% rename from docker-compose/setup-script/tests/install/redis.bats rename to docker-compose/1_Auto_Upstall/tests/install/redis.bats diff --git a/docker-compose/setup-script/tests/install/scale.bats b/docker-compose/1_Auto_Upstall/tests/install/scale.bats similarity index 100% rename from docker-compose/setup-script/tests/install/scale.bats rename to docker-compose/1_Auto_Upstall/tests/install/scale.bats diff --git a/docker-compose/setup-script/tests/install/setup.sh b/docker-compose/1_Auto_Upstall/tests/install/setup.sh similarity index 100% rename from docker-compose/setup-script/tests/install/setup.sh rename to docker-compose/1_Auto_Upstall/tests/install/setup.sh diff --git a/docker-compose/setup-script/tests/install/ssl.bats b/docker-compose/1_Auto_Upstall/tests/install/ssl.bats similarity index 100% rename from docker-compose/setup-script/tests/install/ssl.bats rename to docker-compose/1_Auto_Upstall/tests/install/ssl.bats diff --git a/docker-compose/setup-script/tests/install/watchtower.bats b/docker-compose/1_Auto_Upstall/tests/install/watchtower.bats similarity index 100% rename from docker-compose/setup-script/tests/install/watchtower.bats rename to docker-compose/1_Auto_Upstall/tests/install/watchtower.bats diff --git a/docker-compose/setup-script/tests/mocks/clear b/docker-compose/1_Auto_Upstall/tests/mocks/clear similarity index 100% rename from docker-compose/setup-script/tests/mocks/clear rename to docker-compose/1_Auto_Upstall/tests/mocks/clear diff --git a/docker-compose/setup-script/tests/mocks/nproc b/docker-compose/1_Auto_Upstall/tests/mocks/nproc similarity index 100% rename from docker-compose/setup-script/tests/mocks/nproc rename to docker-compose/1_Auto_Upstall/tests/mocks/nproc diff --git a/docker-compose/pg/docker-compose.yml b/docker-compose/2_pg/docker-compose.yml similarity index 100% rename from docker-compose/pg/docker-compose.yml rename to docker-compose/2_pg/docker-compose.yml diff --git a/docker-compose/traefik/.env b/docker-compose/3_traefik/.env similarity index 100% rename from docker-compose/traefik/.env rename to docker-compose/3_traefik/.env diff --git a/docker-compose/traefik/README.md b/docker-compose/3_traefik/README.md similarity index 100% rename from docker-compose/traefik/README.md rename to docker-compose/3_traefik/README.md diff --git a/docker-compose/traefik/docker-compose.yml b/docker-compose/3_traefik/docker-compose.yml similarity index 100% rename from docker-compose/traefik/docker-compose.yml rename to docker-compose/3_traefik/docker-compose.yml diff --git a/docker-compose/aio/.env b/docker-compose/aio/.env deleted file mode 100644 index e992e1f60e..0000000000 --- a/docker-compose/aio/.env +++ /dev/null @@ -1,2 +0,0 @@ -NC_INSTALL_ROOT=./ -NO_COLOR=NEST_JS_LOG_MESSAGE_NO_COLOR_SET_NON_NULL_VALUE \ No newline at end of file diff --git a/docker-compose/aio/.gitignore b/docker-compose/aio/.gitignore deleted file mode 100644 index da79846d85..0000000000 --- a/docker-compose/aio/.gitignore +++ /dev/null @@ -1,3 +0,0 @@ -conf/ -data/ -logs/ \ No newline at end of file diff --git a/docker-compose/aio/README.md b/docker-compose/aio/README.md deleted file mode 100644 index 54792da5a0..0000000000 --- a/docker-compose/aio/README.md +++ /dev/null @@ -1,71 +0,0 @@ -# Install all-in-one nocodb with Docker (compose) - -This page provides instructions to install nocodb all-in-one (aio) using Docker-Compse. The installation will run multiple contianers in single node which includes -- nocodb -- postgres -- nginx -- redis - -## Prerequisites -Before you begin, ensure you have the following prerequisites: - -- Docker (version 20.10.7 or later) -- Docker-Compose (version 2.17.3 or later) -- Ports 80 and 443 are available - -TIP: you could simply run [./pre-req-check.sh](./pre-req-check.sh) which performs pre-requisite check. - -## Install -Run [install.sh](./install.sh), This script performs pre-requisite check, prompts you through required application properties and finally performs `docker-compose up -d`. -For most cases where no external integration required. The defaults properties are just fine. -``` -sudo ./install.sh -``` -Note: sudo is required for docker to run unless you have configured docker user to be part of sudoers. If sudo is not used then you will get error `('Connection aborted.', PermissionError(13, 'Permission denied'))` - -* At this point, your installation is completed and you should be able to access your nocodb instance * - -### An example output will be like below. -``` -./install.sh -** Performing nocodb system check and setup. This step may require sudo permissions - | Checking if required tools (docker, docker-compose, jq, lsof) are installed... - | Checking port accessibility... - | Port 80 is free. - | WARNING: Port 443 is in use. Please make sure it is free. -** System check completed successfully. ** -** Few pre-requisites are failing. Recommend to resolve and proceed. However you could still proceed to install ** - | Press Y to continue or N to skip (Y/N)? -Preparing environment file before install.. - | Press Y to continue with defaults or N to customise app properties (Y/N) -Backing up previous docker-compose/aio/conf/nc_properties.env file to nocodb/docker-compose/aio/conf/nc_properties.env-1707455571.bak -Environment variables written to docker-compose/aio/conf/nc_properties.env file. -Installing docker containers -``` - -## Data and Conf directories -This directory acts as the NC_INSTALL_ROOT by default and it will have data, conf directories which are `.gitingore` to avoid accidentlly exposing to git repository. -During installation the default properties are configured at [nc_properties.env](./conf/nc_properties.env) which can be updated if required and restarted - -``` -. -โ”œโ”€โ”€ conf -โ”‚ โ””โ”€โ”€ nc_properties.env -โ”œโ”€โ”€ data -โ”‚ โ”œโ”€โ”€ nginx -โ”‚ โ”œโ”€โ”€ nocodb -โ”‚ โ”œโ”€โ”€ postgres -โ”‚ โ””โ”€โ”€ redis -โ”œโ”€โ”€ docker -โ”‚ โ””โ”€โ”€ docker-compose.yml -``` - - -## what does install.sh do -[Install script](./install.sh) performs the following steps -1. pre-req-check.sh and warns if there is anything missing which could potentially cause issues at later stage. However it will let you proceed if you wish to. -2. create application properties file under conf dir which will then be used for future upgrades etc. -3. runs docker-compose up -d - -## Advanced Operations -Refer [advanced section](./advanced.md) for advanced operations like setting up ssl, updating configurations, restarts etc diff --git a/docker-compose/aio/advanced.md b/docker-compose/aio/advanced.md deleted file mode 100644 index 36e9b310b6..0000000000 --- a/docker-compose/aio/advanced.md +++ /dev/null @@ -1,47 +0,0 @@ -# Advanced operations - -## Restarting containers -There are atleast 4 main containers which are running as part of this installation through same docker-compose. The same docker-compose can be leveraged to restart any or all of these containers. - -Use [restart.sh](./bin/restart.sh) or Use below command to restart all containers -``` docker compose restart ``` - -To restart individual containers with name ( names: nocodb, nginx, postgres, redis)\ -ex: to restart nginx\ -``` docker compose restart nginx ``` - -## Reload nginx -use utility script at [./bin/nginx_reload.sh](./bin/nginx_reload.sh) - -## [TBD] Upgrade nocodb instance - -## Enable SSL -To enable SSL for incoming https requests, nginx should be configured with combination of a public certificate and a private key. The SSL private key is kept secret on the server. It will be used to encrypt content sent to clients. -Below are different approaches to get and configure certificates. Make your choice -### letsencrypt for generating certificates -Certificates/key can be obtained by trusted CA (Certificate Authorities), there are many paid vendors found online or you can also use [letsencrypt](https://letsencrypt.org/) a non profit certificate provider for free however we recommend [donating](https://www.abetterinternet.org/donate/) for their work. - -Run the script to create certificate using the script -``` -./bin/gen_letsencrypt_cert.sh -``` - -### [TBD] Bring your own certificates -If you already have the certificates, either self signed or generated by any other means, you will need to configure them with nginx. Below are the steps - -### [TBD] Self signed certificates -One of the pre-requisite is that your server should be associated with the domain name. In the absence of that you could use self signed certificates which does ecrypt but browsers show warning. - -## Database password rotation -As a security measure, It is best practice to rotate the database credentials periodically. Assuming you would have created new credentials in postgres database. The db credentials are persisted on filesystem as part of initial install and it will be available at -[./conf/nc_properties.env](./conf/nc_properties.env)\ -update properties POSTGRES_USER, POSTGRES_PASSWORD with new credentials and [restarting nocodb](#restarting-containers) with\ -```docker compose restart nocodb``` - -## nginx configurations -There are two main directories where nginx configurations are maintained -- nocodb team managed configurations at [nginx/conf.d](./conf/nginx/conf.d). -- self managed (you) [conf/nginx/conf.d](./conf/nginx/conf.d) - -## postgres configurations -[postgres.conf](./data/postgres/postgresql.conf) and [pg_hba.conf](./data/postgres/pg_hba.conf) are created under ./data/postgres directory upon first postgres container creation. The configurations can be updated and restarted continer to take affect. \ No newline at end of file diff --git a/docker-compose/aio/bin/gen_letsencrypt_cert.sh b/docker-compose/aio/bin/gen_letsencrypt_cert.sh deleted file mode 100755 index 852a1e58df..0000000000 --- a/docker-compose/aio/bin/gen_letsencrypt_cert.sh +++ /dev/null @@ -1,39 +0,0 @@ -#!/bin/bash -# expects nginx to be up and running with conf.d/certbot.conf -# dns to be mapped to the machine where cert is generated -# - -SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd ) - -SERVER_NAME=${1} -if [[ -z "$SERVER_NAME" ]] -then - echo "required argument servername" - echo "usage ex: ./gen_certs my.nocodb.com" - exit 1 -fi - -echo "Creating configs for SERVER_NAME: ${SERVER_NAME}" -cd ${SCRIPT_DIR}/../conf/nginx/conf.d -sed "s,,${SERVER_NAME},g" ${SCRIPT_DIR}/../nginx/conf-templates/certbot_conf.template > certbot.conf - -cd ${SCRIPT_DIR}/../bin -./nginx_start.sh -./nginx_reload.sh - -echo "Triggering certbot to create ssl configs: ${SERVER_NAME}" -cd ${SCRIPT_DIR}/.. -docker-compose run --rm certbot certonly --webroot --webroot-path /var/www/certbot/ -d ${SERVER_NAME} -result=$? - -if [[ $result == 1 ]]; then - echo "cert generation failed" - echo "rolling back the certs and reloading nginx" -else - echo "Now reload nginx with new ssl configs for your site : ${SERVER_NAME}" - cd ${SCRIPT_DIR}/../conf/nginx/conf.d - rm -f certbot.conf - sed "s,,${SERVER_NAME},g" ${SCRIPT_DIR}/../nginx/conf-templates/ssl_server_name_conf.template > ${SERVER_NAME}.conf -fi -rm -rf ${SCRIPT_DIR}/../conf/nginx/conf.d/certbot.conf -${SCRIPT_DIR}/../bin/nginx_reload.sh diff --git a/docker-compose/aio/bin/nginx_reload.sh b/docker-compose/aio/bin/nginx_reload.sh deleted file mode 100755 index 3e591ee95b..0000000000 --- a/docker-compose/aio/bin/nginx_reload.sh +++ /dev/null @@ -1,2 +0,0 @@ -#!/bin/bash -docker exec -it nginx /etc/init.d/nginx reload \ No newline at end of file diff --git a/docker-compose/aio/bin/nginx_start.sh b/docker-compose/aio/bin/nginx_start.sh deleted file mode 100755 index 24b2292837..0000000000 --- a/docker-compose/aio/bin/nginx_start.sh +++ /dev/null @@ -1,12 +0,0 @@ -#!/bin/bash -# starts the docker containers configured in this components -# docker compose dir -# -SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd ) - -COMPONENT_DIR=${SCRIPT_DIR}/../ -cd ${COMPONENT_DIR} -mkdir -p ${COMPONENT_DIR}/data -chmod -R 777 ${COMPONENT_DIR}/data -docker-compose restart nginx - diff --git a/docker-compose/aio/bin/renew_certs.sh b/docker-compose/aio/bin/renew_certs.sh deleted file mode 100755 index 7e9de5b2da..0000000000 --- a/docker-compose/aio/bin/renew_certs.sh +++ /dev/null @@ -1,3 +0,0 @@ -SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd ) -cd ${SCRIPT_DIR}/../ -sudo docker-compose run --rm certbot renew -q \ No newline at end of file diff --git a/docker-compose/aio/bin/restart.sh b/docker-compose/aio/bin/restart.sh deleted file mode 100755 index 4ed2710112..0000000000 --- a/docker-compose/aio/bin/restart.sh +++ /dev/null @@ -1,7 +0,0 @@ -#!/bin/bash -# docker-compose restart all containers utilty script -SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd ) - -COMPONENT_DIR=${SCRIPT_DIR}/../ -cd ${COMPONENT_DIR} -docker-compose restart \ No newline at end of file diff --git a/docker-compose/aio/bin/start.sh b/docker-compose/aio/bin/start.sh deleted file mode 100755 index 2c6c5f6251..0000000000 --- a/docker-compose/aio/bin/start.sh +++ /dev/null @@ -1,7 +0,0 @@ -#!/bin/bash -# docker-compose start -SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd ) - -COMPONENT_DIR=${SCRIPT_DIR}/../ -cd ${COMPONENT_DIR} -docker-compose up -d \ No newline at end of file diff --git a/docker-compose/aio/conf/nc_properties.env b/docker-compose/aio/conf/nc_properties.env deleted file mode 100644 index 9a4755099b..0000000000 --- a/docker-compose/aio/conf/nc_properties.env +++ /dev/null @@ -1,13 +0,0 @@ -# Environment Variables -POSTGRES_USER=postgres -POSTGRES_PASSWORD=test123 -POSTGRES_DB=nocodb -NC_REDIS_URL=redis://redis:6379/4 -NC_DB=pg://postgres:5432?u=postgres&password=${POSTGRES_PASSWORD:-nocodb}&d=postgres -NC_PUBLIC_URL=http://rajanishs-MacBook-Pro.local -NC_CONNECT_TO_EXTERNAL_DB_DISABLED=false -NC_INVITE_ONLY_SIGNUP=false -NC_ADMIN_EMAIL=admin@nocodb.com -NC_ADMIN_PASSWORD=nocodb123 -NC_S3_BUCKET_NAME=nocodb-attachements - diff --git a/docker-compose/aio/docker-compose.yml b/docker-compose/aio/docker-compose.yml deleted file mode 100644 index 5ecbb7f203..0000000000 --- a/docker-compose/aio/docker-compose.yml +++ /dev/null @@ -1,105 +0,0 @@ -version: '3.8' - -networks: - nocodb-001: - # external: true - -services: - redis: - image: redis:latest - container_name: redis - restart: unless-stopped - env_file: - - ${NC_INSTALL_ROOT:-/opt/nocodb}/conf/nc_properties.env - expose: - - "6379" - volumes: - - ${NC_INSTALL_ROOT:-/opt/nocodb}/data/redis:/data - networks: - - nocodb-001 - deploy: - resources: - limits: - cpus: '0.5' - memory: 1000M - - postgres: - image: postgres:14.7 - container_name: postgres - restart: unless-stopped - env_file: - - ${NC_INSTALL_ROOT:-/opt/nocodb}/conf/nc_properties.env - expose: - - "5432" - volumes: - - ${NC_INSTALL_ROOT:-/opt/nocodb}/data/postgres:/var/lib/postgresql/data - networks: - - nocodb-001 - healthcheck: - interval: 10s - retries: 10 - test: "pg_isready -U ${POSTGRES_USER} -d ${POSTGRES_DB}" - timeout: 2s - deploy: - resources: - limits: - cpus: '1' - memory: 1000M - - nocodb: - depends_on: - - postgres - - redis - image: nocodb/nocodb:latest - container_name: nocodb - restart: unless-stopped - env_file: - - ${NC_INSTALL_ROOT:-/opt/nocodb}/conf/nc_properties.env - expose: - - "8080" - volumes: - - ${NC_INSTALL_ROOT:-/opt/nocodb}/data/nocodb:/usr/app/data/ - networks: - - nocodb-001 - deploy: - resources: - limits: - cpus: '1' - memory: 1000M - - nginx: - container_name: nginx - depends_on: - - nocodb - image: nginx - restart: unless-stopped - env_file: - - ${NC_INSTALL_ROOT:-/opt/nocodb}/conf/nc_properties.env - volumes: - - ${NC_INSTALL_ROOT:-/opt/nocodb}/nginx/conf.d:/etc/nginx/conf.d:ro - - ${NC_INSTALL_ROOT:-/opt/nocodb}/conf/nginx/conf.d:/etc/nginx/custom-conf.d:ro - - ${NC_INSTALL_ROOT:-/opt/nocodb}/nginx/conf:/opt/nocohub/nginx/conf - - ${NC_INSTALL_ROOT:-/opt/nocodb}/nginx/conf/nginx.conf:/etc/nginx/nginx.conf:ro - - ${NC_INSTALL_ROOT:-/opt/nocodb}/data/nginx:/opt/nocohub/nginx/data - - ${NC_INSTALL_ROOT:-/opt/nocodb}/conf/nginx/certbot/www:/var/www/certbot/:ro - - ${NC_INSTALL_ROOT:-/opt/nocodb}/conf/nginx/certbot/conf/:/etc/nginx/ssl/:ro - # - ../nginx/conf/ssl:/etc/nginx/ssl/:ro - expose: - - "80" - - "443" - ports: - - "80:80" - - "443:443" - networks: - - nocodb-001 - deploy: - resources: - limits: - cpus: '1' - memory: 1000M - certbot: - container_name: nocodb_certbot - image: certbot/certbot:latest - volumes: - - ${NC_INSTALL_ROOT:-/opt/nocodb}/conf/nginx/certbot/www:/var/www/certbot/:rw - - ${NC_INSTALL_ROOT:-/opt/nocodb}/conf/nginx/certbot/conf/:/etc/letsencrypt/:rw diff --git a/docker-compose/aio/install.sh b/docker-compose/aio/install.sh deleted file mode 100755 index a1c566edab..0000000000 --- a/docker-compose/aio/install.sh +++ /dev/null @@ -1,41 +0,0 @@ -#!/bin/bash -# Performs Initial setup and System Requirements Check - -## 1. validate system requirements -# a. docker, docker-compose, jq installed -# b. port mapping check -# - port 80,443 are free or being used by nginx container -# - port 8080 is open if used for multi-instance setup -# - port 6379 for redis access -# - port 9001 for minio access -# c. docker repo accessiblity quay.io/minio/minio:RELEASE.2023-12-09T18-17-51Z, redis:latest, postgres:14.7, nocodb/nocodb:latest, nginx -# d. licence check (tbd) - -# -- main line code starts here -SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd ) -## utility functions -source ${SCRIPT_DIR}/sbin/util.sh - -${SCRIPT_DIR}/pre-req-check.sh -PRE_REQ_SUCCESS=$? -if [[ ${PRE_REQ_SUCCESS} != 0 ]] -then - echo "** Few pre-requisites are failing. Recommend to resolve and proceed. However you could still proceed to install **" >&2 -else - echo "** All pre-requistites are taken care of. Proceeding to install.. **" -fi - -# ask do you want to proceed with all defaults, -# if yes, then no prompts -if asksure; then - echo "Preparing environment file before install.." - promptUser=true - if asksure " | Press Y to continue with defaults or N to customise app properties (Y/N)"; then - promptUser=false - fi - ${SCRIPT_DIR}/prepare_env.sh ${promptUser} - echo "Installing docker containers" - docker-compose -f ${SCRIPT_DIR}/docker-compose.yml up -d - else - echo "Exiting without install. You can install using docker-compose -f ${SCRIPT_DIR}/docker-compose.yml up -d " -fi \ No newline at end of file diff --git a/docker-compose/aio/nginx/conf-templates/certbot_conf.template b/docker-compose/aio/nginx/conf-templates/certbot_conf.template deleted file mode 100644 index 63b8609c96..0000000000 --- a/docker-compose/aio/nginx/conf-templates/certbot_conf.template +++ /dev/null @@ -1,15 +0,0 @@ -server { - listen 80; - listen [::]:80; - - # chantge server_name while generating cert - server_name ; - - #access_log /var/log/nginx/host.access.log main; - - # this is required for cert generation. - # change server_name as well with cname of required cert - location /.well-known/acme-challenge/ { - root /var/www/certbot; - } -} \ No newline at end of file diff --git a/docker-compose/aio/nginx/conf-templates/ssl_server_name_conf.template b/docker-compose/aio/nginx/conf-templates/ssl_server_name_conf.template deleted file mode 100644 index b6a3eafcbd..0000000000 --- a/docker-compose/aio/nginx/conf-templates/ssl_server_name_conf.template +++ /dev/null @@ -1,33 +0,0 @@ -server { - listen 443 default_server ssl; - listen [::]:443 ssl ; - # chantge server_name while generating cert - server_name ; - - # force https-redirects - if ($scheme = http) { - return 301 https://$server_name$request_uri; - } - - ssl_certificate /etc/nginx/ssl/live//fullchain.pem; - ssl_certificate_key /etc/nginx/ssl/live//privkey.pem; - - location / { - proxy_pass http://nocodb_backend; - proxy_set_header Host $host; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - proxy_set_header X-Forwarded-Proto $scheme; - proxy_http_version 1.1; - proxy_set_header Upgrade $http_upgrade; - proxy_set_header Connection "upgrade"; - proxy_intercept_errors on; - } - - # deny access to .htaccess files, if Apache's document root - # concurs with nginx's one - # - location ~ /\.ht { - deny all; - } -} \ No newline at end of file diff --git a/docker-compose/aio/nginx/conf.d/backends.conf b/docker-compose/aio/nginx/conf.d/backends.conf deleted file mode 100644 index 2090cbe544..0000000000 --- a/docker-compose/aio/nginx/conf.d/backends.conf +++ /dev/null @@ -1,5 +0,0 @@ -upstream nocodb_backend { - server nocodb:8080; - # server nocodb-1:8080; - # server nocodb-2:8080; -} \ No newline at end of file diff --git a/docker-compose/aio/nginx/conf.d/default.conf b/docker-compose/aio/nginx/conf.d/default.conf deleted file mode 100644 index f9a78f3a6c..0000000000 --- a/docker-compose/aio/nginx/conf.d/default.conf +++ /dev/null @@ -1,23 +0,0 @@ -server { - - listen 80; - listen [::]:80; - server_name localhost; - - location / { - proxy_pass http://nocodb_backend; - proxy_set_header Host $host; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - proxy_set_header X-Forwarded-Proto $scheme; - proxy_http_version 1.1; - proxy_set_header Upgrade $http_upgrade; - proxy_set_header Connection "upgrade"; - proxy_intercept_errors on; - error_page 404 = @handle404; - } - - location @handle404 { - rewrite ^ /dashboard permanent; - } -} \ No newline at end of file diff --git a/docker-compose/aio/nginx/conf.d/fe_artf.conf b/docker-compose/aio/nginx/conf.d/fe_artf.conf deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docker-compose/aio/nginx/conf/nginx.conf b/docker-compose/aio/nginx/conf/nginx.conf deleted file mode 100644 index f6a3a2da04..0000000000 --- a/docker-compose/aio/nginx/conf/nginx.conf +++ /dev/null @@ -1,8 +0,0 @@ -events { - worker_connections 1024; -} - -http { - include /etc/nginx/conf.d/*.conf; - include /etc/nginx/custom-conf.d/*.conf; -} \ No newline at end of file diff --git a/docker-compose/aio/pre-req-check.sh b/docker-compose/aio/pre-req-check.sh deleted file mode 100755 index b19a22d119..0000000000 --- a/docker-compose/aio/pre-req-check.sh +++ /dev/null @@ -1,60 +0,0 @@ -#!/bin/bash -# Performs Initial setup and System Requirements Check - -## 1. validate system requirements -# a. docker, docker-compose, jq installed -# b. port mapping check -# - port 80,443 are free or being used by nginx container -# - port 8080 is open if used for multi-instance setup -# - port 6379 for redis access -# - port 9001 for minio access -# c. docker repo accessiblity quay.io/minio/minio:RELEASE.2023-12-09T18-17-51Z, redis:latest, postgres:14.7, nocodb/nocodb:latest, nginx -# d. licence check (tbd) - - -# -- main line code starts here -SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd ) -source ${SCRIPT_DIR}/sbin/util.sh -source ${SCRIPT_DIR}/sbin/install_vars.sh -echo "** Performing nocodb system check and setup. This step may require sudo permissions" -PRE_REQ=0 - -# d. Check if required tools are installed -echo " | Checking if required tools (docker, docker-compose, jq, lsof) are installed..." -for tool in docker docker-compose lsof; do - if ! command -v "$tool" &> /dev/null; then - echo " | Error: $tool is not installed. Please install it before proceeding." - PRE_REQ=1 - fi -done - -# e. Check if NocoDB is already installed and its expected version -# echo "Checking if NocoDB is already installed and its expected version..." -# Replace the following command with the actual command to check NocoDB installation and version -# Example: nocodb_version=$(command_to_get_nocodb_version) -# echo "NocoDB version: $nocodb_install_version" - -# f. Port mapping check -echo " | Checking port accessibility..." -for port in "${REQUIRED_PORTS[@]}"; do - if lsof -Pi :$port -sTCP:LISTEN -t >/dev/null; then - echo " | WARNING: Port $port is in use. Please make sure it is free." >&2 - PRE_REQ=1 - else - echo " | Port $port is free." - fi -done - -# # g. Docker repository accessibility check -# echo "Checking Docker repository accessibility..." -# for image in "${DOCKER_IMAGES[@]}"; do -# if docker pull "$image" &> /dev/null; then -# echo "Docker image $image is accessible." -# else -# echo "Error: Docker image $image is not accessible. Please check the repository or internet connection." -# PRE_REQ=1 -# fi -# done - -echo "** System check completed successfully. **" -exit $PRE_REQ \ No newline at end of file diff --git a/docker-compose/aio/prepare_env.sh b/docker-compose/aio/prepare_env.sh deleted file mode 100755 index 4a9d32faac..0000000000 --- a/docker-compose/aio/prepare_env.sh +++ /dev/null @@ -1,78 +0,0 @@ -#!/bin/bash -# prepares env file with all the required env variables. -# - -# -- main line code starts here -- -SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd ) -source ${SCRIPT_DIR}/sbin/util.sh -source ${SCRIPT_DIR}/sbin/install_vars.sh - -ENV_FILE=${SCRIPT_DIR}/conf/nc_properties.env -bkp_file=${ENV_FILE}-$(date +%s).bak -# Source existing nc_envs.env file to get current values -if [ -f ${ENV_FILE} ]; then - source ${ENV_FILE} - echo "Backing up previous ${ENV_FILE} file to ${bkp_file}" - cp ${ENV_FILE} ${bkp_file} -fi - -function trim(){ - local var="${@}" - echo "$(sed -e 's/[[:space:]]*$//' <<<${var})" -} - -function acceptProperty(){ - local varDetail="$1" - local promptUser="${2:-true}" - prompt=$(echo "$varDetail" | cut -d '|' -f2) - prop=$(echo "$varDetail" | cut -d '|' -f1) - key=$(echo "$prop" | cut -d'=' -f1) - default_value="${prop#*=}" - prev_value_or_default=${!key:-${default_value}} - - # echo promptUser: ${promptUser} - # echo prop: ${prop} - # echo key: ${key} - # echo default_value: ${default_value} - if [[ ${promptUser} == "true" ]]; then - read -p " || Enter value for $key (default: ${prev_value_or_default}): " user_input - fi - - # Use user input or default value if empty - value=$(trim ${user_input:-$prev_value_or_default}) - - # Store key-value pair in a variable - if [[ ${value} != "" ]]; then - userValues="${userValues}${key}=${value}\n" - fi -} -# Iterate over the properties array and prompt user for input -for multi_property_array in basic_properties invite_only_signup_priorities google_login_properties email_properties s3_attachment_properties ; do - array_name="$multi_property_array[@]" # Name of the array to process - array=("${!array_name}") - promptUser="${1}" - for varDetail in "${array[@]}"; do - promptMsg=$(echo "$varDetail" | cut -d '|' -f2) - prop=$(echo "$varDetail" | cut -d '|' -f1) - if [[ ${promptUser} == "true" ]] && [[ ${prop} == "main" ]] - then - echo $promptMsg - if ! asksure; then - # set all defaults here - promptUser=false - fi - continue - fi - if [[ ${prop} != "main" ]]; then - acceptProperty "${varDetail}" "${promptUser}" - fi - done -done - -# Write key-value pairs to nc_envs.env file -echo -e "# Environment Variables\n$userValues" > ${ENV_FILE} - -echo "Environment variables written to ${ENV_FILE} file." - -# echo "creating data conf, data and log directories" -# mkdir -p ${INSTALL_ROOT}/conf ${INSTALL_ROOT}/data ${INSTALL_ROOT}/logs diff --git a/docker-compose/aio/sbin/install_vars.sh b/docker-compose/aio/sbin/install_vars.sh deleted file mode 100644 index 6bee14cb28..0000000000 --- a/docker-compose/aio/sbin/install_vars.sh +++ /dev/null @@ -1,51 +0,0 @@ -nocodb_install_version="1.0.0" # Replace with actual version -REQUIRED_PORTS=(80 443) -DOCKER_IMAGES=("redis:latest" "postgres:14.7" "nocodb/nocodb:latest" "nginx" "certbot/certbot:latest" ) - -# Array of properties with default values -basic_properties=( -"main|Basic Configurations" -"POSTGRES_USER=postgres | Username for postgres database" -"POSTGRES_PASSWORD=test123 | " -"POSTGRES_DB=nocodb | " -"NC_REDIS_URL=redis://redis:6379/4 | default to redis container" -'NC_DB=pg://postgres:5432?u=postgres&password=${POSTGRES_PASSWORD:-nocodb}&d=postgres | hide' -"NC_PUBLIC_URL=http://$(hostname) | Are you using custom DNS, configure NC_PUBLIC_URL to reflect in the invite emails?" -"NC_CONNECT_TO_EXTERNAL_DB_DISABLED=false | Disable connecting to external db?" -) - -invite_only_signup_priorities=( -"main|Allow invite only sign-up" -"NC_INVITE_ONLY_SIGNUP=false | invite only signup?" -"NC_ADMIN_EMAIL=admin@nocodb.com | " -"NC_ADMIN_PASSWORD=nocodb123 | " -) - -google_login_properties=( -"main|Configure Google Login" -"NC_GOOGLE_CLIENT_ID= | Enter Client ID" -"NC_GOOGLE_CLIENT_SECRET= | Enter Client ID") - -email_properties=( -"main|Configure smtp properties" -"NC_SMTP_FROM= |" -"NC_SMTP_HOST= |" -"NC_SMTP_PORT= |" -"NC_SMTP_USERNAME= |" -"NC_SMTP_PASSWORD= |" -"NC_SMTP_SECURE= |" -"NC_SMTP_IGNORE_TLS= |" -) - -s3_attachment_properties=( -"main|Do you want to configure s3 for attachements?" -"NC_S3_BUCKET_NAME=nocodb-attachements |" -"NC_S3_REGION= |" -"NC_S3_ACCESS_KEY= | " -"NC_S3_ACCESS_SECRET= |" -) - -multi_property_array=(basic_properties invite_only_signup_priorities google_login_properties email_properties s3_attachment_properties) - - - diff --git a/docker-compose/aio/sbin/ubuntu-setup.sh b/docker-compose/aio/sbin/ubuntu-setup.sh deleted file mode 100755 index 8c29ba4066..0000000000 --- a/docker-compose/aio/sbin/ubuntu-setup.sh +++ /dev/null @@ -1,18 +0,0 @@ -#!/bin/bash - -echo "install docker and compose" -sudo apt update -sudo install -m 0755 -d /etc/apt/keyrings -curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg -sudo chmod a+r /etc/apt/keyrings/docker.gpg - - -sudo apt update -sudo apt install apt-transport-https ca-certificates curl software-properties-common -y -curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg -echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null -sudo apt update -apt-cache policy docker-ce -sudo apt install docker-ce -y -sudo apt install docker-compose -y -apt-get install jq -y \ No newline at end of file diff --git a/docker-compose/aio/sbin/util.sh b/docker-compose/aio/sbin/util.sh deleted file mode 100644 index b65d4696c5..0000000000 --- a/docker-compose/aio/sbin/util.sh +++ /dev/null @@ -1,24 +0,0 @@ -#!/bin/bash -# this file contains the utility functions -# used during installation -# - -asksure() { -local custom_msg="${@}" -if [[ ${custom_msg} ]]; then - echo -n "${custom_msg}" -else - echo -n " | Press Y to continue or N to skip (Y/N)? " -fi -while read -r -n 1 -s answer; do - if [[ $answer = [YyNn] ]]; then - [[ $answer = [Yy] ]] && retval=0 - [[ $answer = [Nn] ]] && retval=1 - break - fi -done - -echo # just a final linefeed, optics... - -return $retval -} \ No newline at end of file diff --git a/docker-compose/letsencrypt/nc.sh b/docker-compose/letsencrypt/nc.sh deleted file mode 100644 index fc2218f7d2..0000000000 --- a/docker-compose/letsencrypt/nc.sh +++ /dev/null @@ -1,60 +0,0 @@ -#!/usr/bin/env bash - - -read -p "Enter your domain name: " domain -read -p "Enter your email id: " email - -# Docker installation -if [ -x "$(command -v docker)" ]; then - echo "Docker already available" -else - sudo apt-get update - sudo apt-get install -y apt-transport-https ca-certificates curl gnupg2 software-properties-common - curl -fsSL https://download.docker.com/linux/debian/gpg | sudo apt-key add -- - sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/debian buster stable" - sudo apt-get update - sudo apt-get install -y docker-ce docker-ce-cli containerd.io - sudo usermod -a -G docker $USER - echo "Docker installed successfully" -fi - -# Docker compose installation -if [ -x "$(command -v docker-compose)" ]; then - echo "Docker-compose already available" -else - sudo apt-get -y install wget - sudo wget https://github.com/docker/compose/releases/download/1.26.2/docker-compose-$(uname -s)-$(uname -m) -O /usr/local/bin/docker-compose - sudo chmod +x /usr/local/bin/docker-compose - docker-compose --version - echo "Docker-compose installed successfully" -fi - - -#wget https://github.com/evertramos/docker-compose-letsencrypt-nginx-proxy-companion/archive/master.zip -O master.zip -# -#unzip -n master.zip -# -#cd docker-compose-letsencrypt-nginx-proxy-companion-master - -git clone https://github.com/evertramos/docker-compose-letsencrypt-nginx-proxy-companion.git - -cd docker-compose-letsencrypt-nginx-proxy-companion - -OUTPUT1=$(./start.sh) - - - - -docker run -p 8080:8080 -p 8081:8081 -p 8082:8082 -d --name xc-instant \ --e VIRTUAL_HOST="$domain" \ --e LETSENCRYPT_HOST="$domain" \ --e LETSENCRYPT_EMAIL="$email" \ --e VIRTUAL_PORT=8080 \ ---network=webproxy nocodb/nocodb:latest - - - - - - - diff --git a/docker-compose/mysql/docker-compose.yml b/docker-compose/mysql/docker-compose.yml deleted file mode 100644 index 388c7d3752..0000000000 --- a/docker-compose/mysql/docker-compose.yml +++ /dev/null @@ -1,39 +0,0 @@ -version: "2.1" -services: - nocodb: - depends_on: - root_db: - condition: service_healthy - environment: - NC_DB: "mysql2://root_db:3306?u=noco&p=password&d=root_db" - image: "nocodb/nocodb:latest" - ports: - - "8080:8080" - restart: always - volumes: - - "nc_data:/usr/app/data" - root_db: - environment: - MYSQL_DATABASE: root_db - MYSQL_PASSWORD: password - MYSQL_ROOT_PASSWORD: password - MYSQL_USER: noco - healthcheck: - retries: 10 - test: - - CMD - - mysqladmin - - ping - - "-h" - - localhost - timeout: 20s - image: "mysql:8.3.0" - restart: always - volumes: - - "db_data:/var/lib/mysql" -# below line shows how to change charset and collation -# uncomment it if necessary -# command: --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci -volumes: - db_data: {} - nc_data: {} diff --git a/docker-compose/sqlite/nocodb/noco.db b/docker-compose/sqlite/nocodb/noco.db deleted file mode 100644 index 3283348219..0000000000 Binary files a/docker-compose/sqlite/nocodb/noco.db and /dev/null differ diff --git a/markdown/readme/languages/chinese.md b/markdown/readme/languages/chinese.md index f1c91fb2c8..d6187a9f65 100644 --- a/markdown/readme/languages/chinese.md +++ b/markdown/readme/languages/chinese.md @@ -77,7 +77,7 @@ nocodb/nocodb:latest ```bash git clone https://github.com/nocodb/nocodb # ๅฆ‚ๆžœไฝฟ็”จ PostgreSQL ็š„่ฏ -cd nocodb/docker-compose/pg +cd nocodb/docker-compose/2_pg ``` > ไฝ ๅฏไปฅ้€š่ฟ‡ๅœจ 0.10.6 ไปฅไธŠ็š„็‰ˆๆœฌไธญๆŒ‚่ฝฝ `/usr/app/data/` ๆฅๆŒไน…ๅŒ–ๆ•ฐๆฎ๏ผŒๅฆๅˆ™ไฝ ็š„ๆ•ฐๆฎไผšๅœจ้‡ๆ–ฐๅˆ›ๅปบๅฎนๅ™จๅŽๅฎŒๅ…จไธขๅคฑใ€‚ diff --git a/markdown/readme/languages/indonesian.md b/markdown/readme/languages/indonesian.md index 827bc0dde5..60c42dc127 100644 --- a/markdown/readme/languages/indonesian.md +++ b/markdown/readme/languages/indonesian.md @@ -122,7 +122,7 @@ Kami menyediakan berbagai file docker-compose.yml di [bawah direktori](https://g ```bash git clone https://github.com/nocodb/nocodb # for PostgreSQL -cd nocodb/docker-compose/pg +cd nocodb/docker-compose/2_pg docker-compose up -d ``` diff --git a/markdown/readme/languages/ukrainian.md b/markdown/readme/languages/ukrainian.md index df04f274a7..e285f3523f 100644 --- a/markdown/readme/languages/ukrainian.md +++ b/markdown/readme/languages/ukrainian.md @@ -134,7 +134,7 @@ iwr http://get.nocodb.com/win-arm64.exe -o Noco-win-arm64.exe ```bash git clone https://github.com/nocodb/nocodb # ะดะปั PostgreSQL -cd nocodb/docker-compose/pg +cd nocodb/docker-compose/2_pg docker-compose up -d ``` diff --git a/packages/noco-docs/docs/020.getting-started/020.quick-start.md b/packages/noco-docs/docs/020.getting-started/020.quick-start.md index b37931936d..792723088a 100644 --- a/packages/noco-docs/docs/020.getting-started/020.quick-start.md +++ b/packages/noco-docs/docs/020.getting-started/020.quick-start.md @@ -16,7 +16,7 @@ When you opt for self-hosting, you gain the advantage of running an application Setting up NocoDB on your own server is a straightforward process & the articles below will guide you through the steps to get started. -- [Installation](/getting-started/self-hosted/installation) +- [Installation](/getting-started/self-hosted/installation/auto-install) - [Environment Variables](/getting-started/self-hosted/environment-variables) - [Upgrading](/getting-started/self-hosted/upgrading) diff --git a/packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation.md b/packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation.md deleted file mode 100644 index d4033f6416..0000000000 --- a/packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation.md +++ /dev/null @@ -1,410 +0,0 @@ ---- -title: 'Installation' -description: 'Simple installation - takes about three minutes!' -tags: ['Open Source'] -keywords : ['NocoDB installation', 'NocoDB docker installation', 'NocoDB nodejs installation', 'NocoDB quick try', 'NocoDB prerequisites'] ---- - -Simple installation - takes about three minutes! - -## Prerequisites -- [Docker](https://www.docker.com/get-started) or [Node.js](https://nodejs.org/en/download) ( > v18.x ) - -## Quick try - -### Docker - -If you are a Docker user, you may try this way! - - - - -```bash -docker run -d --name nocodb \ --v "$(pwd)"/nocodb:/usr/app/data/ \ --p 8080:8080 \ -nocodb/nocodb:latest -``` - - - - - -```bash -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 -``` - - - - -:::tip -To persist data in docker you can mount volume at `/usr/app/data/` since 0.10.6. In older version mount at `/usr/src/app`. Otherwise your data will be lost after recreating the container. -::: - - -### Docker Compose - -We provide different docker-compose.yml files under [this directory](https://github.com/nocodb/nocodb/tree/master/docker-compose). Here are some examples. - - - - -```bash -git clone https://github.com/nocodb/nocodb -cd nocodb/docker-compose/pg -docker-compose up -d -``` - - - - -:::tip -If `/usr/app/data/` is not mounted, there will be data loss. -::: - - - - - -### Homebrew - -```bash -brew tap nocodb/nocodb -brew install nocodb -nocodb -``` - -### Executables - -You can download executables directly and run without any extra dependency. Use the right command based on your platform. - - - - - -```bash -curl http://get.nocodb.com/macos-x64 -o nocodb -L \ - && chmod +x nocodb \ - && ./nocodb -``` - - - - -```bash -curl http://get.nocodb.com/macos-arm64 -o nocodb -L \ - && chmod +x nocodb \ - && ./nocodb -``` - - - - -```bash -curl http://get.nocodb.com/linux-x64 -o nocodb -L \ - && chmod +x nocodb \ - && ./nocodb -``` - - - -```bash -curl http://get.nocodb.com/linux-arm64 -o nocodb -L \ - && chmod +x nocodb \ - && ./nocodb -``` - - - - -```bash -iwr http://get.nocodb.com/win-x64.exe -OutFile "Noco-win-x64.exe" -.\Noco-win-x64.exe -``` - - - - -```bash -iwr http://get.nocodb.com/win-arm64.exe -OutFile "Noco-win-arm64.exe" -.\Noco-win-arm64.exe -``` - - - - - -### Node Application - -We provide a simple NodeJS Application for getting started. - -```bash -git clone https://github.com/nocodb/nocodb-seed -cd nocodb-seed -npm install -npm start -``` - - -### AWS ECS (Fargate) - -
- Click to Expand - -#### Create ECS Cluster - - ``` - aws ecs create-cluster \ - --cluster-name - ``` - -#### Create Log group - - ``` - aws logs create-log-group \ - --log-group-name /ecs// - ``` - -#### Create ECS Task Definiton - -Every time you create it, it will add a new version. If it is not existing, the version will be 1. - - ```bash - aws ecs register-task-definition \ - --cli-input-json "file://./.json" - ``` - -:::tip -This json file defines the container specification. You can define secrets such as NC_DB and environment variables here. -::: - -Here's the sample Task Definition - - ```json - { - "family": "nocodb-sample-task-def", - "networkMode": "awsvpc", - "containerDefinitions": [{ - "name": "", - "image": "nocodb/nocodb:latest", - "essential": true, - "logConfiguration": { - "logDriver": "awslogs", - "options": { - "awslogs-group": "/ecs//", - "awslogs-region": "", - "awslogs-stream-prefix": "ecs" - } - }, - "secrets": [{ - "name": "", - "valueFrom": "" - }], - "environment": [{ - "name": "", - "value": "" - }], - "portMappings": [{ - "containerPort": 8080, - "hostPort": 8080, - "protocol": "tcp" - }] - }], - "requiresCompatibilities": [ - "FARGATE" - ], - "cpu": "256", - "memory": "512", - "executionRoleArn": "", - "taskRoleArn": "" - } - ``` - -#### Create ECS Service - - ```bash - aws ecs create-service \ - --cluster \ - --service-name \ - --task-definition : \ - --desired-count \ - --launch-type "FARGATE" \ - --platform-version \ - --health-check-grace-period-seconds \ - --network-configuration "awsvpcConfiguration={subnets=[""], securityGroups=[""], assignPublicIp=ENABLED}" \ - --load-balancer targetGroupArn=,containerName=,containerPort= - ``` - -:::tip - -If your service fails to start, you may check the logs in ECS console or in Cloudwatch. Generally it fails due to the connection between ECS container and NC_DB. Make sure the security groups have the correct inbound and outbound rules. - -::: - -
- -### GCP (Cloud Run) - -
- Click to Expand - -#### Pull NocoDB Image on Cloud Shell - -Since Cloud Run only supports images from Google Container Registry (GCR) or Artifact Registry, we need to pull NocoDB image, tag it and push it in GCP using Cloud Shell. Here are some sample commands which you can execute in Cloud Shell. - - ```bash - # pull latest NocoDB image - docker pull nocodb/nocodb:latest - - # tag the image - docker tag nocodb/nocodb:latest gcr.io//nocodb/nocodb:latest - - # push the image to GCR - docker push gcr.io//nocodb/nocodb:latest - ``` - -#### Deploy NocoDB on Cloud Run - - ```bash - gcloud run deploy --image=gcr.io//nocodb/nocodb:latest \ - --region=us-central1 \ - --allow-unauthenticated \ - --platform=managed - ``` - -
- -### DigitalOcean (App) - -
- Click to Expand - -#### Create Apps - -On Home page, Click on Create icon & Select Apps (Deploy your code). - -![Screenshot 2022-02-19 at 12 17 43 PM](https://user-images.githubusercontent.com/86527202/154790558-f8fe5580-5a58-412c-9c2e-145587712bf2.png) - -#### Choose Source: Docker Hub - -![Screenshot 2022-02-19 at 12 22 01 PM](https://user-images.githubusercontent.com/86527202/154790563-b5b6d5b4-0bdc-4718-8cea-0a7ee52f283b.png) - -#### Choose Source: Repository - -Configure Source Repository as `nocodb/nocodb`. Optionally you can pick release tag if you are interested in specific NocoDB version. - -![Screenshot 2022-02-19 at 12 23 11 PM](https://user-images.githubusercontent.com/86527202/154790564-1dcb5e33-3a57-471a-a44c-835a410a0cb7.png) - -#### [Optional] Additional Configurations - -![Screenshot 2022-02-19 at 12 24 44 PM](https://user-images.githubusercontent.com/86527202/154790565-c0234b2e-ad50-4042-90b6-4f8798f1d585.png) - -#### Name your web service -Pick a name for your NocoDB application. This name will become part of URL subsequently -Pick nearest Region for cloud hosting -![Screenshot 2022-02-19 at 12 28 11 PM](https://user-images.githubusercontent.com/86527202/154790567-a6e65e4e-9aa0-4edb-998e-da8803ad6e23.png) - -#### Finalize and Launch - -- Select hosting plan for your NocoDB application - -- Click "Launch APP" - -![Screenshot 2022-02-19 at 12 29 23 PM](https://user-images.githubusercontent.com/86527202/154790570-62044713-5cca-4d06-82ec-f3cc257218a1.png) - -Application will be build & URL will be live in a minute! The URL will be something like https://simply-nocodb-rsyir.ondigitalocean.app/ - -
- -### Cloudron - -
- Click to Expand - -#### Navigate to App Store - -Log into Cloudron and select App Store - -![image](https://user-images.githubusercontent.com/35857179/194700146-aae90503-a8fd-4bc5-8397-39f0bc279606.png) - -#### Search NocoDB - -![image](https://user-images.githubusercontent.com/35857179/194700181-b5303919-70b8-4cf8-bebe-7e75aca601f3.png) - -#### Click Install - -![image](https://user-images.githubusercontent.com/35857179/194700192-d702f5c2-2afa-45c5-9823-4ebe9e141b01.png) - -#### Configure NocoDB - -![image](https://user-images.githubusercontent.com/35857179/194700230-c35e934f-bd93-4948-8f31-935483b30571.png) - -#### Go to My App and Launch NocoDB - -![image](https://user-images.githubusercontent.com/35857179/194700464-50098cb1-bf94-42bb-a63a-cc0aad671913.png) - -
- -### CapRover - -
- Click to Expand - -#### Login and Click One-Click Apps / Databases - -![image](https://user-images.githubusercontent.com/35857179/194701420-7fe5c396-a488-456c-98de-6f2ee1151fc5.png) - -#### Search NocoDB - -![image](https://user-images.githubusercontent.com/35857179/194701537-63e7efc5-013b-4ca9-8659-56e9d536e7d0.png) - -#### Configure NocoDB and Deploy - -![image](https://user-images.githubusercontent.com/35857179/194701576-19519df5-2aa4-435d-8fc6-7bc684b9cfe1.png) - -
- -### Railway - -
- Click to Expand - -#### Navigate to Templates - -Go to [Templates](https://railway.app/templates), Search NocoDB and click Deploy - -![image](https://user-images.githubusercontent.com/35857179/194702833-1bea22ee-6dfa-4024-ac27-e33fe56e5500.png) - -#### Configure NocoDB and Deploy - -![image](https://user-images.githubusercontent.com/35857179/194702960-149393fe-b00f-4d84-9e54-22cb7616ba44.png) - -
- -### FreeBSD / FreeNAS / TrueNAS Jail - -See [here](https://gist.github.com/Zamana/e9281d736f9e9ce5882c6f4b140a590e) provided by [C. R. Zamana](https://github.com/Zamana). - -### Sealos - -[![](https://raw.githubusercontent.com/labring-actions/templates/main/Deploy-on-Sealos.svg)](https://cloud.sealos.io/?openapp=system-template%3FtemplateName%3Dnocodb) - -## Sample Demos - -### Code Sandbox - - - -### Docker deploying with one command - - - -### Using NPX - - - diff --git a/packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation/010.auto-install.md b/packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation/010.auto-install.md new file mode 100644 index 0000000000..8240d785c3 --- /dev/null +++ b/packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation/010.auto-install.md @@ -0,0 +1,96 @@ +--- +title: 'Auto-Upstall' +description: 'Auto-Upstall is a one command setup for NocoDB installation.' +tags: ['Open Source'] +keywords : ['NocoDB installation', 'NocoDB one command installation', 'NocoDB prerequisites'] +--- + +# Auto-Upstall + +> auto-upstall is one command that automatically installs and upgrades NocoDB with SSL setup. + + +```bash +bash <(curl -sSL http://install.nocodb.com/noco.sh) <(mktemp) +``` + +The above command is the fastest and easiest way to self-host NocoDB on a server. It auto-generates a docker-compose for you behind the scenes. + +## Notes on Auto-Upstall +Auto-upstall is a single command that : ๐Ÿ•Š +- ๐Ÿณ First Automatically installs all pre-requisites on your linux based server (docker, docker-compose) +- ๐Ÿš€ Then automatically installs + - ๐Ÿ‡ณ NocoDB, + - ๐Ÿ˜ PostgreSQL, + - โšก Redis, + - ๐Ÿ—„ Minio, + - ๐ŸŒ Traefik gateway. +- ๐Ÿ”„ Also automatically upgrades NocoDB when new versions are available. +- ๐Ÿ”’ And finally automatically setups+renews SSL. + + +## Quick installation guide + +This is quick walkthrough of how to install NocoDB using auto-upstall script. + +- **Step 1** : ๐Ÿ” SSH into your server (Linux-based system - Ubuntu, Debian, CentOS etc.) +- **Step 2** : ๐Ÿš€ Run the below command : + ```bash + bash <(curl -sSL http://install.nocodb.com/noco.sh) <(mktemp) + ``` +- **Step 3** : ๐ŸŒ Open your browser and go to URL + - For ๐ŸŒ HTTP: `http://` + - For ๐Ÿ”’ HTTPS: `https://` +- **Step 4** : ๐Ÿฆ Don't keep the command a secret. Tweet how easy it is. This step is a must! + + +> install.nocodb.com/noco.sh script can be found [here in our github](https://raw.githubusercontent.com/nocodb/nocodb/develop/docker-compose/setup-script/noco.sh) + + +## Detailed installation guide + +1. Run the following command in your terminal: + + ```bash + bash <(curl -sSL http://install.nocodb.com/noco.sh) <(mktemp) + ``` + +3. Follow the installation prompts + - **Domain name**: Enter the IP address or domain name for your NocoDB instance. + - **SSL configuration**: If you entered a valid domain name, you'll be asked if you want to configure SSL. + - **Advanced options**: You can choose to show advanced options or use default settings. + +4. Advanced options (if chosen): + - Choose between community (CE) or enterprise edition (EE) + - Enter license key (for EE) + - Enable/disable Redis for caching + - Enable/disable Minio for file storage + - Configure Minio domain and SSL + - Enable/disable Watchtower for automatic updates + - Set the number of NocoDB instances to run + +5. Wait for installation to complete - takes about 2-5 minutes. + Once done, you'll see a success message with the URL to access your NocoDB instance. + +6. Access NocoDB + Open the URL provided in your browser to access NocoDB. + +7. Congratulations! You should now have a working installation of NocoDB. Enjoy using your new no-code database platform! + + +## Installation management menu + +After installation, you'll be asked if you want to start the management menu. This menu allows you to: + +- Start NocoDB +- Stop NocoDB +- View logs +- Restart NocoDB +- Upgrade NocoDB +- Scale NocoDB (change the number of running instances) +- Monitor NocoDB (view Docker stats) + +## Additional Notes + +- The script creates an update.sh file in the installation directory. You can use this to update NocoDB in the future. +- If you encounter any issues during installation, check the logs for error messages. \ No newline at end of file diff --git a/packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation/020.docker-install.md b/packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation/020.docker-install.md new file mode 100644 index 0000000000..4c8194b9cd --- /dev/null +++ b/packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation/020.docker-install.md @@ -0,0 +1,71 @@ +--- +title: 'Docker' +description: 'Docker installation - takes about three minutes!' +tags: ['Open Source'] +keywords : ['NocoDB installation', 'NocoDB docker installation', 'NocoDB prerequisites'] +--- + +Docker installation - takes about three minutes! + +Docker provides an easy way to install and run NocoDB. Follow these steps to get NocoDB up and running using Docker. + + +## Prerequisites +- [Docker](https://www.docker.com/get-started) + +## Installation Steps + +1. Choose your preferred database: + + + + +``` +docker run -d --name nocodb \ +-v "$(pwd)"/nocodb:/usr/app/data/ \ +-p 8080:8080 \ +nocodb/nocodb:latest +``` + + + + +``` +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 +``` + + + + +2. Once the container is running, you can access NocoDB by opening http://localhost:8080 in your web browser. + + +:::tip +To persist data, always mount a volume at `/usr/app/data/`. Without this, your data will be lost when the container is removed. + +For versions prior to 0.10.6, mount the volume at /usr/src/app. + +::: + +## Troubleshooting + +- If you can't access NocoDB after installation, check if the Docker container is running: + +```bash +docker ps +``` + +- If the container is not running, check the logs for any errors: + +```bash +docker logs nocodb +``` + +## Installation Video + + diff --git a/packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation/030.docker-compose.md b/packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation/030.docker-compose.md new file mode 100644 index 0000000000..1b312b1153 --- /dev/null +++ b/packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation/030.docker-compose.md @@ -0,0 +1,64 @@ +--- +title: 'Docker Compose' +description: 'Install NocoDB using Docker Compose' +tags: ['Open Source'] +keywords : ['NocoDB installation', 'NocoDB docker installation', 'NocoDB prerequisites'] +--- + +# Installing NocoDB with Docker Compose + +Docker Compose allows you to define and run multi-container Docker applications. It's a great way to set up NocoDB along with its database in a single configuration file. + + + +## Prerequisites +- [Docker](https://www.docker.com/get-started) +- [Docker Compose](https://docs.docker.com/compose/install/) + +## Installation Steps + +1. Clone the NocoDB repository from GitHub. + + ```bash + git clone https://github.com/nocodb/nocodb + ``` +2. Navigate to the docker-compose directory + + ```bash + cd nocodb/docker-compose/pg + ``` +3. Start the services using Docker Compose: + + ```bash + docker-compose up -d + ``` + This will start NocoDB along with a PostgreSQL database. + +4. Access NocoDB in your browser by visiting `http://localhost:8080`. + +## Important Notes + +- The provided `docker-compose.yml` files are configured to persist data. Make sure the volumes are properly mounted. +- You can customize the `docker-compose.yml` file to change ports, environment variables, or add additional services. + +## Troubleshooting + +- If you encounter any issues, check the logs using the following command: + + ```bash + docker-compose logs + ``` + +- If you need to stop the services, use the following command: + + ```bash + docker-compose down + ``` + +- Ensure all required ports are available on your host machine. + +- For database connection issues, verify the database service is running: + + ```bash + docker-compose ps + ``` \ No newline at end of file diff --git a/packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation/040.home-brew.md b/packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation/040.home-brew.md new file mode 100644 index 0000000000..3c9cc14da2 --- /dev/null +++ b/packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation/040.home-brew.md @@ -0,0 +1,49 @@ +--- +title: 'Homebrew' +description: 'Install NocoDB using Homebrew' +tags: ['Open Source'] +keywords : ['NocoDB installation', 'NocoDB homebrew installation', 'NocoDB prerequisites'] +--- + +# Installing NocoDB with Homebrew + +Homebrew provides a simple way to install NocoDB on macOS and Linux systems. Follow these steps to install NocoDB using Homebrew. + +## Prerequisites +- [Homebrew](https://brew.sh/) + +## Installation Steps + +1. Add the NocoDB tap to Homebrew: + + ```bash + brew tap nocodb/nocodb + ``` + +2. Install NocoDB: + + ```bash + brew install nocodb + ``` + +3. Start NocoDB: + + ```bash + nocodb + ``` + +4. Access NocoDB in your browser by visiting `http://localhost:8080`. + +## Updating NocoDB + +To update NocoDB to the latest version, use the following command: + +```bash +brew upgrade nocodb +``` + +## Troubleshooting + +- If you encounter permission issues, make sure you have the necessary rights to install packages with Homebrew. + +- If NocoDB doesn't start, check if the default port (8080) is already in use. You can specify a different port using environment variables. diff --git a/packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation/070.aws-ecs.md b/packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation/070.aws-ecs.md new file mode 100644 index 0000000000..89e3e2f7e9 --- /dev/null +++ b/packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation/070.aws-ecs.md @@ -0,0 +1,116 @@ +--- +title: 'AWS ECS (Fargate)' +description: 'AWS ECS (Fargate) Installation' +tags: ['Open Source'] +keywords : ['NocoDB installation', 'NocoDB AWS Fargate installation', 'NocoDB prerequisites'] +--- + +# Deploying NocoDB on AWS ECS (Fargate) + +This guide will walk you through deploying NocoDB on Amazon ECS using Fargate. + +## Prerequisites + +- AWS CLI configured with appropriate permissions +- Basic understanding of AWS ECS and Fargate + +## Deployment Steps + +1. Create ECS Cluster + + ```bash + aws ecs create-cluster --cluster-name + ``` + +2. Create a Log Group: + + ```bash + aws logs create-log-group --log-group-name /ecs// + ``` +3. Create an ECS Task Definition: + + Every time you create it, it will add a new version. If it is not existing, the version will be 1. + ```bash + aws ecs register-task-definition --cli-input-json file://task-definition.json + ``` + :::tip + This json file defines the container specification. You can define secrets such as NC_DB and environment variables here. + ::: + + Example `task-definition.json`: + + ```json + { + "family": "nocodb-sample-task-def", + "networkMode": "awsvpc", + "containerDefinitions": [ + { + "name": "", + "image": "nocodb/nocodb:latest", + "essential": true, + "logConfiguration": { + "logDriver": "awslogs", + "options": { + "awslogs-group": "/ecs//", + "awslogs-region": "", + "awslogs-stream-prefix": "ecs" + } + }, + "secrets": [ + { + "name": "", + "valueFrom": "" + } + ], + "environment": [ + { + "name": "", + "value": "" + } + ], + "portMappings": [ + { + "containerPort": 8080, + "hostPort": 8080, + "protocol": "tcp" + } + ] + } + ], + "requiresCompatibilities": [ + "FARGATE" + ], + "cpu": "256", + "memory": "512", + "executionRoleArn": "", + "taskRoleArn": "" + } + ``` + + +4. Create an ECS Service: + + ```bash + aws ecs create-service \ + --cluster \ + --service-name \ + --task-definition : \ + --desired-count \ + --launch-type "FARGATE" \ + --platform-version \ + --health-check-grace-period-seconds \ + --network-configuration "awsvpcConfiguration={subnets=[""], securityGroups=[""], assignPublicIp=ENABLED}" \ + --load-balancer targetGroupArn=,containerName=,containerPort= + ``` + +:::tip +If your service fails to start, you may check the logs in ECS console or in Cloudwatch. Generally it fails due to the connection between ECS container and NC_DB. Make sure the security groups have the correct inbound and outbound rules. +::: + + +### Important Notes + +- Ensure that your security groups have the correct inbound and outbound rules. +- The NC_DB environment variable should be properly set to connect to your database. +- Monitor the ECS console and CloudWatch logs for any deployment issues. +- You can customize the task definition and service configuration based on your requirements. \ No newline at end of file diff --git a/packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation/080.gcp-cloud-run.md b/packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation/080.gcp-cloud-run.md new file mode 100644 index 0000000000..27e41631b2 --- /dev/null +++ b/packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation/080.gcp-cloud-run.md @@ -0,0 +1,47 @@ +--- +title: 'GCP Cloud Run' +description: 'Installing NocoDB on Google Cloud Run' +tags: ['Open Source'] +keywords : ['NocoDB installation', 'NocoDB Google Cloud run installation', 'NocoDB prerequisites'] +--- + +# Deploying NocoDB on GCP Cloud Run + +This guide will help you deploy NocoDB on Google Cloud Platform using Cloud Run. + +## Prerequisites + +- Google Cloud SDK installed and configured +- [Docker](https://docs.docker.com/get-docker/) + +## Deployment Steps + +1. Pull the NocoDB Docker image: + + ```bash + docker pull nocodb/nocodb:latest + ``` +2. Tag the image for Google Container Registry (GCR): + + ```bash + docker tag nocodb/nocodb:latest gcr.io//nocodb/nocodb:latest + ``` +3. Push the image to GCR: + + ```bash + docker push gcr.io//nocodb/nocodb:latest + ``` +4. Deploy NocoDB on Cloud Run: + + ```bash + gcloud run deploy --image=gcr.io//nocodb/nocodb:latest \ + --region=us-central1 \ + --allow-unauthenticated \ + --platform=managed + ``` + +## Important Notes + +- Cloud Run only supports images from Google Container Registry (GCR) or Artifact registry. Hence we pull the image from Docker Hub and push it to GCR. +- Ensure that your GCP project has the necessary APIs enabled (Cloud Run, Container Registry). +- The `--allow-unauthenticated` flag is used to allow unauthenticated access to the service. You can remove this flag if you want to restrict access. \ No newline at end of file diff --git a/packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation/090.digital-ocean.md b/packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation/090.digital-ocean.md new file mode 100644 index 0000000000..2e209201bc --- /dev/null +++ b/packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation/090.digital-ocean.md @@ -0,0 +1,45 @@ +--- +title: 'DigitalOcean' +description: 'Installing NocoDB on Digital Ocean' +tags: ['Open Source'] +keywords : ['NocoDB installation', 'NocoDB Digital Ocean installation', 'NocoDB prerequisites'] +--- + +# Deploying NocoDB as a DigitalOcean App + +Follow these steps to deploy NocoDB on DigitalOcean using their App Platform. + +## Deployment Steps + +1. On the DigitalOcean homepage, click on the Create icon and select "Apps (Deploy your code)". + + [![DigitalOcean Create App](https://user-images.githubusercontent.com/86527202/154790558-f8fe5580-5a58-412c-9c2e-145587712bf2.png)](https://user-images.githubusercontent.com/86527202/154790558-f8fe5580-5a58-412c-9c2e-145587712bf2.png) +2. Choose "Docker Hub" as the source. + + [![DigitalOcean Docker Hub](https://user-images.githubusercontent.com/86527202/154790563-b5b6d5b4-0bdc-4718-8cea-0a7ee52f283b.png)](https://user-images.githubusercontent.com/86527202/154790563-b5b6d5b4-0bdc-4718-8cea-0a7ee52f283b.png) + +3. Set the source repository as nocodb/nocodb. You can optionally specify a release tag if you want a specific NocoDB version. + + [![DigitalOcean Docker Hub](https://user-images.githubusercontent.com/86527202/154790564-1dcb5e33-3a57-471a-a44c-835a410a0cb7.png)](https://user-images.githubusercontent.com/86527202/154790564-1dcb5e33-3a57-471a-a44c-835a410a0cb7.png) + +4. Configure any additional settings as needed. + + [![DigitalOcean Docker Hub](https://user-images.githubusercontent.com/86527202/154790565-c0234b2e-ad50-4042-90b6-4f8798f1d585.png)](https://user-images.githubusercontent.com/86527202/154790565-c0234b2e-ad50-4042-90b6-4f8798f1d585.png) + +5. Name your web service and select the nearest region for cloud hosting. + + [![DigitalOcean Docker Hub](https://user-images.githubusercontent.com/86527202/154790567-a6e65e4e-9aa0-4edb-998e-da8803ad6e23.png)](https://user-images.githubusercontent.com/86527202/154790567-a6e65e4e-9aa0-4edb-998e-da8803ad6e23.png) + +6. Choose your preferred hosting plan and click on "Launch Basic App". + + [![DigitalOcean Docker Hub](https://user-images.githubusercontent.com/86527202/154790570-62044713-5cca-4d06-82ec-f3cc257218a1.png)](https://user-images.githubusercontent.com/86527202/154790570-62044713-5cca-4d06-82ec-f3cc257218a1.png) + + Your application will be built, and the URL will be live shortly. The URL will look something like https://your-app-name.ondigitalocean.app/. + + +## Important Notes + +- Ensure you configure environment variables for database connections if needed. +- Set up persistent storage for your NocoDB data. +- You can scale your app as needed using DigitalOcean's App Platform. +- Consider enabling automatic deployments for easier updates. diff --git a/packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation/100.other-installations.md b/packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation/100.other-installations.md new file mode 100644 index 0000000000..a430e915a1 --- /dev/null +++ b/packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation/100.other-installations.md @@ -0,0 +1,94 @@ +--- +title: 'Other Installation Methods' +description: 'Installing NocoDB on other platforms' +tags: ['Open Source'] +keywords : ['NocoDB installation', 'NocoDB Digital Ocean installation', 'NocoDB prerequisites'] +--- + +# Installing NocoDB on Other Platforms + +This guide covers installation methods for NocoDB on various platforms including Cloudron, CapRover, Railway, FreeBSD/FreeNAS/TrueNAS Jail, and SealOs. + +## Cloudron + +Cloudron provides an easy way to install and manage NocoDB. + +### Installation Steps + +1. Log in to your Cloudron dashboard. +2. Navigate to the App Store. + + ![https://user-images.githubusercontent.com/35857179/194700146-aae90503-a8fd-4bc5-8397-39f0bc279606.png](https://user-images.githubusercontent.com/35857179/194700146-aae90503-a8fd-4bc5-8397-39f0bc279606.png) +3. Search for NocoDB + + ![https://user-images.githubusercontent.com/35857179/194700181-b5303919-70b8-4cf8-bebe-7e75aca601f3.png](https://user-images.githubusercontent.com/35857179/194700181-b5303919-70b8-4cf8-bebe-7e75aca601f3.png) +4. Click on the NocoDB app, then click "Install". + + ![https://user-images.githubusercontent.com/35857179/194700192-d702f5c2-2afa-45c5-9823-4ebe9e141b01.png](https://user-images.githubusercontent.com/35857179/194700192-d702f5c2-2afa-45c5-9823-4ebe9e141b01.png) +5. Configure NocoDB settings as needed. + + ![https://user-images.githubusercontent.com/35857179/194700230-c35e934f-bd93-4948-8f31-935483b30571.png](https://user-images.githubusercontent.com/35857179/194700230-c35e934f-bd93-4948-8f31-935483b30571.png) +5. Once installed, go to "My Apps" and launch NocoDB. + + ![https://user-images.githubusercontent.com/35857179/194700464-50098cb1-bf94-42bb-a63a-cc0aad671913.png](https://user-images.githubusercontent.com/35857179/194700464-50098cb1-bf94-42bb-a63a-cc0aad671913.png) + +### Important Notes +- Ensure your Cloudron server meets the minimum requirements for running NocoDB. +- Configure backups for your NocoDB instance through Cloudron's backup system. +- Keep your Cloudron and NocoDB app up to date for the latest features and security patches. + +## CapRover + +### Deployment Steps + +1. Log in to your CapRover dashboard. +2. Go to "Apps" and click on "One-Click Apps/Databases". + + ![https://user-images.githubusercontent.com/35857179/194701420-7fe5c396-a488-456c-98de-6f2ee1151fc5.png](https://user-images.githubusercontent.com/35857179/194701420-7fe5c396-a488-456c-98de-6f2ee1151fc5.png) +3. Search for NocoDB and click on it. + + ![https://user-images.githubusercontent.com/35857179/194701537-63e7efc5-013b-4ca9-8659-56e9d536e7d0.png](https://user-images.githubusercontent.com/35857179/194701537-63e7efc5-013b-4ca9-8659-56e9d536e7d0.png) +4. Click on NocoDB to start the configuration process. +5. Configure NocoDB settings as needed and click "Deploy". + + ![https://user-images.githubusercontent.com/35857179/194701576-19519df5-2aa4-435d-8fc6-7bc684b9cfe1.png](https://user-images.githubusercontent.com/35857179/194701576-19519df5-2aa4-435d-8fc6-7bc684b9cfe1.png) +6. Once deployed, you can access NocoDB from the provided URL. + +### Important Notes +- Ensure your CapRover server has sufficient resources to run NocoDB. +- Configure persistent storage for your NocoDB data. +- Set up SSL for secure access to your NocoDB instance. +- Regularly update your CapRover server and NocoDB app for the latest features and security patches. + +## Railway + +### Deployment Steps + +1. Go to Railway Templates. +2. Search for "NocoDB" in the templates list. + + ![https://user-images.githubusercontent.com/35857179/194702833-1bea22ee-6dfa-4024-ac27-e33fe56e5500.png](https://user-images.githubusercontent.com/35857179/194702833-1bea22ee-6dfa-4024-ac27-e33fe56e5500.png) +3. Click on the NocoDB template, then click "Deploy". +4. Configure your NocoDB settings as needed. + + ![https://user-images.githubusercontent.com/35857179/194702960-149393fe-b00f-4d84-9e54-22cb7616ba44.png](https://user-images.githubusercontent.com/35857179/194702960-149393fe-b00f-4d84-9e54-22cb7616ba44.png) +5. Railway will automatically deploy your NocoDB instance. + +### Important Notes +- Make sure to configure environment variables for database connections if needed. +- Set up persistent storage for your NocoDB data. +- Regularly update your NocoDB instance for the latest features and security patches. + +## FreeBSD/FreeNAS/TrueNAS Jail Installation + +For detailed instructions on installing NocoDB on FreeBSD, FreeNAS, or TrueNAS Jail, please refer to the [guide](https://gist.github.com/Zamana/e9281d736f9e9ce5882c6f4b140a590e) provided by [C. R. Zamana.](https://github.com/Zamana) + +## Sealos + +1. Open the NocoDB template by clicking on the following button: + + [![Deploy on Sealos](https://raw.githubusercontent.com/labring-actions/templates/main/Deploy-on-Sealos.svg)](https://cloud.sealos.io/?openapp=system-template%3FtemplateName%3Dnocodb) +2. Follow the on-screen instructions to configure and deploy your NocoDB instance. + + + diff --git a/packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation/_category_.json b/packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation/_category_.json new file mode 100644 index 0000000000..dc5b5b3cac --- /dev/null +++ b/packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Installation", + "collapsible": true, + "collapsed": false, + "link": { + "type": "generated-index" + } +} \ No newline at end of file diff --git a/packages/noco-docs/docs/020.getting-started/050.self-hosted/030.upgrading.md b/packages/noco-docs/docs/020.getting-started/050.self-hosted/030.upgrading.md index 919c17a8f0..877fa659fc 100644 --- a/packages/noco-docs/docs/020.getting-started/050.self-hosted/030.upgrading.md +++ b/packages/noco-docs/docs/020.getting-started/050.self-hosted/030.upgrading.md @@ -5,7 +5,7 @@ tags: ['Open Source'] keywords: ['NocoDB upgrade', 'upgrade NocoDB', 'upgrade nocodb'] --- -By default, if `NC_DB` is not specified upon [installation](/getting-started/self-hosted/installation), then SQLite will be used to store metadata. We suggest users to separate the metadata and user data in different databases as pictured in our [architecture](/engineering/architecture). +By default, if `NC_DB` is not specified upon [installation](/getting-started/self-hosted/installation/auto-install), then SQLite will be used to store metadata. We suggest users to separate the metadata and user data in different databases as pictured in our [architecture](/engineering/architecture). ## Docker diff --git a/packages/noco-docs/docs/020.getting-started/050.self-hosted/_category_.json b/packages/noco-docs/docs/020.getting-started/050.self-hosted/_category_.json index de31bd5b4b..32404eba70 100644 --- a/packages/noco-docs/docs/020.getting-started/050.self-hosted/_category_.json +++ b/packages/noco-docs/docs/020.getting-started/050.self-hosted/_category_.json @@ -1,5 +1,5 @@ { - "label": "In Open Source", + "label": "Self Hosting", "collapsible": true, "collapsed": false, "link": { diff --git a/packages/nocodb/README.md b/packages/nocodb/README.md index ac12480b84..7285cb7c94 100644 --- a/packages/nocodb/README.md +++ b/packages/nocodb/README.md @@ -10,7 +10,7 @@

-Turns any MySQL, PostgreSQL, SQL Server, SQLite & MariaDB into a smart spreadsheet. +NocoDB is the fastest and easiest way to build databases online.