Juno Config

Configuration options for [Juno] CLI.

:wrench: Constants

• SatelliteAssertionsSchema
• PermissionTextSchema
• MemoryTextSchema
• RulesTypeSchema
• RuleSchema
• DatastoreCollectionSchema
• StorageCollectionSchema
• CollectionsSchema
• MaxMemorySizeConfigSchema
• DatastoreConfigSchema
• EmulatorConfigSchema
• ModuleLogVisibilitySchema
• ModuleSettingsSchema
• JunoConfigModeSchema
• JunoConfigEnvSchema
• OrbiterIdSchema
• OrbiterIdsSchema
• OrbiterConfigSchema
• StorageConfigSourceGlobSchema
• StorageConfigHeaderSchema
• StorageConfigRewriteSchema
• StorageConfigRedirectSchema
• StorageConfigSchema
• EncodingTypeSchema
• PrecompressSchema
• CliConfigSchema
• SatelliteIdSchema
• SatelliteIdsSchema
• SatelliteConfigOptionsSchema

:gear: SatelliteAssertionsSchema

| Constant | Type | | --------------------------- | ---------------------------------------------------------------------------------------------- | | SatelliteAssertionsSchema | ZodObject<{ heapMemory: ZodOptional<ZodUnion<readonly [ZodBigInt, ZodBoolean]>>; }, $strict> |

References:

• SatelliteAssertions

:link: Source

:gear: PermissionTextSchema

| Constant | Type | | ---------------------- | ---------------------------------------------------------------------------------------------------- | | PermissionTextSchema | ZodEnum<{ public: "public"; private: "private"; managed: "managed"; controllers: "controllers"; }> |

References:

• PermissionText

:link: Source

:gear: MemoryTextSchema

| Constant | Type | | ------------------ | ---------------------------------------------- | | MemoryTextSchema | ZodEnum<{ heap: "heap"; stable: "stable"; }> |

References:

• MemoryText

:link: Source

:gear: RulesTypeSchema

| Constant | Type | | ----------------- | -------------------------------------------- | | RulesTypeSchema | ZodEnum<{ db: "db"; storage: "storage"; }> |

References:

• RulesType

:link: Source

:gear: RuleSchema

| Constant | Type | | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | RuleSchema | ZodObject<{ collection: ZodString; read: ZodEnum<{ public: "public"; private: "private"; managed: "managed"; controllers: "controllers"; }>; write: ZodEnum<{ public: "public"; private: "private"; managed: "managed"; controllers: "controllers"; }>; ... 8 more ...; maxTokens: ZodOptional<...>; }, $strict> |

References:

• Rule

:link: Source

:gear: DatastoreCollectionSchema

| Constant | Type | | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | DatastoreCollectionSchema | ZodObject<{ collection: ZodString; read: ZodEnum<{ public: "public"; private: "private"; managed: "managed"; controllers: "controllers"; }>; write: ZodEnum<{ public: "public"; private: "private"; managed: "managed"; controllers: "controllers"; }>; ... 5 more ...; maxTokens: ZodOptional<...>; }, $strict> |

References:

• DatastoreCollection

:link: Source

:gear: StorageCollectionSchema

| Constant | Type | | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | StorageCollectionSchema | ZodObject<{ collection: ZodString; read: ZodEnum<{ public: "public"; private: "private"; managed: "managed"; controllers: "controllers"; }>; write: ZodEnum<{ public: "public"; private: "private"; managed: "managed"; controllers: "controllers"; }>; ... 5 more ...; maxTokens: ZodOptional<...>; }, $strict> |

References:

• StorageCollection

:link: Source

:gear: CollectionsSchema

| Constant | Type | | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | CollectionsSchema | ZodObject<{ datastore: ZodOptional<ZodArray<ZodObject<{ collection: ZodString; read: ZodEnum<{ public: "public"; private: "private"; managed: "managed"; controllers: "controllers"; }>; write: ZodEnum<{ public: "public"; private: "private"; managed: "managed"; controllers: "controllers"; }>; ... 5 more ...; maxTokens... |

References:

• Collections

:link: Source

:gear: MaxMemorySizeConfigSchema

| Constant | Type | | --------------------------- | --------------------------------------------------------------------------------------- | | MaxMemorySizeConfigSchema | ZodObject<{ heap: ZodOptional<ZodBigInt>; stable: ZodOptional<ZodBigInt>; }, $strict> |

References:

• MaxMemorySizeConfig

:link: Source

:gear: DatastoreConfigSchema

| Constant | Type | | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | DatastoreConfigSchema | ZodObject<{ maxMemorySize: ZodOptional<ZodObject<{ heap: ZodOptional<ZodBigInt>; stable: ZodOptional<ZodBigInt>; }, $strict>>; version: ZodOptional<...>; }, $strict> |

References:

• DatastoreConfig

:link: Source

:gear: EmulatorConfigSchema

| Constant | Type | | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | EmulatorConfigSchema | ZodUnion<readonly [ZodObject<{ runner: ZodOptional<ZodObject<{ type: ZodEnum<{ docker: "docker"; podman: "podman"; }>; image: ZodOptional<ZodString>; name: ZodOptional<ZodString>; volume: ZodOptional<...>; target: ZodOptional<...>; platform: ZodOptional<...>; }, $strict>>; network: ZodOptional<...>; skylab: ZodObjec... |

References:

• EmulatorConfig

:link: Source

:gear: ModuleLogVisibilitySchema

| Constant | Type | | --------------------------- | ------------------------------------------------------------ | | ModuleLogVisibilitySchema | ZodEnum<{ public: "public"; controllers: "controllers"; }> |

References:

• ModuleLogVisibility

:link: Source

:gear: ModuleSettingsSchema

| Constant | Type | | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ModuleSettingsSchema | ZodObject<{ freezingThreshold: ZodOptional<ZodBigInt>; reservedCyclesLimit: ZodOptional<ZodBigInt>; logVisibility: ZodOptional<ZodEnum<{ public: "public"; controllers: "controllers"; }>>; heapMemoryLimit: ZodOptional<...>; memoryAllocation: ZodOptional<...>; computeAllocation: ZodOptional<...>; }, $strict> |

References:

• ModuleSettings

:link: Source

:gear: JunoConfigModeSchema

| Constant | Type | | ---------------------- | ---------------------------------------------------------- | | JunoConfigModeSchema | ZodUnion<readonly [ZodLiteral<"production">, ZodString]> |

References:

• JunoConfigMode

:link: Source

:gear: JunoConfigEnvSchema

| Constant | Type | | --------------------- | ---------------------------------------------------------------------------------------- | | JunoConfigEnvSchema | ZodObject<{ mode: ZodUnion<readonly [ZodLiteral<"production">, ZodString]>; }, $strip> |

References:

• JunoConfigEnv

:link: Source

:gear: OrbiterIdSchema

| Constant | Type | | ----------------- | --------------------------------------- | | OrbiterIdSchema | ZodObject<{ id: ZodString; }, $strip> |

References:

• OrbiterId

:link: Source

:gear: OrbiterIdsSchema

| Constant | Type | | ------------------ | ------------------------------------------------------------------------------------------------------------- | | OrbiterIdsSchema | ZodObject<{ ids: ZodRecord<ZodUnion<readonly [ZodLiteral<"production">, ZodString]>, ZodString>; }, $strip> |

References:

• OrbiterIds

:link: Source

:gear: OrbiterConfigSchema

| Constant | Type | | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | OrbiterConfigSchema | ZodUnion<readonly [ZodObject<{ id: ZodString; }, $strict>, ZodObject<{ ids: ZodRecord<ZodUnion<readonly [ZodLiteral<"production">, ZodString]>, ZodString>; }, $strict>]> |

References:

• OrbiterConfig

:link: Source

:gear: StorageConfigSourceGlobSchema

| Constant | Type | | ------------------------------- | ----------- | | StorageConfigSourceGlobSchema | ZodString |

References:

• StorageConfigSourceGlob

:link: Source

:gear: StorageConfigHeaderSchema

| Constant | Type | | --------------------------- | ------------------------------------------------------------------------------------------------------- | | StorageConfigHeaderSchema | ZodObject<{ source: ZodString; headers: ZodArray<ZodTuple<[ZodString, ZodString], null>>; }, $strict> |

References:

• StorageConfigHeader

:link: Source

:gear: StorageConfigRewriteSchema

| Constant | Type | | ---------------------------- | -------------------------------------------------------------------- | | StorageConfigRewriteSchema | ZodObject<{ source: ZodString; destination: ZodString; }, $strict> |

References:

• StorageConfigRewrite

:link: Source

:gear: StorageConfigRedirectSchema

| Constant | Type | | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | | StorageConfigRedirectSchema | ZodObject<{ source: ZodString; location: ZodString; code: ZodUnion<readonly [ZodLiteral<301>, ZodLiteral<302>]>; }, $strict> |

References:

• StorageConfigRedirect

:link: Source

:gear: StorageConfigSchema

| Constant | Type | | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | StorageConfigSchema | ZodObject<{ headers: ZodOptional<ZodArray<ZodObject<{ source: ZodString; headers: ZodArray<ZodTuple<[ZodString, ZodString], null>>; }, $strict>>>; ... 5 more ...; version: ZodOptional<...>; }, $strip> |

References:

• StorageConfig

:link: Source

:gear: EncodingTypeSchema

see EncodingType

| Constant | Type | | -------------------- | ------------------------------------------------------------------------------------------------------ | | EncodingTypeSchema | ZodEnum<{ identity: "identity"; gzip: "gzip"; compress: "compress"; deflate: "deflate"; br: "br"; }> |

:link: Source

:gear: PrecompressSchema

| Constant | Type | | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | PrecompressSchema | ZodObject<{ pattern: ZodOptional<ZodString>; mode: ZodOptional<ZodEnum<{ both: "both"; replace: "replace"; }>>; algorithm: ZodOptional<ZodEnum<{ gzip: "gzip"; brotli: "brotli"; }>>; }, $strict> |

References:

• Precompress

:link: Source

:gear: CliConfigSchema

| Constant | Type | | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | CliConfigSchema | ZodObject<{ source: ZodOptional<ZodString>; ignore: ZodOptional<ZodArray<ZodString>>; precompress: ZodOptional<ZodUnion<readonly [ZodObject<{ pattern: ZodOptional<ZodString>; mode: ZodOptional<...>; algorithm: ZodOptional<...>; }, $strict>, ZodArray<...>, ZodLiteral<...>]>>; encoding: ZodOptional<...>; predeploy: Zo... |

References:

• CliConfig

:link: Source

:gear: SatelliteIdSchema

| Constant | Type | | ------------------- | --------------------------------------- | | SatelliteIdSchema | ZodObject<{ id: ZodString; }, $strip> |

References:

• SatelliteId

:link: Source

:gear: SatelliteIdsSchema

| Constant | Type | | -------------------- | ------------------------------------------------------------------------------------------------------------- | | SatelliteIdsSchema | ZodObject<{ ids: ZodRecord<ZodUnion<readonly [ZodLiteral<"production">, ZodString]>, ZodString>; }, $strip> |

References:

• SatelliteIds

:link: Source

:gear: SatelliteConfigOptionsSchema

| Constant | Type | | ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | SatelliteConfigOptionsSchema | ZodUnion<readonly [ZodObject<{ storage: ZodOptional<ZodObject<{ headers: ZodOptional<ZodArray<ZodObject<{ source: ZodString; headers: ZodArray<ZodTuple<[ZodString, ZodString], null>>; }, $strict>>>; ... 5 more ...; version: ZodOptional<...>; }, $strip>>; ... 6 more ...; id: ZodString; }, $strict>, ZodObject<...>]> |

References:

• JunoConsoleConfig

:link: Source

:tropical_drink: Interfaces

• SatelliteAssertions
• Rule
• Collections
• MaxMemorySizeConfig
• DatastoreConfig
• EmulatorPorts
• EmulatorSkylab
• EmulatorConsole
• EmulatorSatellite
• EmulatorRunner
• NetworkServices
• Network
• ModuleSettings
• JunoConfigEnv
• OrbiterId
• OrbiterIds
• StorageConfigHeader
• StorageConfigRewrite
• StorageConfigRedirect
• StorageConfig
• Precompress
• CliConfig
• SatelliteId
• SatelliteIds
• SatelliteConfigOptions

:gear: SatelliteAssertions

Configuration for satellite assertions.

| Property | Type | Description | | ------------ | -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | heapMemory | bigint or boolean or undefined | Configuration for the heap memory size check, which can be: - true to enable the check with a default threshold of 900MB, - false to disable the heap memory size check, - A bigint to specify a custom threshold in MB (megabytes) for the heap memory size check. If not specified, then true is used as the default value. type: {bigint or boolean} |

:link: Source

:gear: Rule

Represents a rule configuration for a collection.

| Property | Type | Description | | -------------------- | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | | collection | string | The name of the collection the rule applies to. type: {string} | | read | PermissionText | The permission level for read access. type: {PermissionText} | | write | PermissionText | The permission level for write access. type: {PermissionText} | | memory | MemoryText | The type of memory allocated for the collection. type: {MemoryText} | | createdAt | bigint or undefined | The timestamp when the rule was created. type: {bigint}optional | | updatedAt | bigint or undefined | The timestamp when the rule was last updated. type: {bigint}optional | | version | bigint or undefined | The version of the rule. type: {bigint}optionaldescription: Must be provided when updating the rule to ensure the correct version is being updated. | | maxSize | bigint or undefined | The maximum size of the collection in bytes. type: {number}optional | | maxChangesPerUser | number or undefined | The maximum number of changes (create, update or delete) per user for the collection. type: {number}optional | | maxCapacity | number or undefined | The maximum capacity of the collection. type: {number}optional | | mutablePermissions | boolean or undefined | Indicates whether the permissions are mutable. default: truetype: {boolean} | | maxTokens | bigint or undefined | The maximum number of writes and deletes per minute. |

:link: Source

:gear: Collections

Represents the configuration for all the collections of a Satellite.

| Property | Type | Description | | ----------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------ | | datastore | DatastoreCollection[] or undefined | An optional array that defines the collections of the Datastore. type: {DatastoreCollection[]}optional | | storage | StorageCollection[] or undefined | An optional array that defines the collections of the Storage. type: {StorageCollection[]}optional |

:link: Source

:gear: MaxMemorySizeConfig

Configuration for granting access to features only if the maximum memory size limits are not reached.

The maximum size corresponds to the overall heap or stable memory of the smart contract.

| Property | Type | Description | | -------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | heap | bigint or undefined | Maximum allowed heap memory size in bytes. This field is optional. If not specified, no limit is enforced on the heap memory size. type: {bigint} | | stable | bigint or undefined | Maximum allowed stable memory size in bytes. This field is optional. If not specified, no limit is enforced on the stable memory size. type: {bigint} |

:link: Source

:gear: DatastoreConfig

Configures the behavior of the Datastore.

| Property | Type | Description | | --------------- | ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | maxMemorySize | MaxMemorySizeConfig or undefined | Configuration for maximum memory size limits for the Datastore. This is used to specify optional limits on heap and stable memory for the smart contract. When the limit is reached, the Datastore and smart contract continue to operate normally but reject the creation or updates of documents. If not specified, no memory limits are enforced. type: {MaxMemorySizeConfig}optional | | version | bigint or undefined | The current version of the config. Optional. The CLI will automatically resolve the version and warn you if there's a potential overwrite. You can provide it if you want to manage versioning manually within your config file. type: {bigint}optional |

:link: Source

:gear: EmulatorPorts

Represents the ports exposed by an emulator container.

| Property | Type | Description | | ------------------ | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | server | number or undefined | The port of the server used to simulate execution. This is the port your app connects to. Also known as the "local Internet Computer replica" or the "Pocket-IC port". default: 5987 | | admin | number or undefined | The port of the admin server used for tasks like transferring ICP from the ledger. default: 5999 | | timeoutInSeconds | number or undefined | Max number of seconds to wait for emulator ports to become ready. default: 30 |

:link: Source

:gear: EmulatorSkylab

Configuration for the Skylab emulator.

| Property | Type | Description | | -------- | ------------------------------------------------------- | -------------------------------------- | | ports | (EmulatorPorts and { console: number; }) or undefined | Ports exposed by the Skylab container. |

:link: Source

:gear: EmulatorConsole

Configuration for the Console emulator.

| Property | Type | Description | | -------- | ---------------------------- | --------------------------------------- | | ports | EmulatorPorts or undefined | Ports exposed by the Console container. |

:link: Source

:gear: EmulatorSatellite

Configuration for the Satellite emulator.

| Property | Type | Description | | -------- | ---------------------------- | ----------------------------------------- | | ports | EmulatorPorts or undefined | Ports exposed by the Satellite container. |

:link: Source

:gear: EmulatorRunner

Shared options for all runner variants.

| Property | Type | Description | | ---------- | --------------------------------------------- | ----------------------------------------------------------------------------------------------------- | | type | "docker" or "podman" | The containerization tool to run the emulator. | | image | string or undefined | Image reference. default: depends on emulator type, e.g. "junobuild/skylab:latest" | | name | string or undefined | Optional container name to use for the emulator. Useful for reusing or managing a specific container. | | volume | string or undefined | Persistent volume to store internal state. default: "juno" | | target | string or undefined | Shared folder for deploying and hot-reloading serverless functions. | | platform | "linux/amd64" or "linux/arm64" or undefined | The platform to use when running the emulator container. |

:link: Source

:gear: NetworkServices

Network services that can be enabled in the emulator.

Each flag corresponds to a system canister or application that can be included in the local Internet Computer network when the emulator starts.

| Property | Type | Description | | ------------------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | registry | boolean or undefined | Registry canister: Stores network configuration and topology (subnet membership, public keys, feature flags). Acts as the source of truth other system canisters read/write to. | | cmc | boolean or undefined | CMC (Cycles Minting Canister): Converts ICP to cycles and distributes them; maintains subnet lists and conversion rate. Requires icp and nns to not be enabled. | | icp | boolean or undefined | ICP token: Deploys the ICP ledger and index canisters. | | cycles | boolean or undefined | Cycles token: Deploys the cycles ledger and index canisters. | | nns | boolean or undefined | NNS governance canisters: Deploys the governance and root canisters. Core governance system (neurons, proposals, voting) and related control logic. Enables managing network-level decisions in an emulated environment. | | sns | boolean or undefined | SNS canisters: Deploys the SNS-W and aggregator canisters. Service Nervous System stack used to govern individual dapps. | | internet_identity | boolean or undefined | Internet Identity: Deploys the II canister for authentication. | | nns_dapp | boolean or undefined | NNS dapp: Deploys the NNS UI canister and frontend application Requires cmc, icp, nns, sns, internet_identity to be enabled. |

:link: Source

:gear: Network

Configuration for customizing the Internet Computer network bootstrapped by the emulator.

| Property | Type | Description | | ---------- | ----------------- | ----------------------------------------------------------- | | services | NetworkServices | System canisters and applications available in the network. |

:link: Source

:gear: ModuleSettings

Settings for a module - Satellite, Mission Control or Orbiter.

These settings control various aspects of the module's behavior and resource usage.

| Property | Type | Description | | --------------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | freezingThreshold | bigint or undefined | The cycle threshold below which the module will automatically stop to avoid running out of cycles. For example, if set to BigInt(1000000), the module will stop when it has fewer than 1,000,000 cycles remaining. type: {bigint} | | reservedCyclesLimit | bigint or undefined | The number of cycles reserved for the module's operations to ensure it has enough cycles to function. For example, setting it to BigInt(5000000) reserves 5,000,000 cycles for the module. type: {bigint} | | logVisibility | ModuleLogVisibility or undefined | Controls who can see the module's logs. type: {ModuleLogVisibility} | | heapMemoryLimit | bigint or undefined | The maximum amount of WebAssembly (Wasm) memory the module can use on the heap. For example, setting it to BigInt(1024 * 1024 * 64) allows the module to use up to 64 MB of Wasm memory. type: {bigint} | | memoryAllocation | bigint or undefined | The amount of memory explicitly allocated to the module. For example, setting it to BigInt(1024 * 1024 * 128) allocates 128 MB of memory to the module. type: {bigint} | | computeAllocation | bigint or undefined | The proportion of compute capacity allocated to the module. This is a fraction of the total compute capacity of the subnet. For example, setting it to BigInt(10) allocates 10% of the compute capacity to the module. type: {bigint} |

:link: Source

:gear: JunoConfigEnv

Represents the environment configuration for Juno.

| Property | Type | Description | | -------- | -------- | ---------------------------------------------------------- | | mode | string | The mode of the Juno configuration. type: {JunoConfigMode} |

:link: Source

:gear: OrbiterId

Represents the configuration for an orbiter.

| Property | Type | Description | | -------- | -------- | -------------------------------------------------------------- | | id | string | The identifier of the orbiter used in the dApp. type: {string} |

:link: Source

:gear: OrbiterIds

Represents a mapping of orbiter identitifiers to different configurations based on the mode of the application.

| Property | Type | Description | | -------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ids | Record<string, string> | A mapping of orbiter identifiers (IDs) to different configurations based on the mode of the application. This allows the application to use different orbiter IDs, such as production, development, etc. Example: { "production": "xo2hm-lqaaa-aaaal-ab3oa-cai", "development": "gl6nx-5maaa-aaaaa-qaaqq-cai" } type: {Record<JunoConfigMode, string>} |

:link: Source

:gear: StorageConfigHeader

Headers allow the client and the Storage to pass additional information along with a request or a response. Some sets of headers can affect how the browser handles the page and its content.

| Property | Type | Description | | --------- | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | source | string | The glob pattern used to match files within the Storage that these headers will apply to. type: {StorageConfigSourceGlob} | | headers | [string, string][] | An array of key-value pairs representing the headers to apply. Each pair includes the header name and its value. Example: [["Cache-Control", "max-age=3600"], ["X-Custom-Header", "value"]] type: {Array<[string, string]>} |

:link: Source

:gear: StorageConfigRewrite

You can utilize optional rewrites to display the same content for multiple URLs. Rewrites are especially useful when combined with pattern matching, allowing acceptance of any URL that matches the pattern.

| Property | Type | Description | | ------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | source | string | The glob pattern or specific path to match for incoming requests. Matches are rewritten to the specified destination. type: {StorageConfigSourceGlob} | | destination | string | The destination path or file to which matching requests should be rewritten. type: {string} |

:link: Source

:gear: StorageConfigRedirect

Use a URL redirect to prevent broken links if you've moved a page or to shorten URLs.

| Property | Type | Description | | ---------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------- | | source | string | The glob pattern or specific path to match for incoming requests that should be redirected. type: {StorageConfigSourceGlob} | | location | string | The URL or path to which the request should be redirected. type: {string} | | code | 301 or 302 | The HTTP status code to use for the redirect, typically 301 (permanent redirect) or 302 (temporary redirect). type: {301 or 302} |

:link: Source

:gear: StorageConfig

Configures the hosting behavior of the Storage.

| Property | Type | Description | | --------------- | ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | headers | StorageConfigHeader[] or undefined | Optional array of StorageConfigHeader objects to define custom HTTP headers for specific files or patterns. type: {StorageConfigHeader[]}optional | | rewrites | StorageConfigRewrite[] or undefined | Optional array of StorageConfigRewrite objects to define rewrite rules. type: {StorageConfigRewrite[]}optional | | redirects | StorageConfigRedirect[] or undefined | Optional array of StorageConfigRedirect objects to define HTTP redirects. type: {StorageConfigRedirect[]}optional | | iframe | "deny" or "same-origin" or "allow-any" or undefined | For security reasons and to prevent click-jacking attacks, dapps deployed with Juno are, by default, set to deny embedding in other sites. Options are: - deny: Prevents any content from being displayed in an iframe. - same-origin: Allows iframe content from the same origin as the page. - allow-any: Allows iframe content from any origin. If not specified, then deny is used as default value. type: {'deny' or 'same-origin' or 'allow-any'}optional | | rawAccess | boolean or undefined | Optional flag to enable access for raw URLs. ⚠️ WARNING: Enabling this option is highly discouraged due to security risks. Enabling this option allows access to raw URLs (e.g., https://satellite-id.raw.icp0.io), bypassing certificate validation. This creates a security vulnerability where a malicious node in the chain can respond to requests with malicious or invalid content. Since there is no validation on raw URLs, the client may receive and process harmful data. If not specified, the default value is false. type: {boolean}optional | | maxMemorySize | MaxMemorySizeConfig or undefined | Configuration for maximum memory size limits for the Storage. This is used to specify optional limits on heap and stable memory for the smart contract. When the limit is reached, the Storage and smart contract continue to operate normally but reject the upload of new assets. If not specified, no memory limits are enforced. type: {MaxMemorySizeConfig}optional | | version | bigint or undefined | The current version of the config. Optional. The CLI will automatically resolve the version and warn you if there's a potential overwrite. You can provide it if you want to manage versioning manually within your config file. type: {bigint}optional |

:link: Source

:gear: Precompress

Configuration for compressing files during deployment.

| Property | Type | Description | | ----------- | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | --- | ---- | | pattern | string or undefined | Glob pattern for files to precompress. default: any css | js | mjs | html | | mode | "both" or "replace" or undefined | Determines what happens to the original files after compression: - "both" — upload both original and compressed versions. - "replace" — upload only the compressed version (served with Content-Encoding). default: "both" | | algorithm | "gzip" or "brotli" or undefined | Compression algorithm. default: "gzip" |

:link: Source

:gear: CliConfig

The configuration used by the CLI to resolve, prepare and deploy your app.

| Property | Type | Description | | ------------- | ---------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | source | string or undefined | Specifies the directory from which to deploy to Storage. For instance, if npm run build outputs files to a dist folder, use source: 'dist'. default: 'build'type: {string} | | ignore | string[] or undefined | Specifies files or patterns to ignore during deployment, using glob patterns similar to those in .gitignore. type: {string[]}optional | | precompress | false or Precompress or Precompress[] or undefined | Controls compression optimization for files in the source folder. By default, JavaScript (.js), ES Modules (.mjs), CSS (.css), and HTML (.html) are compressed, and both the original and compressed versions are uploaded. Set to false to disable, or provide one or more {@link Precompress} objects to customize. type: {Precompress or Precompress[] or false}optional | | encoding | [string, EncodingType][] or undefined | Customizes file encoding mapping for HTTP response headers Content-Encoding based on file extension: - .Z for compress, - .gz for gzip, - .br for brotli, - .zlib for deflate, - anything else defaults to identity. The "encoding" attribute allows overriding default mappings with an array of glob patterns and encoding types. type: {Array<[string, EncodingType]>}optional | | predeploy | string[] or undefined | Defines a list of scripts or commands to be run before the deployment process begins. This can be useful for tasks such as compiling assets, running tests, or building production-ready files. Example: json { "predeploy": ["npm run build", "npm run lint"] } type: {string[]}optional | | postdeploy | string[] or undefined | Defines a list of scripts or commands to be run after the deployment process completes. This can be used for tasks such as notifications, cleanup, or sending confirmation messages to services or team members. Example: json { "postdeploy": ["./scripts/notify-admins.sh", "echo 'Deployment complete'"] } type: {string[]}optional |

:link: Source

:gear: SatelliteId

Represents the unique identifier for a satellite.

| Property | Type | Description | | -------- | -------- | -------------------------------------------------------------------------------- | | id | string | The unique identifier (ID) of the satellite for this application. type: {string} |

:link: Source

:gear: SatelliteIds

Represents a mapping of satellite identifiers to different configurations based on the mode of the application.

| Property | Type | Description | | -------- | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ids | Record<string, string> | A mapping of satellite identifiers (IDs) to different configurations based on the mode of the application. This allows the application to use different satellite IDs, such as production, staging, etc. Example: { "production": "xo2hm-lqaaa-aaaal-ab3oa-cai", "staging": "gl6nx-5maaa-aaaaa-qaaqq-cai" } type: {Record<JunoConfigMode, string>} |

:link: Source

:gear: SatelliteConfigOptions

SatelliteConfigOptions interface provides configuration settings that allow for fine-tuning the operational behavior of various aspects of a Satellite, such as storage, datastore, authentication, automation, and deployment assertions.

These options affect specific modules of the Satellite and may require manual application of changes, typically through CLI commands (e.g., juno config).

| Property | Type | Description | | ---------------- | ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | storage | StorageConfig or undefined | Optional configuration parameters for the satellite, affecting the operational behavior of its Storage. Changes to these parameters must be applied manually afterwards, for example with the CLI using juno config commands. type: {StorageConfig}optional | | datastore | DatastoreConfig or undefined | Optional configuration parameters for the satellite, affecting the operational behavior of its Datastore. Changes to these parameters must be applied manually afterwards, for example with the CLI using juno config commands. type: {DatastoreConfig}optional | | authentication | AuthenticationConfig or undefined | Optional configuration parameters for the satellite, affecting the operational behavior of its Authentication. Changes to these parameters must be applied manually afterwards, for example with the CLI using juno config commands. type: {AuthenticationConfig}optional | | automation | AutomationConfig or undefined | Optional configuration parameters for the behavior of the automation. Changes to these parameters must be applied manually afterwards, for example with the CLI using juno config commands. type: {AutomationConfig}optional | | assertions | SatelliteAssertions or undefined | Optional configurations to override default assertions made by the CLI regarding satellite deployment conditions. type: {SatelliteAssertions}optional | | settings | ModuleSettings or undefined | Optional configuration parameters for the Satellite. These settings control various aspects of the module's behavior and resource usage. type: {ModuleSett