Skip to main content

Connect to GitHub

This guide shows how to connect your Appsmith application to a remote GitHub repository.

  1. Open the Appsmith app you want to connect to Git and click the Connect Git button on the left of the bottom bar.

  2. Select Github as the service provider.

info

Version Control works with any Git hosting service that supports the SSH protocol and deploy keys. HTTPS Git connections are not currently supported in Appsmith.

  1. Create a new Git repository or open an existing empty repository. The connection may fail if the repository is not empty.

  2. After setting up an empty repository, navigate to the repository's landing page, click on the Code button, and copy the SSH URL.

  3. Paste the URL in the Generate SSH Key section on Appsmith.

  4. Click the Generate SSH Keys button, and unique ECDSA 256 and RSA 4096 keys are displayed. Choose the appropriate key based on your specific security requirements and system constraints.

  5. Copy one of the keys, then navigate to your Repository settings. Proceed to Deploy keys, click on Add deploy keys, paste the copied key, and provide a meaningful title for future reference.

  6. Check the Allow write access option and then add the key.

  7. In Appsmith, click the Connect Git button.

With these steps, you have successfully connected to Git.

caution

A user needs to have Create permission for application resources on the workspace to be able to connect or disconnect an app to Git. For more information, see Create Permission.

See also​