Cover image for luis

Luis Ibarra

Technical Support Engineer

Appsmith

How to Renew Your Git Deploy Key for Git-Connected Appsmith Apps

Over time, Git deploy keys can get corrupted or deprecated, particularly those generated using older SHA-1 encryption (typically before June 2024).

When a key stops working, developers are unable to perform Git operations such as fetching branches, pulling, or committing changes in edit mode. The deployed version of your app will remain functional, but edit/development mode will continue showing errors like the one shown below until the key is renewed.

Git error message

If your Git deploy key has expired, revoked or is still SHA-1 -  you can easily generate and add a new one to re-establish the connection between your Git repository and Appsmith. In order to correct this situation, please follow the below steps: 

Step 1: Go to your Git-Connected App

Open your app

Step 2: Go to Git Settings

Go to git settings

Step 3: Click on "Generate deploy key"

Generate deploy key

Step 4: Copy the newly generated SSH key

Copy SSH key

Step 5: Go to your repository settings

Go to repository settings

Step 6: Click on the "Deploy keys" menu

Click on the Deploy keys menu

Step 7: Click on "Add deploy key"

Add deploy key

Step 8: Give your new key a title, paste the generated SSH key, check "Allow write access", and click "Add key"

Create the new deploy key

Step 9: Go back to your Appsmith app, check the box confirming you’ve added and enabled write access for the deploy key, then click "Finish"

Confirm previous steps and finish process

Troubleshooting: