Skip to main content

18 docs tagged with "recipe"

View all tags

Add Metadata

Use to fill in `x-fibe.gg.metadata.description`, `category`, `source_defaults`, and execution settings such as `job_mode`, `schedule_config`, and `trigger_config`.

Add Path Rule

Use to write `fibe.gg/path_rule` Traefik path matchers (`Path`, `PathPrefix`, `PathRegexp`) when multiple services share a subdomain. Avoid forbidden matchers.

Add Subdomain

Use to set the public hostname leftmost label via `fibe.gg/subdomain` - including the root `@`, defaults, allowed character set, and variable interpolation.

Anchors And Aliases

Use YAML anchors (`&name`) and aliases (`*name`) to share `depends_on`, `environment`, `build`, healthcheck, or label blocks across multiple Fibe services without copy-paste.

Build Args And Target

Use to map Compose `build.args` / `build.target` into Fibe `fibe.gg/build_args` (comma-separated KEY=value) and `fibe.gg/build_target`. Includes variable interpolation and parsing rules.

Build To Repo Url

Use to convert a Compose `build:` block into Fibe dynamic-service labels (`fibe.gg/repo_url`, `fibe.gg/dockerfile`, `fibe.gg/branch`) so Fibe clones, builds, and rolls out the service.

Configs Block

Use Docker Compose top-level `configs:` to inline small config files (init scripts, conf templates) without bind-mounting from the host. Distinct from Fibe Mounted Files.

Depends On

Use Compose `depends_on` with `condition: service_healthy` / `service_completed_successfully` / `service_started` to order service startup correctly in Fibe templates.

Env File

Use to set `fibe.gg/env_file` for dynamic services so Fibe knows which example env file in the repo to read defaults from. Covers the difference between Compose `env_file:` and Fibe `fibe.gg/env_file`.

Extract Env Variables

Use to lift `${VAR}` / `${VAR:-default}` Compose interpolations into `x-fibe.gg.variables` so the launcher can configure them, with optional defaults, validation, and path bindings.

Inline Variables

Use to embed `$$var__NAME` (and `$$random__NAME`) inside Compose string values, label values, image tags, URLs, and partial strings - and to understand when the inline form is required vs optional.

Named Volumes

Use to declare Compose named volumes for persistent data (databases, uploads, caches), and to replace host bind mounts that don't survive Marquee filesystem rules.

Ports To Expose

Use to convert Compose `ports:` declarations into `fibe.gg/expose` labels for public/internal HTTP routing through Traefik.

Random And Secrets

Use to generate random values for passwords/secrets via `random: true`, mark variables sensitive for launcher UI, and persist them across rollouts in Fibe templates.

Source Mount

Use to set up Fibe live source mounting via `fibe.gg/source_mount` plus `fibe.gg/repo_url` and `fibe.gg/production: false`, including framework-specific dev/watch commands and the rules around `node_modules` and build artifacts.

Strip Incompatible Keys

Use to know which Compose keys to delete or rewrite when converting to a Fibe template - `ports`, `container_name`, `hostname`, host-path bind mounts, and Compose-only directives that conflict with Fibe routing/scaling.

Whole Node Paths

Use to bind a variable to a whole YAML node (env scalar, label value, replica count, image, command element) via `path:` or `paths:`. Includes typing, multiple paths, and label-key path patterns.

Zero Downtime Healthcheck

Use to tune the five optional `fibe.gg/healthcheck_*` labels for `fibe.gg/zerodowntime: "true"`. Covers path, interval, timeout, retries, and start_period with realistic values.