schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
metadata.json
build
As for 'prebuild', but runs during the actual build phase (but before the main Ant/Maven build). Use this only for actions that do actual building. Any preparation of the source code should be done using 'init' or 'prebuild'.
{}
metadata.json
postbuild
Specifies a single or a list of shell commands to run after the build takes place.
{}
metadata.json
buildjni
Enables building of native code via the ndk-build script before doing the main Ant build.
{"anyOf": [{"type": "string", "enum": ["yes", "no"]}, {"type": "array", "items": {"type": "string"}}]}
metadata.json
ndk
Version of the NDK to use in this build.
{"type": "string"}
metadata.json
gradle
Build with Gradle instead of Ant, specifying what flavours to use. Flavours are case sensitive since the path to the output APK is as well.
{"anyOf": [{"type": "array", "items": {"const": "yes"}, "maxItems": 1}, {"type": "array", "items": {"type": "string"}}]}
metadata.json
maven
Build with Maven instead of Ant. An extra @<dir> tells F-Droid to run Maven inside that relative subdirectory.
{"anyOf": [{"type": "string"}, {"type": "string", "enum": ["yes", "yes@"]}]}
metadata.json
preassemble
List of Gradle tasks to be run before the assemble task in a Gradle project build.
{}
metadata.json
gradleprops
List of Gradle properties to pass via the command line to Gradle. A property can be of the form foo or of the form key=value.
{}
metadata.json
antcommands
Specify an alternate set of Ant commands (target) instead of the default 'release'. It can't be given any flags, such as the path to a build.xml.
{}
metadata.json
output
Specify a glob path where the resulting unsigned release APK from the build should be.
{"type": "string"}
metadata.json
binary
The location of binaries used in verification process.
{}
metadata.json
novcheck
Don't check that the version name and code in the resulting APK are correct by looking at the build output - assume the metadata is correct.
{"const": true}
metadata.json
antifeatures
List of Anti-Features for this specific build. They are described in AntiFeatures.
{}
metadata.json
Disabled
If this field is present, the application does not get put into the public index. The value should be a description of why the application is disabled.
{"type": "string"}
metadata.json
RequiresRoot
Whether the application requires root privileges to be usable.
{"type": "boolean"}
metadata.json
ArchivePolicy
This determines the number of versions to keep. The older versions of the app are moved to the archive repo, if one is configured. Defaults to 3.
{"type": "integer"}
metadata.json
AutoUpdateMode
This determines the method used for auto-generating new builds when new releases are available - in other words, adding a new Build Version line to the metadata.
{"type": "string", "anyOf": [{"enum": ["None", "Version"]}, {"pattern": "^Version( \\+.+)? [^+].+"}]}
metadata.json
UpdateCheckMode
This determines the method using for determining when new releases are available - in other words, the updating of the CurrentVersion and CurrentVersionCode fields in the metadata by the fdroid checkupdates process.
{"type": "string", "anyOf": [{"enum": ["None", "Static", "HTTP"]}, {"pattern": "^RepoManifest(/.+)?$"}, {"pattern": "^Tags( .*)?$"}]}
metadata.json
VercodeOperation
A list of operations to be applied to the vercode obtained by the defined UpdateCheckMode. %c will be replaced by the actual vercode, and each string will be passed to python's eval function to calculate a version code.
{"type": "array", "items": {"type": "string"}, "uniqueItems": true, "minItems": 1}
metadata.json
UpdateCheckIgnore
When checking for updates (via UpdateCheckMode) this can be used to specify a regex which, if matched against the version name, causes that version to be ignored.
{"type": "string"}
metadata.json
UpdateCheckName
When checking for updates (via UpdateCheckMode) this can be used to specify the package name to search for. Useful when apps have a static package name but change it programmatically in some app flavors, by e.g. appending “.open” or “.free” at the end of the package name.
{"anyOf": [{"type": "string"}, {"type": "string", "enum": ["Ignore"]}]}
metadata.json
UpdateCheckData
Used in conjunction with UpdateCheckMode for certain modes.
{"type": "string"}
metadata.json
CurrentVersion
The name of the version that is the recommended release. There may be newer versions of the application than this (e.g. unstable versions), and there will almost certainly be older ones.
{"type": "string"}
metadata.json
CurrentVersionCode
The version code corresponding to the CurrentVersion field.
{"type": "integer"}
metadata.json
NoSourceSince
In case we are missing the source code for the CurrentVersion reported by Upstream, or that Non-Free elements have been introduced, this defines the first version that began to miss source code.
{"type": "string"}
feed.json
author
Use the "authors" key instead, even when there is only one author. Existing feeds can include both "author" and "authors" for compatibility with existing feed readers. Feed readers should always prefer `authors` if present.
{"deprecated": true, "allOf": [{}]}
feed.json
id
Is unique for that item for that feed over time. If an item is ever updated, the id should be unchanged. New items should never use a previously-used id. Ideally, the id is the full URL of the resource described by the item, since URLs make great unique identifiers.
{"type": ["string"]}
feed.json
language
The language for this item, using the same format as the top-level "language" field. The value can be different than the primary language for the feed when a specific item is written in a different language than other items in the feed.
{"type": "string"}
feed.json
author
Use the "authors" key instead, even when there is only one author. Existing feeds can include both "author" and "authors" for compatibility with existing feed readers. Feed readers should always prefer `authors` if present.
{"deprecated": true, "allOf": [{}]}
feed.json
language
The primary language for the feed in the format specified in RFC 5646. The value is usually a 2-letter language tag from ISO 639-1, optionally followed by a region tag. (Examples: "en" or "en-US".)
{"type": "string"}
feed.json
version
The URL of the version of the format the feed uses. This should appear at the very top, though we recognize that not all JSON generators allow for ordering.
{"anyOf": [{"enum": ["https://jsonfeed.org/version/1.1"]}, {}]}
grunt-copy-task.json
options
Set the options for grunt-contrib-copy
{"type": "object", "properties": {"noProcess": {"type": "string"}, "encoding": {"type": "string"}, "mode": {"type": ["boolean", "number"], "default": false}}}
grunt-copy-task.json
noProcess
This option is passed to grunt.file.copy as an advanced way to control which file contents are processed.
{"type": "string"}
grunt-copy-task.json
encoding
The file encoding to copy files with.
{"type": "string"}
grunt-copy-task.json
mode
Whether to copy or set the existing file permissions. Set to true to copy the existing file permissions. Or set to the mode, i.e.: 0644, that copied files will be set to.
{"type": ["boolean", "number"], "default": false}
fly.json
https://fly.io/docs/reference/configuration
{"$schema": "http://json-schema.org/draft-07/schema#", "definitions": {"statics": {"type": "object", "required": ["guest_path", "url_prefix"], "additionalProperties": false, "properties": {"guest_path": {"type": "string"}, "url_prefix": {"type": "string"}}}, "services": {"type": "object", "properties": {"script_checks": {"deprecated": true}, "protocol": {"type": "string", "enum": ["tcp", "udp"]}, "internal_port": {"type": "integer", "default": 8080}, "concurrency": {"type": "object", "properties": {"type": {"type": "string", "default": "connections", "x-taplo": {"docs": {"enumValues": ["Autoscale based on number of concurrent connections", "Autoscale based on number of concurrent requests"]}}, "enum": ["connections", "requests"]}, "hard_limit": {"default": 25, "type": "integer"}, "soft_limit": {"default": 20, "type": "integer"}}}, "ports": {"type": "array", "items": {"type": "object", "properties": {"handlers": {"x-taplo": {"links": {"key": "https://fly.io/docs/reference/services/#connection-handlers"}}, "type": "array", "items": {"type": "string", "minLength": 1, "enum": ["http", "tls", "proxy_proto", "pg_tls", "edge_http"]}}, "port": {"default": 8080, "type": "integer"}, "force_https": {"type": "boolean"}}}}, "tcp_checks": {"type": "array", "x-taplo": {"links": {"key": "https://fly.io/docs/reference/configuration/#services-tcp_checks"}}, "items": {"type": "object", "properties": {"grace_period": {"oneOf": [{"type": "integer"}, {"type": "string"}]}, "interval": {"oneOf": [{"type": "integer"}, {"type": "string"}]}, "restart_limit": {"default": 0, "type": "integer"}, "timeout": {"oneOf": [{"type": "integer"}, {"type": "string"}]}}}}, "http_checks": {"type": "array", "x-taplo": {"links": {"key": "https://fly.io/docs/reference/configuration/#services-http_checks"}}, "items": {"type": "object", "properties": {"grace_period": {"oneOf": [{"type": "integer"}, {"type": "string"}]}, "interval": {"oneOf": [{"type": "integer"}, {"type": "string"}]}, "restart_limit": {"default": 0, "type": "integer"}, "timeout": {"oneOf": [{"type": "integer"}, {"type": "string"}]}, "method": {"type": "string"}, "path": {"type": "string"}, "protocol": {"type": "string", "enum": ["http", "https"]}, "tls_skip_verify": {"type": "boolean", "default": false}, "headers": {"type": "object"}}}}}}}, "properties": {"app": {"type": "string"}, "kill_timeout": {"oneOf": [{"type": "integer"}, {"type": "string"}]}, "kill_signal": {"type": "string", "enum": ["SIGINT", "SIGTERM", "SIGQUIT", "SIGUSR1", "SIGUSR2", "SIGKILL", "SIGSTOP"]}, "statics": {"x-taplo": {"links": {"key": "https://fly.io/docs/reference/configuration/#the-statics-sections"}}, "anyOf": [{}, {"type": "array", "items": {}}]}, "services": {"oneOf": [{}, {"type": "array", "items": {}}]}, "deploy": {"type": "object", "additionalProperties": false, "properties": {"release_command": {"x-taplo": {"links": {"key": "https://fly.io/docs/reference/configuration/#release_command"}, "initKeys": ["importantKey"]}, "type": "string"}, "strategy": {"type": "string", "default": "canary", "enum": ["canary", "rolling", "bluegreen", "immediate"], "x-taplo": {"docs": {"main": "Strategy for replacing VMs during a deployment.", "enumValues": ["This default strategy - for apps without volumes - will boot a single, new VM with the new release, verify its health, then proceed with a rolling restart strategy.", "One by one, each running VM is taken down and replaced by a new release VM. This is the default strategy for apps with volumes.", "For every running VM, a new one is booted alongside it. All new VMs must pass health checks to complete deployment, when traffic gets migrated to new VMs. If your app has multiple VMs, this strategy may reduce deploy time and downtime, assuming your app is scaled to 2 or more VMs.", "Replace all VMs with new releases immediately without waiting for health checks to pass. This is useful in emergency situations where you're confident a release will be healthy."], "defaultValue": "Default is 'canary': boot a single, new VM with the new release, verify its health, then proceed with a rolling restart strategy."}, "links": {"key": "https://fly.io/docs/reference/configuration/#strategy"}}}}}, "mounts": {"type": "object", "x-taplo": {"links": {"key": "https://fly.io/docs/reference/configuration/#the-mounts-section"}}, "required": ["source", "destination"], "additionalProperties": false, "properties": {"source": {"type": "string"}, "destination": {"type": "string"}, "processes": {"type": "array", "items": {"type": "string", "minLength": 1}}}}, "experimental": {"type": "object", "properties": {"cmd": {"anyOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}, "entrypoint": {"anyOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}, "auto_rollback": {"type": "boolean"}, "private_network": {"default": true, "type": "boolean"}}}, "env": {"type": "object", "additionalProperties": {"type": "string"}}, "build": {"type": "object", "properties": {"builder": {"type": "string"}, "buildpacks": {"type": "array", "items": {"type": "string", "minLength": 1}, "uniqueItems": true, "minItems": 1}, "args": {"type": "array", "items": {"type": "object"}}, "build-target": {"type": "string"}, "image": {"type": "string"}, "dockerfile": {"type": "string"}, "additionalProperties": false}}, "additionalProperties": true}, "type": "object", "x-taplo-info": {"authors": ["Joshua Sierles (https://github.com/jsierles)"], "patterns": ["\\.*fly(.*)?\\.toml?$"]}}
fly.json
guest_path
The path inside your container where the assets to serve are located.
{"type": "string"}
fly.json
url_prefix
The URL prefix that should serve the static assets.
{"type": "string"}
fly.json
services
Configure the mapping of ports from the public Fly proxy to your application. You can have: * **No services section**: The application has no mappings to the external internet - typically apps like databases or background job workers that talk over 6PN private networking to other apps. * **One services section**: One internal port mapped to one external port on the internet. * **Multiple services sections**: Map multiple internal ports to multiple external ports.
{"type": "object", "properties": {"script_checks": {"deprecated": true}, "protocol": {"type": "string", "enum": ["tcp", "udp"]}, "internal_port": {"type": "integer", "default": 8080}, "concurrency": {"type": "object", "properties": {"type": {"type": "string", "default": "connections", "x-taplo": {"docs": {"enumValues": ["Autoscale based on number of concurrent connections", "Autoscale based on number of concurrent requests"]}}, "enum": ["connections", "requests"]}, "hard_limit": {"default": 25, "type": "integer"}, "soft_limit": {"default": 20, "type": "integer"}}}, "ports": {"type": "array", "items": {"type": "object", "properties": {"handlers": {"x-taplo": {"links": {"key": "https://fly.io/docs/reference/services/#connection-handlers"}}, "type": "array", "items": {"type": "string", "minLength": 1, "enum": ["http", "tls", "proxy_proto", "pg_tls", "edge_http"]}}, "port": {"default": 8080, "type": "integer"}, "force_https": {"type": "boolean"}}}}, "tcp_checks": {"type": "array", "x-taplo": {"links": {"key": "https://fly.io/docs/reference/configuration/#services-tcp_checks"}}, "items": {"type": "object", "properties": {"grace_period": {"oneOf": [{"type": "integer"}, {"type": "string"}]}, "interval": {"oneOf": [{"type": "integer"}, {"type": "string"}]}, "restart_limit": {"default": 0, "type": "integer"}, "timeout": {"oneOf": [{"type": "integer"}, {"type": "string"}]}}}}, "http_checks": {"type": "array", "x-taplo": {"links": {"key": "https://fly.io/docs/reference/configuration/#services-http_checks"}}, "items": {"type": "object", "properties": {"grace_period": {"oneOf": [{"type": "integer"}, {"type": "string"}]}, "interval": {"oneOf": [{"type": "integer"}, {"type": "string"}]}, "restart_limit": {"default": 0, "type": "integer"}, "timeout": {"oneOf": [{"type": "integer"}, {"type": "string"}]}, "method": {"type": "string"}, "path": {"type": "string"}, "protocol": {"type": "string", "enum": ["http", "https"]}, "tls_skip_verify": {"type": "boolean", "default": false}, "headers": {"type": "object"}}}}}}
fly.json
script_checks
Health checks that run as one-off commands directly on the VM. This type of check is **deprecated**. See `tcp_checks` or `http_checks` for alternatives.
{"deprecated": true}
fly.json
protocol
The protocol used to communicate with your application. Can be: `tcp` or `udp`.
{"type": "string", "enum": ["tcp", "udp"]}
fly.json
internal_port
The port this application listens on to communicate with clients. The default is 8080. We recommend applications use the default.
{"type": "integer", "default": 8080}
fly.json
concurrency
Control autoscaling metrics (connections or requests) and limits (hard and soft).
{"type": "object", "properties": {"type": {"type": "string", "default": "connections", "x-taplo": {"docs": {"enumValues": ["Autoscale based on number of concurrent connections", "Autoscale based on number of concurrent requests"]}}, "enum": ["connections", "requests"]}, "hard_limit": {"default": 25, "type": "integer"}, "soft_limit": {"default": 20, "type": "integer"}}}
fly.json
hard_limit
When an application instance is __at__ or __over__ this number, the system will bring up another instance.
{"default": 25, "type": "integer"}
fly.json
soft_limit
When an application instance is __at__ or __over__ this number, the system is likely to bring up another instance.
{"default": 20, "type": "integer"}
fly.json
ports
For each external port you want to accept connections on, add a `ports` section.
{"type": "array", "items": {"type": "object", "properties": {"handlers": {"x-taplo": {"links": {"key": "https://fly.io/docs/reference/services/#connection-handlers"}}, "type": "array", "items": {"type": "string", "minLength": 1, "enum": ["http", "tls", "proxy_proto", "pg_tls", "edge_http"]}}, "port": {"default": 8080, "type": "integer"}, "force_https": {"type": "boolean"}}}}
fly.json
handlers
An array of strings that select handlers to terminate the connection at the edge. Valid options: http, tls, proxy_proto, pg_tls, edge_http.
{"x-taplo": {"links": {"key": "https://fly.io/docs/reference/services/#connection-handlers"}}, "type": "array", "items": {"type": "string", "minLength": 1, "enum": ["http", "tls", "proxy_proto", "pg_tls", "edge_http"]}}
fly.json
port
The port to accept traffic on. Valid ports: 1-65535
{"default": 8080, "type": "integer"}
fly.json
force_https
Force HTTP connections to HTTPS. `force_https` requires the `http` handler in the `handlers` section.
{"type": "boolean"}
fly.json
tcp_checks
Basic TCP connection health checks. This is the default check that runs against the configured `internal_port`.
{"type": "array", "x-taplo": {"links": {"key": "https://fly.io/docs/reference/configuration/#services-tcp_checks"}}, "items": {"type": "object", "properties": {"grace_period": {"oneOf": [{"type": "integer"}, {"type": "string"}]}, "interval": {"oneOf": [{"type": "integer"}, {"type": "string"}]}, "restart_limit": {"default": 0, "type": "integer"}, "timeout": {"oneOf": [{"type": "integer"}, {"type": "string"}]}}}}
fly.json
grace_period
The time to wait after a VM starts before checking its health. Units are milliseconds unless you specify them like `10s` or `1m`.
{"oneOf": [{"type": "integer"}, {"type": "string"}]}
fly.json
interval
Length of the pause between connectivity checks. Units are milliseconds unless you specify them like `10s` or `1m`.
{"oneOf": [{"type": "integer"}, {"type": "string"}]}
fly.json
restart_limit
The number of consecutive TCP check failures to allow before attempting to restart the VM. The default is `0`, which disables restarts based on failed TCP health checks.
{"default": 0, "type": "integer"}
fly.json
timeout
The maximum time a connection can take before being reported as failing its healthcheck. Units are milliseconds unless you specify them like `10s` or `1m`.
{"oneOf": [{"type": "integer"}, {"type": "string"}]}
fly.json
http_checks
HTTP-based health checks run against the `internal_port`. These checks will pass when receiving a 2xx response. Any other response is considered a failure.
{"type": "array", "x-taplo": {"links": {"key": "https://fly.io/docs/reference/configuration/#services-http_checks"}}, "items": {"type": "object", "properties": {"grace_period": {"oneOf": [{"type": "integer"}, {"type": "string"}]}, "interval": {"oneOf": [{"type": "integer"}, {"type": "string"}]}, "restart_limit": {"default": 0, "type": "integer"}, "timeout": {"oneOf": [{"type": "integer"}, {"type": "string"}]}, "method": {"type": "string"}, "path": {"type": "string"}, "protocol": {"type": "string", "enum": ["http", "https"]}, "tls_skip_verify": {"type": "boolean", "default": false}, "headers": {"type": "object"}}}}
fly.json
grace_period
The time to wait after a VM starts before checking its health. Units are milliseconds unless you specify them like `10s` or `1m`.
{"oneOf": [{"type": "integer"}, {"type": "string"}]}
fly.json
interval
Length of the pause between connectivity checks. Units are milliseconds unless you specify them like `10s` or `1m`.
{"oneOf": [{"type": "integer"}, {"type": "string"}]}
fly.json
restart_limit
The number of consecutive check failures to allow before attempting to restart the VM. The default is `0`, which disables restarts based on failed health checks.
{"default": 0, "type": "integer"}
fly.json
timeout
The maximum time a connection can take before being reported as failing its healthcheck. Units are milliseconds unless you specify them like `10s` or `1m`.
{"oneOf": [{"type": "integer"}, {"type": "string"}]}
fly.json
method
The HTTP method to be used for the check.
{"type": "string"}
fly.json
path
The path of the URL to be requested.
{"type": "string"}
fly.json
protocol
The protocol to be used (`http` or `https`)
{"type": "string", "enum": ["http", "https"]}
fly.json
tls_skip_verify
When set to `true` (and `protocol` is set to `https`), skip verifying the certificates sent by the server.
{"type": "boolean", "default": false}
fly.json
headers
Set key/value pairs of HTTP headers to pass along with the check request.
{"type": "object"}
fly.json
app
Fly.io application name
{"type": "string"}
fly.json
kill_timeout
Seconds to wait before forcing a VM process to exit. Default is 5 seconds.
{"oneOf": [{"type": "integer"}, {"type": "string"}]}
fly.json
kill_signal
Signal to send to a process to shut it down gracefully. Default is SIGINT.
{"type": "string", "enum": ["SIGINT", "SIGTERM", "SIGQUIT", "SIGUSR1", "SIGUSR2", "SIGKILL", "SIGSTOP"]}
fly.json
statics
The `statics` sections expose static assets built into your application's container to Fly's Anycast network. You can serve HTML files, Javascript, and images without needing to run a web server inside your container.
{"x-taplo": {"links": {"key": "https://fly.io/docs/reference/configuration/#the-statics-sections"}}, "anyOf": [{}, {"type": "array", "items": {}}]}
fly.json
release_command
Command to run after a build, with access to the production environment, but before deployment. Non-zero exit status will abort the deployment. ```toml [deploy] release_command ="bundle exec rails db:migrate" ```
{"x-taplo": {"links": {"key": "https://fly.io/docs/reference/configuration/#release_command"}, "initKeys": ["importantKey"]}, "type": "string"}
fly.json
strategy
Strategy for replacing VMs during a deployment.
{"type": "string", "default": "canary", "enum": ["canary", "rolling", "bluegreen", "immediate"], "x-taplo": {"docs": {"main": "Strategy for replacing VMs during a deployment.", "enumValues": ["This default strategy - for apps without volumes - will boot a single, new VM with the new release, verify its health, then proceed with a rolling restart strategy.", "One by one, each running VM is taken down and replaced by a new release VM. This is the default strategy for apps with volumes.", "For every running VM, a new one is booted alongside it. All new VMs must pass health checks to complete deployment, when traffic gets migrated to new VMs. If your app has multiple VMs, this strategy may reduce deploy time and downtime, assuming your app is scaled to 2 or more VMs.", "Replace all VMs with new releases immediately without waiting for health checks to pass. This is useful in emergency situations where you're confident a release will be healthy."], "defaultValue": "Default is 'canary': boot a single, new VM with the new release, verify its health, then proceed with a rolling restart strategy."}, "links": {"key": "https://fly.io/docs/reference/configuration/#strategy"}}}
fly.json
mounts
Mount [persistent storage volumes](https://fly.io/docs/reference/volumes) previously setup via `flyctl`. Both settings are required. Example: ```toml [mounts] source = "myapp_data" destination = "/data" ```
{"type": "object", "x-taplo": {"links": {"key": "https://fly.io/docs/reference/configuration/#the-mounts-section"}}, "required": ["source", "destination"], "additionalProperties": false, "properties": {"source": {"type": "string"}, "destination": {"type": "string"}, "processes": {"type": "array", "items": {"type": "string", "minLength": 1}}}}
fly.json
source
The name of the volume to mount as shown in `fly volumes list`. A volume of this name *must exist* in each of the app regions. If there's more than one volume in the target region with the same one, one will be picked randomly.
{"type": "string"}
fly.json
destination
The path at which the `source` volume should be mounted in the running app VM.
{"type": "string"}
fly.json
processes
The name of the process(es) to which this mount should be applied. See [multiple processes](https://community.fly.io/t/preview-multi-process-apps-get-your-workers-here/2316).
{"type": "array", "items": {"type": "string", "minLength": 1}}
fly.json
experimental
Flags and features that are subject to change, deprecation or promotion to the main configuration.
{"type": "object", "properties": {"cmd": {"anyOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}, "entrypoint": {"anyOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}, "auto_rollback": {"type": "boolean"}, "private_network": {"default": true, "type": "boolean"}}}
fly.json
cmd
Override the server command (CMD) set by the Dockerfile. Specify as an array of strings: ```toml cmd = ["path/to/command", "arg1", "arg2"] ```
{"anyOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}
fly.json
entrypoint
Override the ENTRYPOINT set by the Dockerfile. Specify as an array of strings: ```toml entrypoint = ["path/to/command", "arg1", "arg2"] ```
{"anyOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}]}
fly.json
auto_rollback
Failed deployments should roll back automatically to the previous successfully deployed release. Defaults to `true`
{"type": "boolean"}
fly.json
private_network
Enables private network access to the Fly organization. Defaults to `true`.
{"default": true, "type": "boolean"}
fly.json
env
Set non-sensitive information as environment variables in the application's [runtime environment](https://fly.io/docs/reference/runtime-environment/). For sensitive information, such as credentials or passwords, use the [secrets command](https://fly.io/docs/reference/secrets). For anything else though, the `env` section provides a simple way to set environment variables. Here's an example: ```toml [env] LOG_LEVEL = "debug" S3_BUCKET = "my-bucket" ```
{"type": "object", "additionalProperties": {"type": "string"}}
fly.json
build
Build configuration options. See docs at https://fly.io/docs/reference/builders.
{"type": "object", "properties": {"builder": {"type": "string"}, "buildpacks": {"type": "array", "items": {"type": "string", "minLength": 1}, "uniqueItems": true, "minItems": 1}, "args": {"type": "array", "items": {"type": "object"}}, "build-target": {"type": "string"}, "image": {"type": "string"}, "dockerfile": {"type": "string"}, "additionalProperties": false}}
fly.json
builder
Builder Docker image to be used with the 'buildpacks' option
{"type": "string"}
fly.json
buildpacks
Buildpacks to be run by the 'builder' Docker image
{"type": "array", "items": {"type": "string", "minLength": 1}, "uniqueItems": true, "minItems": 1}
fly.json
args
Build arguments passed to both Dockerfile and Buildpack builds. These arguments are **not available** on VMs at runtime. ```toml [build.args] USER = "julieta" MODE = "production" ```
{"type": "array", "items": {"type": "object"}}
fly.json
build-target
Specify the target stage for [multistage Dockerfile builds](https://docs.docker.com/develop/develop-images/multistage-build/).
{"type": "string"}
fly.json
image
Docker image to be deployed (skips the build process)
{"type": "string"}
fly.json
dockerfile
Dockerfile used for builds. Defaults to './Dockerfile'
{"type": "string"}
clib.json
name
The name of the package https://github.com/clibs/clib/wiki/Explanation-of-clib.json#name
{"type": "string", "pattern": "^[0-9a-z-_]+$"}
clib.json
version
The semantic version number of the package. This number should also be a git tag. https://github.com/clibs/clib/wiki/Explanation-of-clib.json#version
{"type": "string"}
clib.json
src
An array of source files that make up the implementation of your package. https://github.com/clibs/clib/wiki/Explanation-of-clib.json#src
{"type": "array", "items": {"type": "string"}}
clib.json
dependencies
A dictionary of packages and their versions. Each entry represents a package dependency. A dependency must be a clib package. https://github.com/clibs/clib/wiki/Explanation-of-clib.json#dependencies
{"type": "object", "additionalProperties": {"type": "string"}}
clib.json
development
Development dependencies are for testing and development purposes. https://github.com/clibs/clib/wiki/Explanation-of-clib.json#development
{"type": "object", "additionalProperties": {"type": "string"}}
clib.json
repo
he GitHub slug for your package. https://github.com/clibs/clib/wiki/Explanation-of-clib.json#repo
{"type": "string"}
clib.json
description
A short-and-sweet description of your package. https://github.com/clibs/clib/wiki/Explanation-of-clib.json#description
{"type": "string"}
clib.json
keywords
An array of keywords which describe your package. https://github.com/clibs/clib/wiki/Explanation-of-clib.json#keywords
{"type": "array", "items": {"type": "string"}}
clib.json
license
The license your package is released under. https://github.com/clibs/clib/wiki/Explanation-of-clib.json#license
{"type": "string"}
clib.json
makefile
Your package's Makefile. https://github.com/clibs/clib/wiki/Explanation-of-clib.json#makefile
{"type": "string"}
clib.json
install
Define a script to install your package. This is for executables and libraries only. https://github.com/clibs/clib/wiki/Explanation-of-clib.json#install
{"type": "string"}
clib.json
uninstall
Define a script to uninstall your package. https://github.com/clibs/clib/wiki/Explanation-of-clib.json#uninstall
{"type": "string"}
pgap_yaml_input_reader.json
NCBI Prokaryotic Genome Annotation Pipeline (PGAP) input metadata (submol) JSON/YAML configuration file
{"$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": {}, "properties": {"$schema": {"type": "string", "default": "", "examples": ["https://json.schemastore.org/pgap_yaml_input_reader"]}, "consortium": {"type": "string", "default": "", "examples": ["SkyNet"]}, "comment": {"type": "string", "default": "", "examples": ["This draft WGS assembly was generated by running SKESA to generate a de-novo assembly. The de-novo assembly was then concatenated with configs generated using a guided assembler using antimicrobial resistance genes as baits to comprehensively catalog the set of resistance genes in the isolate. Note, some parts of the configs derived from the guided assembler may overlap de-novo configs, and other guided assembler configs. De-novo configs can be differentiated from guided assembler configs by their names, which include either 'denovo' or 'guided'."]}, "tp_assembly": {"type": "boolean", "default": false, "examples": [false]}, "sra": {"type": "array", "items": {"type": "object", "additionalProperties": false, "required": ["accession"], "properties": {"accession": {"type": "string", "default": "", "examples": ["SRR8796989"]}}}}, "authors": {"type": "array", "items": {"type": "object", "additionalProperties": false, "required": ["author"], "properties": {"author": {"type": "object", "additionalProperties": false, "required": ["first_name", "last_name"], "properties": {"first_name": {"type": "string", "default": "", "examples": ["Arnold"]}, "last_name": {"type": "string", "default": "", "examples": ["Schwarzenegger"]}, "middle_initial": {"type": "string", "default": "", "examples": ["T800"]}}}}}}, "bioproject": {"type": "string", "default": "", "examples": ["PRJ9999999"]}, "biosample": {"type": "string", "default": "", "examples": ["SAMN99999999"]}, "contact_info": {"type": "object", "additionalProperties": false, "required": ["organization", "department", "city", "country", "street", "email", "first_name", "last_name", "postal_code"], "properties": {"state": {"type": "string", "default": "", "examples": ["MD", "Florida"]}, "fax": {"type": "string", "default": "", "examples": ["301-555-1234", "+7 095 555 1234"]}, "city": {"type": "string", "default": "", "examples": ["Docker"]}, "country": {"type": "string", "default": "", "examples": ["Lappland"]}, "department": {"type": "string", "default": "", "examples": ["Department of Using NCBI"]}, "email": {"type": "string", "default": "", "examples": ["[email protected]"]}, "first_name": {"type": "string", "default": "", "examples": ["Jane"]}, "middle_initial": {"type": "string", "default": "", "examples": ["N"]}, "last_name": {"type": "string", "default": "", "examples": ["Doe"]}, "organization": {"type": "string", "default": "", "examples": ["Institute of Klebsiella foobarensis research"]}, "phone": {"type": "string", "default": "", "examples": ["301-555-0245"]}, "postal_code": {"type": "string", "default": "", "examples": ["12345"]}, "street": {"type": "string", "default": "", "examples": ["1234 Main St"]}}}, "fasta": {"type": "object", "additionalProperties": false, "properties": {"class": {"type": "string", "default": "", "examples": ["File"]}, "location": {"type": "string", "default": "", "examples": ["sample_fasta_input.fasta"]}}}, "locus_tag_prefix": {"type": "string", "default": "", "examples": ["tmp"]}, "organism": {"type": "object", "additionalProperties": false, "properties": {"strain": {"type": "string", "default": "", "examples": ["my_strain"]}, "genus_species": {"type": "string", "default": "", "examples": ["Escherichia coli"]}}}, "publications": {"type": "array", "items": {"type": "object", "additionalProperties": false, "required": ["publication"], "properties": {"publication": {"type": "object", "additionalProperties": false, "properties": {"authors": {"type": "array", "items": {"type": "object", "additionalProperties": false, "properties": {"author": {"type": "object", "additionalProperties": false, "required": ["first_name", "last_name"], "properties": {"first_name": {"type": "string", "default": "", "examples": ["Arnold"]}, "last_name": {"type": "string", "default": "", "examples": ["Schwarzenegger"]}, "middle_initial": {"type": "string", "default": "", "examples": ["T800"]}}}}}}, "status": {"type": "string", "default": "", "enum": ["published", "in-press", "unpublished"]}, "pmid": {"type": "integer", "default": ""}}}}}}, "topology": {"type": "string", "default": "", "examples": ["circular", "linear"]}, "location": {"type": "string", "default": "", "examples": ["chromosome", "plasmid"]}}, "required": ["authors", "contact_info"], "type": "object"}