Installing an App

From GitHub

You can install any PIPEFORCE app directly from any GitHub repository.

Make sure the repository you would like to deploy from has a folder structure like this:

  • properties/

    • global/

      • app/

        • tld.domain.myapp/

          • The contents of your app start in this level.

Make sure you install only from trusted sources since installing apps from untrusted sources could harm your system!

Public repo

Let's assume you have a public GitHub repository with a name like acme/my-pipeforce-app, then you can use the app.install command to install from this repository like this example shows using a pipeline:

pipeline: - app.install: github: "acme/my-pipeforce-app"

Or you can use the CLI:

pi command app.install github=acme/my-pipeforce-app

Since GitHub allows only a few requests for non-authenticated API calls and limits the transfer bytes, you can install only very small apps using this public repo approach. If you have to install apps with many resources, use the private repo approach since this has higher limits for API calls and bytes transferred.

Private repo

In case you would like to install from a private repo, you have to do these additional steps to register the GitHub access token as secret:

Create a GitHub personal access token

At first you need to create a personal access token in GitHub which allows to read your repo. See GitHub Docs how to do so.

Register access token as credentials

Copy the GitHub access token. Open the PIPEFORCE portal and then go to LOW CODE -> Secrets. Create a new secret of type header with a name of your choice, for example my-github-token, and as value, use this format:

Authorization: token COPY_YOUR_TOKEN_HERE

Save your new secret.

Refer to the secret in the command

Then, you can use it in the app.install command like this:

From Marketplace

In order to install an app from the Apps Marketplace, see here: https://logabit.atlassian.net/wiki/spaces/DEV/pages/2423062592