Rate this page:
The manifest contains three required top-level properties: app
,
modules
, and permissions
, and number of optional properties.
The optional runtime configuration is nested under the app
key.
Property | Required | Description |
---|---|---|
app | Yes | Identifying information, licensing details, and app storage (EAP). See App to learn more. |
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. |
connectModules |
This functionality is an alpha release. A list of the Connect modules used by the app. | |
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 properties about your Forge app. Some of these are populated as part of the
forge create
command (for example, id
).
Property | Required | Description |
---|---|---|
id | Yes | A unique Atlassian resource identifier (ari ) assigned to your app. |
connect |
Details specific to Connect on Forge apps. This is required if the manifest has See Connect to learn more. | |
licensing | No | The app's licensing state. To enable licensing for your app, add the See licensing to learn more. |
storage (EAP) | No |
A list of custom entities and their respective indexes. See Storage to learn more. |
1 2app: id: "ari:cloud:ecosystem::app/406d303d-0393-4ec4-ad7c-1435be94583a" licensing: enabled: true
Custom entities and complex queries are available right now as part of Forge's Early Access Program (EAP). Send us your feedback through this Atlassian Developer Community post.
Forge’s EAP offers experimental features to selected users for testing and feedback purposes. These features are not supported or recommended for use in production environments. They are also subject to change without notice.
For more information about EAPs, see What's coming.
The storage
property lets you set custom entities for your app.
Custom entities are user-defined data structures for storing app data. Forge's storage API lets
you query data stored in these structures using a wide array of query conditions. These query conditions
make it possible to build advanced, complex queries to suit your app's operations.
For more detailed information about custom entities and complex queries, see Complex queries (EAP).
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: