The manifest contains three required top-level properties: app,
modules, and permissions, and number of optional properties. For example:
1 2 3 4 5app: id: "ari:cloud:ecosystem::app/406d303d-0393-4ec4-ad7c-1435be94583a" licensing: enabled: true
| Property | Required | Description |
|---|---|---|
app | Yes | Identifying information, licensing details, and app storage (EAP). See App to learn more. |
permissions | Yes |
A list of the permissions required by the app. See Permissions to learn more. |
modules | Yes* |
A list of the modules used by the app. Cannot be empty. See Modules to learn more. *Not required when |
connectModules |
A list of legacy Connect modules used by the app. This is a backwards compatibility feature to support incremental migration from Connect to Forge. Names and fields map 1:1 to Connect descriptor modules.
Adding Connect Modules to a new Forge app is not supported. | |
endpoint |
A list of remote endpoints referenced by remote resolver invocations. See Endpoint 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 (along with additional options for declaring egress details for data residency). See Remotes to learn more. | |
resources |
A list of the resources used by the app. See Resources to learn more. | |
services (EAP) |
Containerised services used by the app. See Services to learn more. | |
environment |
A list of environment variables to be parsed by the Forge CLI for entire or partial field values. After specifying a variable in See Environment to learn more. | |
translations |
A list of translation resources supported by the app, including the fallback configurations for when a desired translation is not available. See Translations to learn more. |
The Forge platform enforces a maximum file size limit of 200 KB for the manifest.yml file. If your manifest exceeds this size,
deployment will fail with a validation error.
To avoid this, ensure that your manifest only includes the modules and configuration necessary for your app. If you encounter this limit, consider removing unused modules, splitting your app into smaller components, or refactoring your configuration. This limit helps maintain platform performance and reliability.
For patterns that keep your manifest well within this limit, see Manifest size best practices.
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. The Forge CLI supplies this identifier when you create or register an app for the first time. |
connect |
Details specific to Adopting Forge from Connect. 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 overview for details on billing models, including user-based billing. See Listing Forge apps for setup instructions. |
access | No | Settings for user-based billing. To enable user-based billing, set See Adopt user-based billing for implementation details and the License API for retrieving license information programmatically. |
package | No |
Settings relating to packaging the Forge application. See Packaging to learn more. |
runtime | Yes |
Settings relating to the Forge runtime. See Runtime to learn more. |
storage | No |
A list of custom entities and their respective indexes. 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. See Custom entities to learn more. |
The runtime property lets you configure the Forge runtime using the following settings:
| Setting | Required | Type | Description |
|---|---|---|---|
name | Yes | string | Lets you specify the Forge runtime environment version on which to deploy your app. This field supports the following values: nodejs24.x: (recommended) specifies the Node.js 24 runtime version. This version runs on a standard Node.js 24 environment.nodejs22.x: specifies the Node.js 22 runtime version. This version runs on
a standard Node.js 22 environment.nodejs20.x: specifies the Node.js 20 runtime version. This version runs on
a standard Node.js 20 environment.See Runtime for more information about these runtime versions. |
architecture | No | string | Specify the architecture used to deploy your app. Supported values are: arm64 and x86_64. Default value is x86_64. According to AWS, Lambda functions powered by arm64 architecture are designed to deliver up to 19 percent better performance at 20 percent lower cost. Note that arm64 architecture is not available on Atlassian Government Cloud. |
memoryMB | No | number | The default amount of memory available to all the functions at runtime. Increasing the function memory also increases its CPU allocation. The default value is 512 MB. The value can be between 128 MB and 1,024 MB. You can override the memory available for individual functions by setting at the function module definition. |
The legacy Javascript sandbox runtime is now deprecated. This means that Forge can only create new apps on the latest runtime version. In addition:
If your app is running on the Javascript sandbox runtime, we strongly advise that you upgrade to the latest runtime.
The package property lets you configure how the application's source code is
packaged during deployment.
This is an experimental Early Access Program (EAP) feature, offered to selected users for testing and feedback purposes. EAP features are unsupported, not usable in production environments, and subject to change without notice.
By default, Forge uses Webpack to bundle your application code
together with its dependencies.
To provide compiled application code yourself instead, set this to
manual@2026. See packaging for
more details.
| Setting | Type | Description |
|---|---|---|
extraFiles | string[] |
Extra files to copy to the deployed application. These can include application data, configuration files or additional programs the application might want to read or launch. Each item in this list can point to a single file or a glob pattern. When the Forge function runs, the files matching the specified patterns are available in the application directory. |
path (EAP) | string |
This is an experimental Early Access Program (EAP) feature, offered to selected users for testing and feedback purposes. EAP features are unsupported, not usable in production environments, and subject to change without notice. Path where the compiled application code resides when using manual packaging. See packaging for details. |
You can read packaged files using the fs module.
1 2 3 4import { readFileSync } from 'node:fs'; const data = readFileSync('./file.txt', 'utf8');
If you intend to add extra executables to your application and call them from functions, make sure they are compatible with the Forge runtime environment. You might want to use statically linked executables if possible, or include the required libraries together with the executable.
You can execute packaged binaries using the child_process module.
1 2 3 4 5 6 7import { execFileSync } from 'node:child_process'; const stdout = execFileSync('./binary', ['--args'], { stdio: 'pipe', encoding: 'utf8', });
While you can read files and execute binaries packaged with your app, you must not persist customer data to disk or allow long-running child processes to retain it. If you aren't sure whether a process will cache the data, don't allow it to persist beyond a single function invocation.
Refer to Expanded developer responsibilities for more information.
Connect apps that have adopted Forge modules can include Connect modules and a Connect key.
| Property | Required | Description |
|---|---|---|
key | Yes |
A key to identify the Connect app and its components.
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 |
1 2 3 4 5 6 7 8remotes: - key: connect-app-server baseUrl: https://hello-world-app.example.com app: connect: key: hello-world remote: connect-app-server
Rate this page: