Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Check Appsmith version #2762

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 9 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 83 additions & 6 deletions website/docs/help-and-support/troubleshooting-guide/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,89 @@
---
description: This page provides troubleshooting resources for common errors encountered while self-hosting Appsmith or building applications, along with guidance on how to resolve them effectively.
---

# Overview

When using Appsmith, you may encounter errors related to both self-hosting the platform and building applications. This page provides detailed resources to help you troubleshoot and resolve common issues. Whether you're facing deployment issues, database connection problems, or application-specific errors, you can find the relevant troubleshooting guides below for step-by-step solutions.

---
To troubleshoot your issue, you can try the following:


### Check Your Appsmith Version

It is important to verify the version of Appsmith you are using. Knowing your version ensures compatibility with the latest features and fixes. This step can help you identify if your version is outdated and may require an update to resolve certain issues.


- For Docker:

<dd>

```bash
docker exec -it appsmith cat info.json
```

</dd>

- For Kubernetes:

<dd>

```bash
kubectl exec -it <appsmith-pod-name> -- cat /appsmith-stacks/configuration/info.json
```
</dd>

Once you've confirmed your version, visit the [Appsmith GitHub Release Notes](https://github.com/appsmithorg/appsmith/releases) to compare your current version with the latest release. If your version is outdated, consider upgrading to the latest version to benefit from the latest fixes and features.

For instructions on how to upgrade, please refer to our [upgrade guides](/getting-started/setup/instance-management).


### Verify Logs for Errors

Logs provide valuable insights into the health of your Appsmith instance and can help identify underlying issues affecting the platform. Reviewing the logs is essential for troubleshooting errors that might occur during deployment or operation.

- For Docker: You can view logs using the following command:

<dd>

```bash
docker logs appsmith
```
</dd>

- For Kubernetes: Use the following command to view logs for the Appsmith pod:

<dd>

```bash
kubectl logs <appsmith-pod-name>
```
</dd>


### Restart Services

To resolve potential issues related to resource allocation or configuration changes, restart the Appsmith services. This can help in clearing temporary issues and ensuring smooth operation.

- For Docker:

<dd>

```bash
docker restart appsmith
```
</dd>


- For Kubernetes:

<dd>

```bash
kubectl rollout restart deployment appsmith
```

</dd>


If the steps above don’t resolve your issue, refer to more specific troubleshooting guides:


<div className="containerGridSampleApp">
<!-- Self-Hosting Errors -->
Expand Down Expand Up @@ -35,7 +112,7 @@ When using Appsmith, you may encounter errors related to both self-hosting the p
</a>
</div>

---


## Contacting Support

Expand Down
Binary file added website/static/img/appsmith-cloud-version.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading