Skip to content

Commit

Permalink
cross-reference updates
Browse files Browse the repository at this point in the history
  • Loading branch information
jnikhila committed Dec 27, 2024
1 parent 1744d60 commit 2c4bf2e
Show file tree
Hide file tree
Showing 8 changed files with 15 additions and 15 deletions.
8 changes: 4 additions & 4 deletions website/docs/getting-started/setup/best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ This page provides information on the best practices that are to be followed whe
## Deployment setup

- Setup a separate instance for Production & Staging. You may also choose to have one for development.
- Enable [scheduled backups](/getting-started/setup/instance-management/appsmithctl#schedule-automatic-backups) to run nightly on all your instances.
- Have your backups [synced to S3](/getting-started/setup/instance-management/appsmithctl#sync-backup-to-s3-bucket).
- Enable [scheduled backups](/getting-started/setup/environment-variables#automatic-backups) to run nightly on all your instances.
- Have your backups [synced to S3](/getting-started/setup/instance-management/backup-and-restore/sync-backup-to-s3).
- Add a monitoring integration like BetterUptime or UptimeRobot to monitor the uptime of your production Appsmith instance.
- Always ensure you have an NFS persistent volume of 3GB. On AWS, EFS is what we recommend.
- If using ECS, enable CloudWatch logging, so that you can easily retrieve your Appsmith logs.
Expand All @@ -34,10 +34,10 @@ This page provides information on the best practices that are to be followed whe

## Upgrading

- Take a backup of your Appsmith Development, Staging & Production instances. [Backup](/getting-started/setup/instance-management/appsmithctl#backup-instance).
- Take a backup of your Appsmith Development, Staging & Production instances. [Backup](/getting-started/setup/instance-management/backup-and-restore/backup-instance).
- Always perform a manual upgrade of your Staging / Development instance first before you attempt it on the production instance.
- Check if you need to [Upgrade to Checkpoint Version (v1.9.2)](/getting-started/setup/instance-management/upgrade-to-checkpoint-version).
- Verify that all your applications are working on the Staging & Development instances in both the edit & view modes.
- Perform the upgrade on the Production instance after taking a backup.
- Verify that all your applications are working on the production instance in both edit and view modes.
- If you notice any degradation in your experience after the upgrade, [restore the backup](/getting-started/setup/instance-management/appsmithctl#restore-instance) and reach out to our support via the chat widget on this page.
- If you notice any degradation in your experience after the upgrade, [restore the backup](/getting-started/setup/instance-management/backup-and-restore/restore-instance) and reach out to our support via the chat widget on this page.
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Follow the below steps to migrate data:
```bash
appsmithctl restore
```
For more information, see [Restore Appsmith](/getting-started/setup/instance-management/appsmithctl#restore-instance).
For more information, see [Restore Appsmith](/getting-started/setup/instance-management/backup-and-restore/restore-instance).
6. Verify the Appsmith service by logging into your Appsmith account and verifying your apps.

## Remove Bind mount storage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Before setting up high availability for Appsmith, ensure you have completed the

4. Appsmith requires AWS EFS to provide persistent storage of application data. If your current setup uses a local volume or bind mount, upgrade to EFS before proceeding. See the [Upgrade to AWS EFS guide](/getting-started/setup/installation-guides/aws-ecs/migrate-bind-mount-to-efs) for details.

5. Create a backup of your existing Appsmith instance to safeguard your data before proceeding. For detailed instructions, see [How to back up your Appsmith instance](/getting-started/setup/instance-management/appsmithctl#backup-instance).
5. Create a backup of your existing Appsmith instance to safeguard your data before proceeding. For detailed instructions, see [How to back up your Appsmith instance](/getting-started/setup/instance-management/backup-and-restore/backup-instance).

6. Ensure you can run `supervisorctl` commands to manage Keycloak data backup and recovery.

Expand All @@ -46,7 +46,7 @@ High availability for Appsmith requires configuring external databases for **Mon

Appsmith requires MongoDB to store application data. To use an external MongoDB instance with Appsmith, follow the steps below to back up your data, configure the new MongoDB instance, and restore your Appsmith data if needed.

1. Take a backup of your existing MongoDB instance before proceeding. For more information, see [How to take back up of MongoDB data](/getting-started/setup/instance-management/appsmithctl#backup-database) guide.
1. Take a backup of your existing MongoDB instance before proceeding. For more information, see [How to take back up of MongoDB data](/getting-started/setup/instance-management/backup-and-restore/backup-database) guide.

2. If you don't already have a MongoDB instance, create a new one. You can either use an existing instance or set up a new one through your infrastructure or a cloud provider like MongoDB Atlas.

Expand All @@ -56,7 +56,7 @@ Appsmith requires MongoDB to store application data. To use an external MongoDB
```
4. Assign or verify that the MongoDB user account Appsmith uses has `readWrite` and `clusterMonitor` roles assigned.

5. Restore your Appsmith backup you took earlier to the new MongoDB instance. For more information, see the [Restore database](/getting-started/setup/instance-management/appsmithctl#restore-database) guide.
5. Restore your Appsmith backup you took earlier to the new MongoDB instance. For more information, see the [Restore database](/getting-started/setup/instance-management/backup-and-restore/restore-database) guide.

6. Once your MongoDB setup is complete, note down the connection string as you’ll need it in the [Configure High Availability](#configure-high-availability) section.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ High availability for Appsmith relies on correctly configured external databases

Appsmith requires MongoDB to store application data. To use an external MongoDB instance with Appsmith, follow the steps below to back up your data, configure the new MongoDB instance, and restore your Appsmith data if needed.

1. Take a backup of your existing MongoDB instance before proceeding. For more information, see [How to take back up of MongoDB data](/getting-started/setup/instance-management/appsmithctl#backup-database) guide.
1. Take a backup of your existing MongoDB instance before proceeding. For more information, see [How to take back up of MongoDB data](/getting-started/setup/instance-management/backup-and-restore/backup-database) guide.

2. If you don't already have a MongoDB instance, create a new one. You can either use an existing instance or set up a new one through your infrastructure or a cloud provider like MongoDB Atlas.

Expand All @@ -54,7 +54,7 @@ Appsmith requires MongoDB to store application data. To use an external MongoDB
```
4. Assign or verify that the MongoDB user account Appsmith uses has `readWrite` and `clusterMonitor` roles assigned.

5. Restore your Appsmith backup you took earlier to the new MongoDB instance. For more information, see the [Restore database](/getting-started/setup/instance-management/appsmithctl#restore-database) guide.
5. Restore your Appsmith backup you took earlier to the new MongoDB instance. For more information, see the [Restore database](/getting-started/setup/instance-management/backup-and-restore/restore-database) guide.

6. Once your MongoDB setup is complete, note down the connection string as you’ll need it in the [Configure High Availability](#configure-high-availability) section.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Migrate to the Appsmith Community Edition using Helm chart v2.
To migrate to the Community Edition running on Helm chart v2 (helm.appsmith.com), follow the instructions in the guide below. Helm chart v2 includes the Horizontal Pod Auto Scaling (HPA) feature, which allows the Appsmith pods to scale automatically based on the current workload.

## Backup data
Take a backup using the [`appsmithctl backup`](/getting-started/setup/instance-management/appsmithctl#backup) command, follow the steps below:
Take a backup using the [`appsmithctl backup`](/getting-started/setup/instance-management/backup-and-restore/backup-instance) command, follow the steps below:

1. Run the following command in the old pods to create a data backup:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ Ensure the user Appsmith uses to connect to the database has the necessary permi

Follow these steps to migrate the data from the old MongoDB instance to the new instance:

1. Take a backup of your existing MongoDB instance. For detailed steps, see the [Backup database](/getting-started/setup/instance-management/appsmithctl#backup-database) guide.
2. Restore the backup to your new MongoDB instance. For detailed steps, see the [Restore database backup](/getting-started/setup/instance-management/appsmithctl#restore-database) guide.
1. Take a backup of your existing MongoDB instance. For detailed steps, see the [Backup database](/getting-started/setup/instance-management/backup-and-restore/backup-database) guide.
2. Restore the backup to your new MongoDB instance. For detailed steps, see the [Restore database backup](/getting-started/setup/instance-management/backup-and-restore/restore-database) guide.

## Connect Appsmith to external MongoDB

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ These instructions apply to platforms running Appsmith on AWS ECS (EC2) and Farg

## Troubleshooting

If you face issues during the upgrade, roll back to a previous version using the [Restore instance guide](/getting-started/setup/instance-management/appsmithctl#restore-instance).
If you face issues during the upgrade, roll back to a previous version using the [Restore instance guide](/getting-started/setup/instance-management/backup-and-restore/restore-instance).

For further queries, contact the Appsmith support team using the chat widget in the bottom-right corner of this page.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ To resolve the error, you may choose one of the below options:

- If you want to overwrite the previous Appsmith installation, delete the `/stacks` folder from the installation directory, and re-run the Docker command.
- If you want to keep the previous Appsmith installation, create a new installation directory and follow the [installation](/getting-started/setup/installation-guides/docker#install-appsmith) instructions.
- If you want to use the Appsmith installation after restoring the data, go to the `docker.env` file and update the encryption password (`APPSMITH_ENCRYPTION_PASSWORD`)and encryption salt (`APPSMITH_ENCRYPTION_SALT`) with the values you copied during the backup process. For more information, see [Backup Database](/getting-started/setup/instance-management/appsmithctl#backup-database).
- If you want to use the Appsmith installation after restoring the data, go to the `docker.env` file and update the encryption password (`APPSMITH_ENCRYPTION_PASSWORD`)and encryption salt (`APPSMITH_ENCRYPTION_SALT`) with the values you copied during the backup process. For more information, see [Backup Database](/getting-started/setup/instance-management/backup-and-restore/backup-database).

## SSL/TLS certification errors

Expand Down

0 comments on commit 2c4bf2e

Please sign in to comment.