diff --git a/README.md b/README.md index f9d6dc192a..08fc2f6a02 100644 --- a/README.md +++ b/README.md @@ -71,113 +71,56 @@ Turns any MySQL, PostgreSQL, SQL Server, SQLite & MariaDB into a smart spreadshe ## Docker ```bash -# for SQLite -docker run -d --name nocodb \ --v "$(pwd)"/nocodb:/usr/app/data/ \ --p 8080:8080 \ -nocodb/nocodb:latest - -# for MySQL -docker run -d --name nocodb-mysql \ +# with PostgreSQL +docker run -d --name nocodb-postgres \ -v "$(pwd)"/nocodb:/usr/app/data/ \ -p 8080:8080 \ --e NC_DB="mysql2://host.docker.internal:3306?u=root&p=password&d=d1" \ +-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 -# for PostgreSQL -docker run -d --name nocodb-postgres \ +# with SQLite +docker run -d --name nocodb \ -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 - - -> To persist data in docker you can mount volume at `/usr/app/data/` since 0.10.6. Otherwise your data will be lost after recreating the container. - -> If you plan to input some special characters, you may need to change the character set and collation yourself when creating the database. Please check out the examples for [MySQL Docker](https://github.com/nocodb/nocodb/issues/1340#issuecomment-1049481043). - -> Different commands just indicate the database that NocoDB will use internally for metadata storage, but that doesn't influence the ability to connect to a different database type. - +> If `/usr/app/data/` is not mounted and containers are recreated - data will be LOST! + ## Binaries - -##### MacOS (x64) - -```bash -curl http://get.nocodb.com/macos-x64 -o nocodb -L && chmod +x nocodb && ./nocodb -``` - -##### MacOS (arm64) +- Binaries are only for quick try or testing purposes and not recommended for production use. ```bash +# MacOS (arm64) curl http://get.nocodb.com/macos-arm64 -o nocodb -L && chmod +x nocodb && ./nocodb -``` -##### Linux (x64) +# For MacOS (x64) +curl http://get.nocodb.com/macos-x64 -o nocodb -L && chmod +x nocodb && ./nocodb -```bash +# Linux (x64) curl http://get.nocodb.com/linux-x64 -o nocodb -L && chmod +x nocodb && ./nocodb -``` - -##### Linux (arm64) -```bash +# Linux (arm64) curl http://get.nocodb.com/linux-arm64 -o nocodb -L && chmod +x nocodb && ./nocodb -``` - -##### Windows (x64) -```bash +# Windows (x64) iwr http://get.nocodb.com/win-x64.exe -o Noco-win-x64.exe .\Noco-win-x64.exe -``` - -##### Windows (arm64) -```bash +# 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](https://github.com/nocodb/nocodb/tree/master/docker-compose). Here are some examples. ```bash git clone https://github.com/nocodb/nocodb -# for MySQL -cd nocodb/docker-compose/mysql -# for PostgreSQL cd nocodb/docker-compose/pg ``` -> To persist data in docker, you can mount volume at `/usr/app/data/` since 0.10.6. Otherwise your data will be lost after recreating the container. - -> If you plan to input some special characters, you may need to change the character set and collation yourself when creating the database. Please check out the examples for [MySQL Docker Compose](https://github.com/nocodb/nocodb/issues/1313#issuecomment-1046625974). - -## NPX - -You can run the below command if you need an interactive configuration. - -``` -npx create-nocodb-app -``` - - - -## 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 -``` - - # GUI Access Dashboard using: [http://localhost:8080/dashboard](http://localhost:8080/dashboard) @@ -201,8 +144,6 @@ Access Dashboard using: [http://localhost:8080/dashboard](http://localhost:8080/ # Table of Contents - [Quick try](#quick-try) - - [NPX](#npx) - - [Node Application](#node-application) - [Docker](#docker) - [Docker Compose](#docker-compose) - [GUI](#gui) diff --git a/markdown/readme/languages/chinese.md b/markdown/readme/languages/chinese.md index c7caa09ee0..011620e137 100644 --- a/markdown/readme/languages/chinese.md +++ b/markdown/readme/languages/chinese.md @@ -63,13 +63,6 @@ docker run -d --name nocodb \ -p 8080:8080 \ nocodb/nocodb:latest -# 如果使用 MySQL 的话 -docker run -d --name nocodb-mysql \ --v "$(pwd)"/nocodb:/usr/app/data/ \ --p 8080:8080 \ --e NC_DB="mysql2://host.docker.internal:3306?u=root&p=password&d=d1" \ --e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \ -nocodb/nocodb:latest # 如果使用 PostgreSQL 的话 docker run -d --name nocodb-postgres \ diff --git a/markdown/readme/languages/dutch.md b/markdown/readme/languages/dutch.md index fe230eab7e..38e6b7c219 100644 --- a/markdown/readme/languages/dutch.md +++ b/markdown/readme/languages/dutch.md @@ -142,14 +142,6 @@ NOCODB vereist een database om metadata van spreadsheets weergaven en externe da ## Docker -#### Example MySQL - -``` -docker run -d -p 8080:8080 \ - -e NC_DB="mysql2://host.docker.internal:3306?u=root&p=password&d=d1" \ - -e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \ - nocodb/nocodb:latest -``` #### Example Postgres @@ -169,7 +161,7 @@ docker run -d -p 8080:8080 \ git clone https://github.com/nocodb/nocodb cd nocodb cd docker-compose -cd mysql or pg +cd pg docker-compose up -d ``` diff --git a/markdown/readme/languages/french.md b/markdown/readme/languages/french.md index 23763f35ab..cd996967d1 100644 --- a/markdown/readme/languages/french.md +++ b/markdown/readme/languages/french.md @@ -147,13 +147,6 @@ NocoDB nécessite une base de données pour stocker les métadonnées des vues d ## Docker -#### Exemple MySQL -``` -docker run -d -p 8080:8080 \ - -e NC_DB="mysql2://host.docker.internal:3306?u=root&p=password&d=d1" \ - -e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \ - nocodb/nocodb:latest -``` #### Exemple Postgres ``` @@ -169,7 +162,7 @@ docker run -d -p 8080:8080 \ git clone https://github.com/nocodb/nocodb cd nocodb cd docker-compose -cd mysql or pg +cd pg docker-compose up -d ``` diff --git a/markdown/readme/languages/german.md b/markdown/readme/languages/german.md index 24647d66cb..a552e66888 100644 --- a/markdown/readme/languages/german.md +++ b/markdown/readme/languages/german.md @@ -151,14 +151,6 @@ NocoDB erfordert eine Datenbank, um Metadaten von Tabellenansichten und externen ## Docker -#### Beispiel MySQL / MariaDB - -``` -docker run -d -p 8080:8080 \ - -e NC_DB="mysql2://host.docker.internal:3306?u=root&p=password&d=d1" \ - -e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \ - nocodb/nocodb:latest -``` #### Beispiel PostgreSQL @@ -176,7 +168,7 @@ docker run -d -p 8080:8080 \ git clone https://github.com/nocodb/nocodb cd nocodb cd docker-compose -cd mysql or pg +cd pg docker-compose up -d ``` diff --git a/markdown/readme/languages/indonesian.md b/markdown/readme/languages/indonesian.md index ea55926202..37e15d56e4 100644 --- a/markdown/readme/languages/indonesian.md +++ b/markdown/readme/languages/indonesian.md @@ -66,13 +66,6 @@ docker run -d --name nocodb \ -p 8080:8080 \ nocodb/nocodb:latest -# for MySQL -docker run -d --name nocodb-mysql \ --v "$(pwd)"/nocodb:/usr/app/data/ \ --p 8080:8080 \ --e NC_DB="mysql2://host.docker.internal:3306?u=root&p=password&d=d1" \ --e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \ -nocodb/nocodb:latest # for PostgreSQL docker run -d --name nocodb-postgres \ diff --git a/markdown/readme/languages/italian.md b/markdown/readme/languages/italian.md index f933d0ab82..9000a5deea 100644 --- a/markdown/readme/languages/italian.md +++ b/markdown/readme/languages/italian.md @@ -146,14 +146,6 @@ NOCODB richiede un database per memorizzare i metadati delle viste dei fogli di ## Docker -#### Esempio con MySQL - -``` -docker run -d -p 8080:8080 \ - -e NC_DB="mysql2://host.docker.internal:3306?u=root&p=password&d=d1" \ - -e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \ - nocodb/nocodb:latest -``` #### Esempio con Postgres @@ -171,7 +163,7 @@ docker run -d -p 8080:8080 \ git clone https://github.com/nocodb/nocodb cd nocodb cd docker-compose -cd mysql or pg +cd pg docker-compose up -d ``` diff --git a/markdown/readme/languages/japanese.md b/markdown/readme/languages/japanese.md index 26094d4547..ea1f2613bd 100644 --- a/markdown/readme/languages/japanese.md +++ b/markdown/readme/languages/japanese.md @@ -145,14 +145,6 @@ NoCodb には、スプレッドシートビューと外部データベースの ## Docker -#### MySQLの例 - -``` -docker run -d -p 8080:8080 \ - -e NC_DB="mysql2://host.docker.internal:3306?u=root&p=password&d=d1" \ - -e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \ - nocodb/nocodb:latest -``` #### Postgresの例 @@ -170,7 +162,7 @@ docker run -d -p 8080:8080 \ git clone https://github.com/nocodb/nocodb cd nocodb cd docker-compose -cd mysql or pg +cd pg docker-compose up -d ``` diff --git a/markdown/readme/languages/korean.md b/markdown/readme/languages/korean.md index 7ecb046f86..a25a97586a 100644 --- a/markdown/readme/languages/korean.md +++ b/markdown/readme/languages/korean.md @@ -145,14 +145,6 @@ NocoDB는 스프레드시트 뷰 메타데이터와 외부 데이터베이스 ## Docker -#### MySQL 예제 - -``` -docker run -d -p 8080:8080 \ - -e NC_DB="mysql2://host.docker.internal:3306?u=root&p=password&d=d1" \ - -e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \ - nocodb/nocodb:latest -``` #### PostgreSQL 예제 @@ -170,7 +162,7 @@ docker run -d -p 8080:8080 \ git clone https://github.com/nocodb/nocodb cd nocodb cd docker-compose -cd mysql or pg +cd pg docker-compose up -d ``` diff --git a/markdown/readme/languages/portuguese.md b/markdown/readme/languages/portuguese.md index faa914ce38..8897777d0e 100644 --- a/markdown/readme/languages/portuguese.md +++ b/markdown/readme/languages/portuguese.md @@ -144,15 +144,6 @@ O NOCODB requer um banco de dados para armazenar metadados de exibições de pla ## Docker -#### Example MySQL - -``` -docker run -d -p 8080:8080 \ - -e NC_DB="mysql2://host.docker.internal:3306?u=root&p=password&d=d1" \ - -e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \ - nocodb/nocodb:latest -``` - #### Example Postgres ``` @@ -169,7 +160,7 @@ docker run -d -p 8080:8080 \ git clone https://github.com/nocodb/nocodb cd nocodb cd docker-compose -cd mysql or pg +cd pg docker-compose up -d ``` diff --git a/markdown/readme/languages/russian.md b/markdown/readme/languages/russian.md index 0362edd49d..b287a09675 100644 --- a/markdown/readme/languages/russian.md +++ b/markdown/readme/languages/russian.md @@ -146,15 +146,6 @@ NocoDB требует базу данных для хранения метада ## Docker -#### Пример MySQL - -``` -docker run -d -p 8080:8080 \ - -e NC_DB="mysql2://host.docker.internal:3306?u=root&p=password&d=d1" \ - -e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \ - nocodb/nocodb:latest -``` - #### Пример Postgres ``` @@ -171,7 +162,7 @@ docker run -d -p 8080:8080 \ git clone https://github.com/nocodb/nocodb cd nocodb cd docker-compose -cd mysql or pg +cd pg docker-compose up -d ``` diff --git a/markdown/readme/languages/spanish.md b/markdown/readme/languages/spanish.md index a80b113d6b..5eb983ecfd 100644 --- a/markdown/readme/languages/spanish.md +++ b/markdown/readme/languages/spanish.md @@ -143,14 +143,6 @@ Nocodb requiere una base de datos para almacenar metadatos de vistas a las hojas ## Docker -#### Ejemplo MySQL - -``` -docker run -d -p 8080:8080 \ - -e NC_DB="mysql2://host.docker.internal:3306?u=root&p=password&d=d1" \ - -e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \ - nocodb/nocodb:latest -``` #### Ejemplo Postgres @@ -168,7 +160,7 @@ docker run -d -p 8080:8080 \ git clone https://github.com/nocodb/nocodb cd nocodb cd docker-compose -cd mysql or pg +cd pg docker-compose up -d ``` diff --git a/markdown/readme/languages/ukrainian.md b/markdown/readme/languages/ukrainian.md index eabda7636a..88f3963cb7 100644 --- a/markdown/readme/languages/ukrainian.md +++ b/markdown/readme/languages/ukrainian.md @@ -76,13 +76,6 @@ docker run -d --name nocodb \ -p 8080:8080 \ nocodb/nocodb:latest -# для MySQL -docker run -d --name nocodb-mysql \ --v "$(pwd)"/nocodb:/usr/app/data/ \ --p 8080:8080 \ --e NC_DB="mysql2://host.docker.internal:3306?u=root&p=password&d=d1" \ --e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \ -nocodb/nocodb:latest # для PostgreSQL docker run -d --name nocodb-postgres \ 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 index 16b0d144e9..f5c67d217c 100644 --- 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 @@ -27,18 +27,7 @@ nocodb/nocodb:latest ``` - -```bash -docker run -d --name nocodb-mysql \ --v "$(pwd)"/nocodb:/usr/app/data/ \ --p 8080:8080 \ --e NC_DB="mysql2://host.docker.internal:3306?u=root&p=password&d=d1" \ --e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \ -nocodb/nocodb:latest -``` - - ```bash diff --git a/packages/noco-docs/versioned_docs/version-0.109.7/020.getting-started/010.installation.md b/packages/noco-docs/versioned_docs/version-0.109.7/020.getting-started/010.installation.md index b57ec631e2..226a233241 100644 --- a/packages/noco-docs/versioned_docs/version-0.109.7/020.getting-started/010.installation.md +++ b/packages/noco-docs/versioned_docs/version-0.109.7/020.getting-started/010.installation.md @@ -24,18 +24,6 @@ docker run -d --name nocodb \ nocodb/nocodb:latest ``` - - - -```bash -docker run -d --name nocodb-mysql \ --v "$(pwd)"/nocodb:/usr/app/data/ \ --p 8080:8080 \ --e NC_DB="mysql2://host.docker.internal:3306?u=root&p=password&d=d1" \ --e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \ -nocodb/nocodb:latest -``` - diff --git a/packages/nocodb/README.md b/packages/nocodb/README.md index f1ac4f8589..1d355a778f 100644 --- a/packages/nocodb/README.md +++ b/packages/nocodb/README.md @@ -98,13 +98,6 @@ docker run -d --name nocodb \ -p 8080:8080 \ nocodb/nocodb:latest -# for MySQL -docker run -d --name nocodb-mysql \ --v "$(pwd)"/nocodb:/usr/app/data/ \ --p 8080:8080 \ --e NC_DB="mysql2://host.docker.internal:3306?u=root&p=password&d=d1" \ --e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \ -nocodb/nocodb:latest # for PostgreSQL docker run -d --name nocodb-postgres \ diff --git a/scripts/docs/fr/020.getting-started/050.self-hosted/fr-010.installation.md b/scripts/docs/fr/020.getting-started/050.self-hosted/fr-010.installation.md index 9e91e1e622..92e1a5c0e4 100644 --- a/scripts/docs/fr/020.getting-started/050.self-hosted/fr-010.installation.md +++ b/scripts/docs/fr/020.getting-started/050.self-hosted/fr-010.installation.md @@ -29,18 +29,7 @@ nocodb/nocodb:latest ``` - -```bash -docker run -d --name nocodb-mysql \ --v "$(pwd)"/nocodb:/usr/app/data/ \ --p 8080:8080 \ --e NC_DB="mysql2://host.docker.internal:3306?u=root&p=password&d=d1" \ --e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \ -nocodb/nocodb:latest -``` - - ```bash