Configuration

The Tivet configuration file can use any of the follow names:

Name	Format
tivet.json	JSON
tivet.json	JSON with comments (JSONC)

---

Schema

Config

• buildsmap

  • builds[key].accessstring

    • public

    • private

  • builds[key].tagsnullable map

  • Any of the following variants:

    • Variant #1

      • builds[key].build_argsnullable map

        Build arguments to pass to the build.

      • builds[key].build_pathnullable string

        Directory to build the Docker image from.

      • builds[key].build_targetnullable string

        Build target to upload.

      • builds[key].dockerfilenullable string

        Dockerfile to build.

      • builds[key].imagenullable string

        Existing image tag to upload.

      • builds[key].unstablenullable object

        • builds[key].unstable.allow_rootnullable boolean

        • builds[key].unstable.build_methodnullable string

          • buildx

            Use the native Docker build command. Only used if Buildx is not available.

          • native

            Create & use a Buildx builder on this machine. Required for cross-platform compilation.

        • builds[key].unstable.bundlenullable string

          • docker_image

            Legacy option. Docker image archive output from docker save. Slower lobby start times.

          • oci_bundle

            OCI bundle archive derived from a generated Docker image. Optimized for fast lobby start times.

        • builds[key].unstable.compressionnullable string

          • none

            No compression.

          • lz4

            LZ4 compression. Fast compression optimized for fast lobby start times.

    • Variant #2

      • builds[key].scriptstring

      • builds[key].unstablenullable object

        • builds[key].unstable.analyze_resultnullable boolean

        • builds[key].unstable.compressionnullable string

          • none

            No compression.

          • lz4

            LZ4 compression. Fast compression optimized for fast lobby start times.

        • builds[key].unstable.dump_buildnullable boolean

        • builds[key].unstable.esbuild_log_levelnullable string

        • builds[key].unstable.minifynullable boolean

        • builds[key].unstable.no_bundlernullable boolean

• unstablenullable object

  • unstable.managernullable object

    • unstable.manager.analyze_resultnullable boolean

    • unstable.manager.compressionnullable string

      • none

        No compression.

      • lz4

        LZ4 compression. Fast compression optimized for fast lobby start times.

    • unstable.manager.dump_buildnullable boolean

    • unstable.manager.enablenullable boolean

    • unstable.manager.esbuild_log_levelnullable string

    • unstable.manager.minifynullable boolean

    • unstable.manager.no_bundlernullable boolean