Browse Source

chore : simplify self-hosting - default to postgres/sqlite

pull/8782/head
Naveen MR 5 months ago
parent
commit
fdd6ab93fa
  1. 91
      README.md
  2. 7
      markdown/readme/languages/chinese.md
  3. 10
      markdown/readme/languages/dutch.md
  4. 9
      markdown/readme/languages/french.md
  5. 10
      markdown/readme/languages/german.md
  6. 7
      markdown/readme/languages/indonesian.md
  7. 10
      markdown/readme/languages/italian.md
  8. 10
      markdown/readme/languages/japanese.md
  9. 10
      markdown/readme/languages/korean.md
  10. 11
      markdown/readme/languages/portuguese.md
  11. 11
      markdown/readme/languages/russian.md
  12. 10
      markdown/readme/languages/spanish.md
  13. 7
      markdown/readme/languages/ukrainian.md
  14. 11
      packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation.md
  15. 12
      packages/noco-docs/versioned_docs/version-0.109.7/020.getting-started/010.installation.md
  16. 7
      packages/nocodb/README.md
  17. 11
      scripts/docs/fr/020.getting-started/050.self-hosted/fr-010.installation.md

91
README.md

@ -71,113 +71,56 @@ Turns any MySQL, PostgreSQL, SQL Server, SQLite & MariaDB into a smart spreadshe
## Docker ## Docker
```bash ```bash
# for SQLite # with PostgreSQL
docker run -d --name nocodb \ docker run -d --name nocodb-postgres \
-v "$(pwd)"/nocodb:/usr/app/data/ \
-p 8080:8080 \
nocodb/nocodb:latest
# for MySQL
docker run -d --name nocodb-mysql \
-v "$(pwd)"/nocodb:/usr/app/data/ \ -v "$(pwd)"/nocodb:/usr/app/data/ \
-p 8080:8080 \ -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" \ -e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \
nocodb/nocodb:latest nocodb/nocodb:latest
# for PostgreSQL # with SQLite
docker run -d --name nocodb-postgres \ docker run -d --name nocodb \
-v "$(pwd)"/nocodb:/usr/app/data/ \ -v "$(pwd)"/nocodb:/usr/app/data/ \
-p 8080:8080 \ -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 nocodb/nocodb:latest
> If `/usr/app/data/` is not mounted and containers are recreated - data will be LOST!
> 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.
## Binaries ## Binaries
- Binaries are only for quick try or testing purposes and not recommended for production use.
##### MacOS (x64)
```bash
curl http://get.nocodb.com/macos-x64 -o nocodb -L && chmod +x nocodb && ./nocodb
```
##### MacOS (arm64)
```bash ```bash
# MacOS (arm64)
curl http://get.nocodb.com/macos-arm64 -o nocodb -L && chmod +x nocodb && ./nocodb 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 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 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 iwr http://get.nocodb.com/win-x64.exe -o Noco-win-x64.exe
.\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 iwr http://get.nocodb.com/win-arm64.exe -o Noco-win-arm64.exe
.\Noco-win-arm64.exe .\Noco-win-arm64.exe
``` ```
## Docker Compose ## 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. We provide different docker-compose.yml files under [this directory](https://github.com/nocodb/nocodb/tree/master/docker-compose). Here are some examples.
```bash ```bash
git clone https://github.com/nocodb/nocodb git clone https://github.com/nocodb/nocodb
# for MySQL
cd nocodb/docker-compose/mysql
# for PostgreSQL
cd nocodb/docker-compose/pg 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
```
<img src="https://user-images.githubusercontent.com/35857179/163672964-00ef5d62-0434-447d-ac01-3ebb780099b9.png" width="520px"/>
## 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 # GUI
Access Dashboard using: [http://localhost:8080/dashboard](http://localhost:8080/dashboard) 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 # Table of Contents
- [Quick try](#quick-try) - [Quick try](#quick-try)
- [NPX](#npx)
- [Node Application](#node-application)
- [Docker](#docker) - [Docker](#docker)
- [Docker Compose](#docker-compose) - [Docker Compose](#docker-compose)
- [GUI](#gui) - [GUI](#gui)

7
markdown/readme/languages/chinese.md

@ -63,13 +63,6 @@ docker run -d --name nocodb \
-p 8080:8080 \ -p 8080:8080 \
nocodb/nocodb:latest 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 的话 # 如果使用 PostgreSQL 的话
docker run -d --name nocodb-postgres \ docker run -d --name nocodb-postgres \

10
markdown/readme/languages/dutch.md

@ -142,14 +142,6 @@ NOCODB vereist een database om metadata van spreadsheets weergaven en externe da
## Docker ## 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 #### Example Postgres
@ -169,7 +161,7 @@ docker run -d -p 8080:8080 \
git clone https://github.com/nocodb/nocodb git clone https://github.com/nocodb/nocodb
cd nocodb cd nocodb
cd docker-compose cd docker-compose
cd mysql or pg cd pg
docker-compose up -d docker-compose up -d
``` ```

9
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 ## 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 #### Exemple Postgres
``` ```
@ -169,7 +162,7 @@ docker run -d -p 8080:8080 \
git clone https://github.com/nocodb/nocodb git clone https://github.com/nocodb/nocodb
cd nocodb cd nocodb
cd docker-compose cd docker-compose
cd mysql or pg cd pg
docker-compose up -d docker-compose up -d
``` ```

10
markdown/readme/languages/german.md

@ -151,14 +151,6 @@ NocoDB erfordert eine Datenbank, um Metadaten von Tabellenansichten und externen
## Docker ## 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 #### Beispiel PostgreSQL
@ -176,7 +168,7 @@ docker run -d -p 8080:8080 \
git clone https://github.com/nocodb/nocodb git clone https://github.com/nocodb/nocodb
cd nocodb cd nocodb
cd docker-compose cd docker-compose
cd mysql or pg cd pg
docker-compose up -d docker-compose up -d
``` ```

7
markdown/readme/languages/indonesian.md

@ -66,13 +66,6 @@ docker run -d --name nocodb \
-p 8080:8080 \ -p 8080:8080 \
nocodb/nocodb:latest 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 # for PostgreSQL
docker run -d --name nocodb-postgres \ docker run -d --name nocodb-postgres \

10
markdown/readme/languages/italian.md

@ -146,14 +146,6 @@ NOCODB richiede un database per memorizzare i metadati delle viste dei fogli di
## Docker ## 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 #### Esempio con Postgres
@ -171,7 +163,7 @@ docker run -d -p 8080:8080 \
git clone https://github.com/nocodb/nocodb git clone https://github.com/nocodb/nocodb
cd nocodb cd nocodb
cd docker-compose cd docker-compose
cd mysql or pg cd pg
docker-compose up -d docker-compose up -d
``` ```

10
markdown/readme/languages/japanese.md

@ -145,14 +145,6 @@ NoCodb には、スプレッドシートビューと外部データベースの
## Docker ## 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の例 #### Postgresの例
@ -170,7 +162,7 @@ docker run -d -p 8080:8080 \
git clone https://github.com/nocodb/nocodb git clone https://github.com/nocodb/nocodb
cd nocodb cd nocodb
cd docker-compose cd docker-compose
cd mysql or pg cd pg
docker-compose up -d docker-compose up -d
``` ```

10
markdown/readme/languages/korean.md

@ -145,14 +145,6 @@ NocoDB는 스프레드시트 뷰 메타데이터와 외부 데이터베이스
## Docker ## 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 예제 #### PostgreSQL 예제
@ -170,7 +162,7 @@ docker run -d -p 8080:8080 \
git clone https://github.com/nocodb/nocodb git clone https://github.com/nocodb/nocodb
cd nocodb cd nocodb
cd docker-compose cd docker-compose
cd mysql or pg cd pg
docker-compose up -d docker-compose up -d
``` ```

11
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 ## 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 #### Example Postgres
``` ```
@ -169,7 +160,7 @@ docker run -d -p 8080:8080 \
git clone https://github.com/nocodb/nocodb git clone https://github.com/nocodb/nocodb
cd nocodb cd nocodb
cd docker-compose cd docker-compose
cd mysql or pg cd pg
docker-compose up -d docker-compose up -d
``` ```

11
markdown/readme/languages/russian.md

@ -146,15 +146,6 @@ NocoDB требует базу данных для хранения метада
## Docker ## 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 #### Пример Postgres
``` ```
@ -171,7 +162,7 @@ docker run -d -p 8080:8080 \
git clone https://github.com/nocodb/nocodb git clone https://github.com/nocodb/nocodb
cd nocodb cd nocodb
cd docker-compose cd docker-compose
cd mysql or pg cd pg
docker-compose up -d docker-compose up -d
``` ```

10
markdown/readme/languages/spanish.md

@ -143,14 +143,6 @@ Nocodb requiere una base de datos para almacenar metadatos de vistas a las hojas
## Docker ## 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 #### Ejemplo Postgres
@ -168,7 +160,7 @@ docker run -d -p 8080:8080 \
git clone https://github.com/nocodb/nocodb git clone https://github.com/nocodb/nocodb
cd nocodb cd nocodb
cd docker-compose cd docker-compose
cd mysql or pg cd pg
docker-compose up -d docker-compose up -d
``` ```

7
markdown/readme/languages/ukrainian.md

@ -76,13 +76,6 @@ docker run -d --name nocodb \
-p 8080:8080 \ -p 8080:8080 \
nocodb/nocodb:latest 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 # для PostgreSQL
docker run -d --name nocodb-postgres \ docker run -d --name nocodb-postgres \

11
packages/noco-docs/docs/020.getting-started/050.self-hosted/010.installation.md

@ -27,18 +27,7 @@ nocodb/nocodb:latest
``` ```
</TabItem> </TabItem>
<TabItem value="mysql" label="MySQL">
```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
```
</TabItem>
<TabItem value="postgres" label="Postgres"> <TabItem value="postgres" label="Postgres">
```bash ```bash

12
packages/noco-docs/versioned_docs/version-0.109.7/020.getting-started/010.installation.md vendored

@ -24,18 +24,6 @@ docker run -d --name nocodb \
nocodb/nocodb:latest nocodb/nocodb:latest
``` ```
</TabItem>
<TabItem value="mysql" label="MySQL">
```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
```
</TabItem> </TabItem>
<TabItem value="postgres" label="Postgres"> <TabItem value="postgres" label="Postgres">

7
packages/nocodb/README.md

@ -98,13 +98,6 @@ docker run -d --name nocodb \
-p 8080:8080 \ -p 8080:8080 \
nocodb/nocodb:latest 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 # for PostgreSQL
docker run -d --name nocodb-postgres \ docker run -d --name nocodb-postgres \

11
scripts/docs/fr/020.getting-started/050.self-hosted/fr-010.installation.md

@ -29,18 +29,7 @@ nocodb/nocodb:latest
``` ```
</TabItem> </TabItem>
<TabItem value="mysql" label="MySQL">
```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
```
</TabItem>
<TabItem value="postgres" label="Postgres"> <TabItem value="postgres" label="Postgres">
```bash ```bash

Loading…
Cancel
Save