| Argument | Type | Description |
|---|
| container-command-lines | | Specifies the command-line argument(s) to pass to the application when starting the container |
| auto-update | | Enables or disables automatic updating when a new container image version is available |
| use-https | | Uses HTTPS for the application URL. This option will not work on devices that do not support cloud services |
| network | | Specifies which network the container will use: internal (behind NAT), lan (on the LAN network), or default (varies per application) |
| network-pvid | | Sets the Port VLAN ID (PVID) for the container's virtual Ethernet interface in the bridge |
| network-outgoing-access | | Allows network outgoing access for the specific container app. When set to no, a mangle drop rule is created |
| firewall-redirects | | Configures port redirection from the host device to the container |
| yaml | | Provides the YAML composition for the application. See the documentation for configuration examples |
| required-mounts | | Mount directories required for the container to start. Format: [dir-on-host]:[dir-in-app] |
| Specifies additional mount points to attach to the container |
| environment | | Defines environment variables to be available to the running application. Specify as a list of key-value pair(s) |
| secrets | | |
| required-hw-devices | | Hardware devices that must be present on the host for the container to start. Format: [host-hw-device]:[device-in-app] |
| devices | | Specifies additional hardware devices to pass through to the container application |
| Read-only Argument | Type | Description |
|---|
| app-store-url | | The URL of the app store from which the application was installed |
| name | | The application name as defined in the YAML configuration |
| description | | The application description as defined in the YAML configuration |
| project-page | | The application project page URL as defined in the YAML configuration |
| category | | Application functional classification |
| ui-url | | The generated URL for the application web interface, if available |
| default-credentials | | The default credentials required for the application |
| status | | The current status of the application (acquire veth, configuring container(s), downloading/extracting, starting) |
| default-network | | The default network used by the application (lan or internal) |
| interface | | The VETH interface used by the application |
| ip-address | | The IP address assigned to the VETH interface |
| cmds | | |
| cpu-usage | | The current CPU usage percentage by the application |
| memory-current | | The amount of memory currently used by the application |
| app-size | | The total size of the application |
| data-size | | The size of the data stored by the application |
| configs | | |
| variables-to-use-in-environment | | A list of all variables present in the application environment |