Skip to content

Installing an Application

The starting point for most users will be to install an existing application. Since applications are stored in git repositories, the first step is to locate the git url of an application you wish to install. The nf-sdk repository maintains a list of links to apps you might want to try to install.

After clicking on the "+Create" button, you will see the Create Application modal:

Create new application screenshot

Paste the Git URL into form, and give the application a name.

Info

Installing an application may take time. Installing an application requires cloning the targeted Git repository, creating a new sandbox for the runtime, and installing any dependencies using npm install. Therefore, the Normal installation requires network access to the Git site as well as NPM.

Configuring an Application

Once the install has completed, many applications have configuration options that are set to make it easier to move them between different sites. In this example, the application has a number of different configuration options available by clicking the "Configure" link on the application tile.

Configure application screenshot

Info

Consult the documentation from the hook you are installing to determine appropriate values for the application configuration.

Verifying the Install & Further Setup

After an the application is installed & configured, you should check the status of any hooks which were installed as part of the application by clicking the "Edit" button on the application tile. This will display the list of hooks, and the most recent status associated with each of them. Depending on the application, additional configuration steps might be needed to fully integrate the application with your site.