Rate this page:
The manifest file describes your Forge app. It’s created as part of the Forge CLI’s
forge create
command with filename manifest.yml
. The manifest uses YAML syntax.
The manifest contains the following top-level properties: app
, modules
, permissions
, and resources
(optional).
Note that the optional runtime
configuration is nested under the app
key.
Property | Required | Description |
---|---|---|
app | Yes | Identifying information about the app. See App to learn more. |
connectModules |
This functionality is an alpha release. A list of the connect modules used by the app. | |
modules | Yes |
A list of the modules used by the app. See Modules to learn more. |
permissions | Yes |
A list of the permissions required by the app. See Permissions to learn more. |
providers |
Authentication providers used by the app. See Providers to learn more. | |
remotes |
A list of remote services required by the app. See Remotes to learn more. | |
resources |
A list of the resources used by the app. See Resources to learn more. |
The app
dictionary contains details about your Forge app. These are populated as part of the
forge create
command.
Property | Required | Description |
---|---|---|
id | Yes | A unique Atlassian resource identifier (ari ) assigned to your app. |
name | The app's name. Maximum 50 characters. | |
connect |
Details specific to Connect on Forge apps. This is required if the manifest has See Connect to learn more. | |
licensing | The app's licensing state. To enable licensing for your app, add the See licensing to learn more. |
1 2app: id: "ari:cloud:ecosystem::app/406d303d-0393-4ec4-ad7c-1435be94583a" name: my-cool-forge-app licensing: enabled: true
This functionality is an alpha release.
Before using a Connect module for your Forge app, check first if it already has an equivalent Forge module. Whenever possible, we strongly recommend that you use Forge modules for Forge apps.
A Forge app can include Connect modules and a Connect key. This is intended to ease the transition from Connect to Forge. See Migrate an app from Connect to Forge for more information.
Property | Required | Description |
---|---|---|
key | Yes |
A key to identify Connect on Forge apps and Forge successors to Connect apps.
Note: The production environment of the app must match the Atlassian Marketplace key. |
remote |
The key of the This is required if the manifest has | |
authentication |
Defines the authentication type to use when making requests from the connect app server to the host application
|
1 2remotes: - key: connect-app-server baseUrl: https://hello-world-app.example.com app: connect: key: hello-world remote: connect-app-server authentication: jwt
Each time you deploy or invoke code on Forge, your code runs inside the sandbox environment. The runtime
properties allow you to configure aspects of your app's environment.
Property | Type | Required | Description |
---|---|---|---|
snapshots | boolean | Whether a snapshot of the app is taken at deployment time. Default value of true . |
1 2app: runtime: snapshots: true
Rate this page: