From dc0f8583dbe12bc9fac24d428d898a6c3a80477f Mon Sep 17 00:00:00 2001 From: Nikhila Jain <99252011+jnikhila@users.noreply.github.com> Date: Mon, 13 Nov 2023 12:16:31 +0530 Subject: [PATCH] chore: add section (#1869) for all installation guides ## Checklist I have: - [ ] run the content through Grammarly - [ ] linked to sample apps when relevant - [ ] added the meta description for each page in the PR - [ ] minimized the callouts and added only when necessary - [ ] added the `queryString` parameter to the Tabs (if used) - [ ] masked PII in images. For example, login credentials, account details, and more - [ ] added images only when necessary - [ ] deleted the images that are no longer used for the updated pages in the PR - [ ] followed the image file naming convention while renaming or adding new images. (Use lowercase letters, dashes between words, and be as descriptive as possible) - [ ] used the `
` tag instead of a markdown representation for images - [ ] added the `
` tag to add a caption to the image - [ ] added the `alt` attribute in the `` tag - [ ] verified and updated the cross-references or created redirect rules for the changed or removed content - [ ] reviewed and applied the style changes for UI formatting. For example, Bold the UI elements(Buttons on screen) used in the doc. --- .../getting-started/setup/installation-guides/aws-ami.md | 4 ++++ .../setup/installation-guides/aws-ecs-on-fargate.md | 4 ++++ .../getting-started/setup/installation-guides/aws-ecs.md | 4 ++++ .../setup/installation-guides/azure-aci.md | 4 ++++ .../setup/installation-guides/docker/README.mdx | 4 ++++ .../setup/installation-guides/google-cloud-run.mdx | 6 +++++- .../setup/installation-guides/kubernetes/README.mdx | 8 ++++++++ 7 files changed, 33 insertions(+), 1 deletion(-) diff --git a/website/docs/getting-started/setup/installation-guides/aws-ami.md b/website/docs/getting-started/setup/installation-guides/aws-ami.md index 89a69ffe55..47991eaf33 100644 --- a/website/docs/getting-started/setup/installation-guides/aws-ami.md +++ b/website/docs/getting-started/setup/installation-guides/aws-ami.md @@ -92,6 +92,10 @@ Follow these steps to install Appsmith using an Amazon Machine Image (AMI): 3. Once you've created an account, you can either start with the free plan or activate your instance with a license key. If you want to generate a license key, sign up on [customer.appsmith.com](https://customer.appsmith.com) to create one, and then proceed to activate your instance using the newly generated license key. +## Install Appsmith Community + + To install the open source edition of Appsmith (Appsmith Community), choose the [Appsmith Community Edition](https://aws.amazon.com/marketplace/pp/prodview-mclslaty46ah4) in the [image selection](#select-appsmith-image) step, and then follow the instructions provided on this page. + ## Troubleshooting Some common errors that you may face during installation: diff --git a/website/docs/getting-started/setup/installation-guides/aws-ecs-on-fargate.md b/website/docs/getting-started/setup/installation-guides/aws-ecs-on-fargate.md index 3e92c33ecb..17f91a4a90 100644 --- a/website/docs/getting-started/setup/installation-guides/aws-ecs-on-fargate.md +++ b/website/docs/getting-started/setup/installation-guides/aws-ecs-on-fargate.md @@ -189,6 +189,10 @@ The `exec` command will be available once the new deployment is active. ``` 3. Once you can access the bash shell, you can execute all commands available in the Appsmith container, like [appsmithctl](/getting-started/setup/instance-management/appsmithctl). +## Install Appsmith Community + +To install the Appsmith open source edition (Appsmith Community), replace `appsmith-ee` with `appsmith-ce` in the [container definition](#container-definition-ecs) on this page. + ## Troubleshooting Some common errors that you may face during installation: diff --git a/website/docs/getting-started/setup/installation-guides/aws-ecs.md b/website/docs/getting-started/setup/installation-guides/aws-ecs.md index 2bec6b7d79..1a0c8bb317 100644 --- a/website/docs/getting-started/setup/installation-guides/aws-ecs.md +++ b/website/docs/getting-started/setup/installation-guides/aws-ecs.md @@ -166,6 +166,10 @@ To deploy Appsmith on the Amazon ECS cluster that has a single node, you need to 10. Once you've created an account, you can either start with the free plan or activate your instance with a license key. If you want to generate a license key, sign up on [customer.appsmith.com](https://customer.appsmith.com) to create one, and then proceed to activate your instance using the newly generated license key. +## Install Appsmith Community + +To install the Appsmith open source edition (Appsmith Community), replace `appsmith-ee` with `appsmith-ce` in the [container definition](#container-definition-ecs) on this page. + ## Troubleshooting Some common errors that you may face during installation: diff --git a/website/docs/getting-started/setup/installation-guides/azure-aci.md b/website/docs/getting-started/setup/installation-guides/azure-aci.md index 0417633a90..40980666cb 100644 --- a/website/docs/getting-started/setup/installation-guides/azure-aci.md +++ b/website/docs/getting-started/setup/installation-guides/azure-aci.md @@ -71,6 +71,10 @@ az storage share create --name $fileShareName --account-name $storageAccountName --azure-file-volume-share-name $fileShareName \ --azure-file-volume-mount-path "/appsmith-stacks/" \ ``` + +## Install Appsmith Community + +To install the Appsmith open source edition (Appsmith Community), replace `appsmith-ee` with `appsmith-ce` while creating an [Azure container instance](#container-instance-config) file on this page. ## Troubleshooting If you face issues, contact the support team using the chat widget at the bottom right of this page. diff --git a/website/docs/getting-started/setup/installation-guides/docker/README.mdx b/website/docs/getting-started/setup/installation-guides/docker/README.mdx index 46c64844c0..35eed7f2c3 100644 --- a/website/docs/getting-started/setup/installation-guides/docker/README.mdx +++ b/website/docs/getting-started/setup/installation-guides/docker/README.mdx @@ -43,6 +43,10 @@ This command will download the necessary Docker image if it doesn't exist locall 6. Once you've created an account, you can either start with the free plan or activate your instance with a license key. If you want to generate a license key, sign up on [customer.appsmith.com](https://customer.appsmith.com) to create one, and then proceed to activate your instance using the newly generated license key. +## Install Appsmith Community + +To install the Appsmith open source edition (Appsmith Community), replace `appsmith-ee` with `appsmith-ce` in the [docker-compose.yml](#docker-compose-file) file on this page. + ## Troubleshooting Some common errors that you may face during installation: diff --git a/website/docs/getting-started/setup/installation-guides/google-cloud-run.mdx b/website/docs/getting-started/setup/installation-guides/google-cloud-run.mdx index f0525c0a67..8d70d36731 100644 --- a/website/docs/getting-started/setup/installation-guides/google-cloud-run.mdx +++ b/website/docs/getting-started/setup/installation-guides/google-cloud-run.mdx @@ -106,7 +106,11 @@ Follow these steps to install Appsmith on Google Cloud Run: 12. Click the displayed URL link to open the unique and stable endpoint of the Appsmith instance. 13. Fill in your details to create an administrator account. 14. Once you've created an account, you can either start with the free plan or activate your instance with a license key. If you want to generate a license key, sign up on [customer.appsmith.com](https://customer.appsmith.com) to create one, and then proceed to activate your instance using the newly generated license key. - + +## Install Appsmith Community + +To install the Appsmith open source edition (Appsmith Community), replace `appsmith-ee` with `appsmith-ce` while [creating a service](#create-service) on this page. + ## Troubleshooting If you face issues, contact the support team using the chat widget at the bottom right of this page. diff --git a/website/docs/getting-started/setup/installation-guides/kubernetes/README.mdx b/website/docs/getting-started/setup/installation-guides/kubernetes/README.mdx index 60c7df8359..02e9653314 100644 --- a/website/docs/getting-started/setup/installation-guides/kubernetes/README.mdx +++ b/website/docs/getting-started/setup/installation-guides/kubernetes/README.mdx @@ -132,6 +132,14 @@ Follow these steps to install Appsmith: For high availability and scalability configuration, see the [Configure High Availability and Scalability](/getting-started/setup/installation-guides/kubernetes/configure-high-availability) guide. To expose Appsmith installation on the internet, see the [Expose K8s to Internet](/getting-started/setup/installation-guides/kubernetes/publish-appsmith-online) guide. +## Install Appsmith Community +To install the Appsmith open source edition (Appsmith Community): +1. Use the open source helm chart by running the below command which adds the Appsmith chart repository: + ```bash + helm repo add appsmith https://helm.appsmith.com + ``` +2. Replace `appsmith-ee` with `appsmith` in the commands on this page. + ## Troubleshooting If you face issues, contact the support team using the chat widget at the bottom right of this page.