Skip to content

Commit

Permalink
[docs] renamed deployment directory to Setup (ToolJet#2847)
Browse files Browse the repository at this point in the history
  • Loading branch information
withshubh authored Apr 19, 2022
1 parent fe3895c commit eb2b275
Show file tree
Hide file tree
Showing 24 changed files with 31 additions and 31 deletions.
2 changes: 1 addition & 1 deletion .env.example
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Create .env from this example file and replace values for the environment.
# The application expects a separate .env.test for test environment configuration
# Get detailed information about each variable here: https://docs.tooljet.com/docs/deployment/env-vars
# Get detailed information about each variable here: https://docs.tooljet.com/docs/setup/env-vars

TOOLJET_HOST=http://localhost:8082
LOCKBOX_MASTER_KEY=0000000000000000000000000000000000000000000000000000000000000000
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ ToolJet is an **open-source low-code framework** to build and deploy internal to
<hr>

## Quickstart
The easiest way to get started with ToolJet is by creating a [ToolJet Cloud](https://tooljet.com) account. ToolJet Cloud offers a hosted solution of ToolJet. If you want to self-host ToolJet, kindly proceed to [deployment documentation](https://docs.tooljet.com/docs/deployment/architecture).
The easiest way to get started with ToolJet is by creating a [ToolJet Cloud](https://tooljet.com) account. ToolJet Cloud offers a hosted solution of ToolJet. If you want to self-host ToolJet, kindly proceed to [deployment documentation](https://docs.tooljet.com/docs/setup/architecture).

You can deploy ToolJet on Heroku for free using the one-click-deployment button below.
<p align="center">
Expand All @@ -92,13 +92,13 @@ You can use ToolJet cloud for a fully managed solution. If you want to self-host

| Provider | Documentation |
| ------------- | ------------- |
| AWS EC2 | [Link](https://docs.tooljet.com/docs/deployment/ec2) |
| AWS EKS (Kubernetes) | [Link](https://docs.tooljet.com/docs/deployment/kubernetes) |
| GCP GKE (Kubernetes) | [Link](https://docs.tooljet.com/docs/deployment/kubernetes-gke) |
| Azure AKS (Kubernetes) | [Link](https://docs.tooljet.com/docs/deployment/kubernetes-aks) |
| Heroku | [Link](https://docs.tooljet.com/docs/deployment/heroku) |
| Docker | [Link](https://docs.tooljet.com/docs/deployment/docker) |
| Google Cloud Run | [Link](https://docs.tooljet.com/docs/deployment/google-cloud-run) |
| AWS EC2 | [Link](https://docs.tooljet.com/docs/setup/ec2) |
| AWS EKS (Kubernetes) | [Link](https://docs.tooljet.com/docs/setup/kubernetes) |
| GCP GKE (Kubernetes) | [Link](https://docs.tooljet.com/docs/setup/kubernetes-gke) |
| Azure AKS (Kubernetes) | [Link](https://docs.tooljet.com/docs/setup/kubernetes-aks) |
| Heroku | [Link](https://docs.tooljet.com/docs/setup/heroku) |
| Docker | [Link](https://docs.tooljet.com/docs/setup/docker) |
| Google Cloud Run | [Link](https://docs.tooljet.com/docs/setup/google-cloud-run) |

## Community support
For general help using ToolJet, please refer to the official [documentation](https://docs.tooljet.com/docs/intro/). For additional help, you can use one of these channels to ask a question:
Expand Down
2 changes: 1 addition & 1 deletion deploy/docker/.env.example
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Create .env from this example file and replace values for the environment.
# The application expects a separate .env.test for test environment configuration
# Get detailed information about each variable here: https://docs.tooljet.com/docs/deployment/env-vars
# Get detailed information about each variable here: https://docs.tooljet.com/docs/setup/env-vars

TOOLJET_HOST=http://localhost:8082
LOCKBOX_MASTER_KEY=replace_with_lockbox_master_key
Expand Down
2 changes: 1 addition & 1 deletion deploy/ec2/.env
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# https://docs.tooljet.io/docs/deployment/env-vars
# https://docs.tooljet.io/docs/setup/env-vars
TOOLJET_HOST=__required__
LOCKBOX_MASTER_KEY=__required__
SECRET_KEY_BASE=__required__
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/contributing-guide/setup/Mac OS.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ sidebar_position: 1
---

# Mac OS
Follow these steps to setup and run ToolJet on macOS for development purposes. Open terminal and run the commands below. We recommend reading our guide on [architecture](/docs/deployment/architecture) of ToolJet before proceeding.
Follow these steps to setup and run ToolJet on macOS for development purposes. Open terminal and run the commands below. We recommend reading our guide on [architecture](/docs/setup/architecture) of ToolJet before proceeding.

## Setting up

Expand Down Expand Up @@ -39,7 +39,7 @@ Follow these steps to setup and run ToolJet on macOS for development purposes. O

2. Set up environment variables

Create a `.env` file by copying `.env.example`. More information on the variables that can be set is given in the [environment variables reference](/docs/deployment/env-vars)
Create a `.env` file by copying `.env.example`. More information on the variables that can be set is given in the [environment variables reference](/docs/setup/env-vars)
```bash
cp .env.example .env
```
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/contributing-guide/setup/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Please find more information [here](https://docs.docker.com/desktop/windows/wsl/
git clone https://github.com/tooljet/tooljet.git
```

2. Create a `.env` file by copying `.env.example`. More information on the variables that can be set is given in the [environment variables reference](/docs/deployment/env-vars)
2. Create a `.env` file by copying `.env.example`. More information on the variables that can be set is given in the [environment variables reference](/docs/setup/env-vars)
```bash
cp .env.example .env
cp .env.example .env.test
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/contributing-guide/setup/ubuntu.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Follow these steps to setup and run ToolJet on Ubuntu. Open terminal and run the

2. Set up environment variables

Create a `.env` file by copying `.env.example`. More information on the variables that can be set is given in the [environment variables reference](/docs/deployment/env-vars)
Create a `.env` file by copying `.env.example`. More information on the variables that can be set is given in the [environment variables reference](/docs/setup/env-vars)
```bash
cp .env.example .env
```
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/data-sources/google.sheets.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ ToolJet can connect to Google Sheet using OAuth 2.0, which helps us to limit an

If you are self-hosting the application, you will need to perform some additional steps.

1. Follow the [Google OAuth 2.0 setup steps outlined here](/docs/deployment/env-vars#google-oauth--optional-)
1. Follow the [Google OAuth 2.0 setup steps outlined here](/docs/setup/env-vars#google-oauth--optional-)
2. Set the following environment variables with the values from the previous step:
* `GOOGLE_CLIENT_ID`
* `GOOGLE_CLIENT_SECRET`
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ ToolJet binds together the data sources, queries and widgets to convert business

These resources will help you to quickly build and deploy apps using ToolJet:

- **[Setup](/docs/deployment/architecture)** - Learn how to setup ToolJet locally using docker.
- **[Setup](/docs/setup/architecture)** - Learn how to setup ToolJet locally using docker.
- **[Basic Tutorial](/docs/tutorial/creating-app)** - Learn how to build simple UI and connect to data sources.
- **[Deploy](/docs/contributing-guide/setup/docker)** - Learn how to deploy ToolJet on Heroku, Kubernetes, etc

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "Deployment",
"label": "Setup",
"position": 4,
"collapsed": true
}
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ curl -LO https://raw.githubusercontent.com/ToolJet/ToolJet/main/deploy/docker/.e
mv .env.example .env
```

Set up environment variables in `.env` file as explained in [environment variables reference](/docs/deployment/env-vars)
Set up environment variables in `.env` file as explained in [environment variables reference](/docs/setup/env-vars)

`TOOLJET_HOST` environment variable can either be the public ipv4 address of your server or a custom domain that you want to use.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/deployment/ec2.md → docs/docs/setup/ec2.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Follow the steps below to deploy ToolJet on AWS EC2 instances.
PG_HOST=<pg host>
PG_PASS=<pg user password>
```
Read **[environment variables reference](/docs/deployment/env-vars)**
Read **[environment variables reference](/docs/setup/env-vars)**

:::info
If there are self signed HTTPS endpoints that Tooljet needs to connect to, please make sure that `NODE_EXTRA_CA_CERTS` environment variable is set to the absolute path containing the certificates.
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ If you are to use [Public IP](https://cloud.google.com/sql/docs/mysql/connect-ru

3. Create default user (Optional)

Signing up requires [SMTP configuration](https://docs.tooljet.com/docs/deployment/env-vars#smtp-configuration--optional-) to be done, but if you want to start off with default user you can run the command by modifying the `args` flag for a one time usage.
Signing up requires [SMTP configuration](https://docs.tooljet.com/docs/setup/env-vars#smtp-configuration--optional-) to be done, but if you want to start off with default user you can run the command by modifying the `args` flag for a one time usage.

```bash
gcloud run deploy <replace-service-name> \
Expand Down Expand Up @@ -125,7 +125,7 @@ If you are to use [Public IP](https://cloud.google.com/sql/docs/mysql/connect-ru

3. Create default user **(Optional)**

Signing up requires [SMTP configuration](https://docs.tooljet.com/docs/deployment/env-vars#smtp-configuration--optional-) to be done, but if you want to start off with default user you can run the command by modifying the `args` flag for a one time usage.
Signing up requires [SMTP configuration](https://docs.tooljet.com/docs/setup/env-vars#smtp-configuration--optional-) to be done, but if you want to start off with default user you can run the command by modifying the `args` flag for a one time usage.

```bash
gcloud run deploy <replace-service-name> \
Expand Down
10 changes: 5 additions & 5 deletions docs/docs/deployment/heroku.md → docs/docs/setup/heroku.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ sidebar_label: Heroku

<div style={{textAlign: 'center'}}>

![ToolJet - Deployment- Heroku](/img/deployment/heroku/appname.png)
![ToolJet - Deployment- Heroku](/img/setup/heroku/appname.png)

</div>

3. Now let's enter the `Config vars` to configure additional [environment variables](/docs/deployment/env-vars) that are required for the installation.
3. Now let's enter the `Config vars` to configure additional [environment variables](/docs/setup/env-vars) that are required for the installation.
- **LOCKBOX_MASTER_KEY**: ToolJet server uses lockbox to encrypt datasource credentials. You should set the environment variable LOCKBOX_MASTER_KEY with a 32 byte hexadecimal string. If you have OpenSSL installed, you can run the command `openssl rand -hex 32` to generate the key.
- **NODE_ENV**: By default NODE_ENV is set to production.
- **NODE_OPTIONS**: Node options are configured to increase node memory to support app build.
Expand All @@ -39,15 +39,15 @@ sidebar_label: Heroku

<div style={{textAlign: 'center'}}>

![ToolJet - Deployment- Heroku](/img/deployment/heroku/build.png)
![ToolJet - Deployment- Heroku](/img/setup/heroku/build.png)

</div>

6. The default username of the admin is `dev@tooljet.io` and the password is `password`.

<div style={{textAlign: 'center'}}>

![ToolJet - Deployment- Heroku](/img/deployment/heroku/login.png)
![ToolJet - Deployment- Heroku](/img/setup/heroku/login.png)

</div>

Expand All @@ -56,5 +56,5 @@ The one click deployment will create a **free dyno** and a **free postgresql dat
:::

:::tip
ToolJet server and client can be deployed as standalone applications. If you do not want to deploy the client on Heroku, modify `package.json` accordingly. We have a [guide](/docs/deployment/client) on deploying ToolJet client using services such as Firebase.
ToolJet server and client can be deployed as standalone applications. If you do not want to deploy the client on Heroku, modify `package.json` accordingly. We have a [guide](/docs/setup/client) on deploying ToolJet client using services such as Firebase.
:::
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Follow the steps below to deploy ToolJet on a AKS Kubernetes cluster.
curl -LO https://raw.githubusercontent.com/ToolJet/ToolJet/main/deploy/kubernetes/AKS/deployment.yaml
```

Make sure to edit the environment variables in the `deployment.yaml`. We advise to use secrets to setup sensitive information. You can check out the available options [here](https://docs.tooljet.com/docs/deployment/env-vars).
Make sure to edit the environment variables in the `deployment.yaml`. We advise to use secrets to setup sensitive information. You can check out the available options [here](https://docs.tooljet.com/docs/setup/env-vars).

:::info
If there are self signed HTTPS endpoints that Tooljet needs to connect to, please make sure that `NODE_EXTRA_CA_CERTS` environment variable is set to the absolute path containing the certificates. You can make use of kubernetes secrets to mount the certificate file onto the containers.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ gcloud compute addresses create tj-static-ip --global
curl -LO https://raw.githubusercontent.com/ToolJet/ToolJet/main/deploy/kubernetes/GKE/deployment.yaml
```

Make sure to edit the environment variables in the `deployment.yaml`. You can check out the available options [here](https://docs.tooljet.com/docs/deployment/env-vars).
Make sure to edit the environment variables in the `deployment.yaml`. You can check out the available options [here](https://docs.tooljet.com/docs/setup/env-vars).

:::info
If there are self signed HTTPS endpoints that Tooljet needs to connect to, please make sure that `NODE_EXTRA_CA_CERTS` environment variable is set to the absolute path containing the certificates. You can make use of kubernetes secrets to mount the certificate file onto the containers.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Follow the steps below to deploy ToolJet on a Kubernetes cluster.

2. Create a Kubernetes secret with name `server`. For the minimal setup, ToolJet requires `pg_host`, `pg_db`, `pg_user`, `pg_password`, `secret_key_base` & `lockbox_key` keys in the secret.

Read **[environment variables reference](/docs/deployment/env-vars)**
Read **[environment variables reference](/docs/setup/env-vars)**

3. Create a Kubernetes deployment

Expand Down Expand Up @@ -45,5 +45,5 @@ If there are self signed HTTPS endpoints that Tooljet needs to connect to, pleas
- [GKE Ingress for HTTP(S) Load Balancing](https://cloud.google.com/kubernetes-engine/docs/concepts/ingress)

:::tip
If you want to serve ToolJet client from services such as Firebase or Netlify, please read the client deployment documentation **[here](/docs/deployment/client)**.
If you want to serve ToolJet client from services such as Firebase or Netlify, please read the client Setup documentation **[here](/docs/setup/client)**.
:::
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes

0 comments on commit eb2b275

Please sign in to comment.