Details of all options available in config.json
When adding a new app to runtipi, you need to create a config.json file in the app's folder. This file contains all the information needed to run the app. Below you can find all the options available in the config.json file.
| Option | Description | Example value | Required |
|---|---|---|---|
| name | Name of the app | Nextcloud | yes |
| id | This should be the same name as the folder | nextcloud | yes |
| available | If set to false, the app will not be available in the app store | true | yes |
| short_desc | Short description of the app | Nextcloud is a suite of client-server software for creating and using file hosting services. | yes |
| author | The github name of the author | https://nextcloud.com (opens in a new tab) | yes |
| port | Port used by the app. This port will be exposed to the host. | 8100 | yes |
| categories | One or more categories for the app | ["utilities", "network"] | yes |
| description | Long description of the app | Nextcloud is a suite of client-server software for creating and using file hosting services. Nextcloud is free and open-source, which means that anyone is allowed to install and operate it on their own private server devices. | yes |
| tipi_version | Always 1 if you are adding a new app. Increment this number if you are updating an existing app | 1 | yes |
| version | The actual version of the app (not the runtipi version) | 1.25.1 | yes |
| source | Link for git repository | https://github.com/nextcloud/docker (opens in a new tab) | yes |
| website | Link to the official website | https://nextcloud.com (opens in a new tab) | no |
| exposable | If set to true, the app will allow the user to expose it via a domain name. | true | yes |
| force_expose | If set to true, the app will require a domain name. | true | no |
| generate_vapid_keys | If set to true, the app will generate VAPID keys for web push notifications. VAPID_PUBLIC_KEY and VAPID_PRIVATE_KEY will be available as environment variables | true | no |
| url_suffix | If set, the app will be accessible at https://<your-domain>/<url_suffix> | my-app | no |
| https | If set to true, the app will be accessible via https only. | true | no |
| no_gui | Set to true for apps with no GUI. Open button will be hidden | true | no |
| supported_architectures | If the app is only available for a specific architecture, you can specify it here. If not given, app will be available for all architectures | ["arm64", "amd64"] | yes |
| uid, gid | These parameters allow you to give a specific set of permission for the app's data folder. Runtipi will automatically chown the data directory with the provided gid and uid. Both options need to be specified in order to apply | 1000 | no |
| form_fiels | Form fields allow you to promt the user for input during the install, like a username or a password | See bellow | yes |
| dynamic | Use the new compose.json to dynamically generate a compose file. | true | no |
| deprecated | If the app is deprecated it won't exist in the app store and it will notify users that is no longer maintained. | false | no |
| min_tipi_version | An app may require a newer version of tipi than you already have for some extra feature | v3.0.0 | no |