# Integrating Sofy with Jenkins

Updated 4 years ago by SYED A HAMID

Need to **integrate Jenkins with Sofy**? No problem! Complete the following steps and you'll be ready to go.

#### Initial installation

To install the Sofy.ai Jenkins plugin, open your Jenkins dashboard and complete the following steps:

1. Click on **Manage Jenkins**  
2. Click on **Manage Plugins**  
3. Click on **Available Tab**  
4. **Search for "Sofy"** and you should see the **'Sofy.ai' plugin** among the results  
5. This plugin can be installed and used immediately by checking the box adjacent to the plugin and clicking **Install without restart**

#### Web application builds

When beginning a new freestyle project in Jenkins (or select configure on your existing project), complete the following steps:

1. Select **Add Post-build Actions**  
2. Select **Stage web test run with Sofy.ai**  
3. Enter the **API key** obtained from your Sofy.ai account. If you have misplaced your API key (or don't have one), complete the following steps:  
   1. Login to **sofy.ai**  
   2. Go to **Settings**  
   3. Select **API key**  
   4. Click on **Generate new key**. **Copy** this key to Jenkins  
4. **Enter the URL** where your web app will be hosted, as well the **maximum number of pages** you want Sofy to test  
5. Select **Save**  
6. After successful builds, test runs will be automatically staged on Sofy.ai under your account. Any errors or problems will be reported in the build log output. Please report errors at the following URL: [https://www.Sofy.ai/contact-us](/content/contact-us/index.html)  
7. Select **View Test Run Results** in the respective build menu to check results. To view more detailed results visit the following URL: [https://www.sofy.ai](/content/site-root.html)

#### Mobile application builds

When making a new freestyle project in Jenkins (or select configure on your existing project), complete the following steps:

1. Select **Add Post-build Actions**  
2. Select **Stage mobile test run with Sofy.ai**  
3. Enter the **API key** obtained from your Sofy.ai account. If you have misplaced your API key (or don't have one), complete the following steps:  
   1. **Login** to sofy.ai  
   2. Go to **Settings**  
   3. Select **API key**  
   4. Click on **Generate new key**. **Copy this key** to Jenkins.  
4. Enter the **file path** where your '.apk' file will be located after a successful build  
5. Select **Save**  
6. Test runs will be staged on Sofy.ai under your account automatically after successful builds. Any errors or problems will be reported in the build log output. Please report errors at the following URL: [https://www.Sofy.ai/contact-us](/content/contact-us/index.html)  
7. Select **View Test Run Results** in the respective build menu to check results. To view more detailed results visit the following URL: [https://www.Sofy.ai](/content/site-root.html)
