diff --git a/packages/noco-docs/content/en/getting-started/installation.md b/packages/noco-docs/content/en/getting-started/installation.md index 7e859a35a6..2e75b8574a 100644 --- a/packages/noco-docs/content/en/getting-started/installation.md +++ b/packages/noco-docs/content/en/getting-started/installation.md @@ -10,12 +10,11 @@ link: https://codesandbox.io/embed/vigorous-firefly-80kq5?hidenavigation=1&theme Simple installation - takes about three minutes! ## Prerequisites -- Must haves - - [Node.js with version >= 14](https://nodejs.org/en/download) / [Docker](https://www.docker.com/get-started) +- [Docker](https://www.docker.com/get-started) or [Node.js](https://nodejs.org/en/download) ( > v14.x ) ## Quick try -### 1-Click Deploy to Heroku +### Heroku Before doing so, make sure you have a Heroku account. By default, an add-on Heroku Postgres will be used as meta database. You can see the connection string defined in `DATABASE_URL` by navigating to Heroku App Settings and selecting Config Vars. @@ -27,88 +26,7 @@ Before doing so, make sure you have a Heroku account. By default, an add-on Hero /> -### NPX - -You can run below command if you need an interactive configuration. - -```bash -npx create-nocodb-app -``` - -#### Preview: - -image - - -### 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 -``` - -### Homebrew - -```bash -brew tap nocodb/nocodb -brew install nocodb -nocodb -``` - -### Executables - -You can download executables directly and run without any extra dependancy. Use the right command based on your platform. - - -##### MacOS (x64) - -```bash -curl http://get.nocodb.com/macos-x64 -o nocodb -L \ - && chmod +x nocodb \ - && ./nocodb -``` - -##### MacOS (arm64) - -```bash -curl http://get.nocodb.com/macos-arm64 -o nocodb -L \ - && chmod +x nocodb \ - && ./nocodb -``` - -##### Linux (x64) - -```bash -curl http://get.nocodb.com/linux-x64 -o nocodb -L \ - && chmod +x nocodb \ - && ./nocodb -``` -##### Linux (arm64) - -```bash -curl http://get.nocodb.com/linux-arm64 -o nocodb -L \ - && chmod +x nocodb \ - && ./nocodb -``` - -##### Windows (x64) - -```bash -iwr http://get.nocodb.com/win-x64.exe -.\Noco-win-x64.exe -``` -##### Windows (arm64) - -```bash -iwr http://get.nocodb.com/win-arm64.exe -.\Noco-win-arm64.exe -``` - -### Docker +### Docker If you are a Docker user, you may try this way! @@ -121,7 +39,7 @@ If you are a Docker user, you may try this way! -p 8080:8080 \ nocodb/nocodb:latest ``` - + @@ -134,7 +52,7 @@ If you are a Docker user, you may try this way! -e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \ nocodb/nocodb:latest ``` - + @@ -178,7 +96,7 @@ We provide different docker-compose.yml files under - + ```bash git clone https://github.com/nocodb/nocodb cd nocodb/docker-compose/mysql @@ -196,7 +114,7 @@ We provide different docker-compose.yml files under ```bash @@ -216,6 +134,91 @@ Tip 1: To persist data in docker you can mount volume at `/usr/app/data/` since Tip 2: 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. + +### NPX + +You can run below command if you need an interactive configuration. + +```bash +npx create-nocodb-app +``` + +#### Preview: + +image + + + +### Homebrew + +```bash +brew tap nocodb/nocodb +brew install nocodb +nocodb +``` + +### Executables + +You can download executables directly and run without any extra dependancy. Use the right command based on your platform. + + +##### MacOS (x64) + +```bash +curl http://get.nocodb.com/macos-x64 -o nocodb -L \ + && chmod +x nocodb \ + && ./nocodb +``` + +##### MacOS (arm64) + +```bash +curl http://get.nocodb.com/macos-arm64 -o nocodb -L \ + && chmod +x nocodb \ + && ./nocodb +``` + +##### Linux (x64) + +```bash +curl http://get.nocodb.com/linux-x64 -o nocodb -L \ + && chmod +x nocodb \ + && ./nocodb +``` +##### Linux (arm64) + +```bash +curl http://get.nocodb.com/linux-arm64 -o nocodb -L \ + && chmod +x nocodb \ + && ./nocodb +``` + +##### Windows (x64) + +```bash +iwr http://get.nocodb.com/win-x64.exe +.\Noco-win-x64.exe +``` +##### Windows (arm64) + +```bash +iwr http://get.nocodb.com/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 +``` + + + ## Production Setup It is mandatory to configure `NC_DB` environment variables for production usecases. @@ -361,9 +364,6 @@ aws ecs create-service \ 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. -## Development Setup -Please refer to [Development Setup](https://docs-dev.nocodb.com/engineering/development-setup). - ## Sample Demos ### Code Sandbox