Sign In
Reference

Config

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

NameFormat
rivet.jsonJSON
rivet.jsoncJSON with comments (JSONC)

Schema

Config

  • actors
    nullable map
    • actors[key].tags
      nullable map

    • Any of the following variants:

      • Variant #1

        • actors[key].build_args
          nullable map

          Build arguments to pass to the build.

        • actors[key].build_path
          nullable string

          Directory to build the Docker image from.

        • actors[key].build_target
          nullable string

          Build target to upload.

        • actors[key].dockerfile
          nullable string

          Dockerfile to build.

        • actors[key].image
          nullable string

          Existing image tag to upload.

        • actors[key].unstable
          nullable object
          • actors[key].unstable.allow_root
            nullable boolean
          • actors[key].unstable.build_method
            nullable 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.

          • actors[key].unstable.bundle
            nullable 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.

          • actors[key].unstable.compression
            nullable string
            • none

              No compression.

            • lz4

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

      • Variant #2

        • actors[key].script
          string
        • actors[key].unstable
          nullable object
          • actors[key].unstable.analyze_result
            nullable boolean
          • actors[key].unstable.compression
            nullable string
            • none

              No compression.

            • lz4

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

          • actors[key].unstable.dump_build
            nullable boolean
          • actors[key].unstable.esbuild_log_level
            nullable string
          • actors[key].unstable.minify
            nullable boolean
          • actors[key].unstable.no_bundler
            nullable boolean
  • containers
    nullable map
    • containers[key].tags
      nullable map

    • Any of the following variants:

      • Variant #1

        • containers[key].build_args
          nullable map

          Build arguments to pass to the build.

        • containers[key].build_path
          nullable string

          Directory to build the Docker image from.

        • containers[key].build_target
          nullable string

          Build target to upload.

        • containers[key].dockerfile
          nullable string

          Dockerfile to build.

        • containers[key].image
          nullable string

          Existing image tag to upload.

        • containers[key].unstable
          nullable object
          • containers[key].unstable.allow_root
            nullable boolean
          • containers[key].unstable.build_method
            nullable 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.

          • containers[key].unstable.bundle
            nullable 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.

          • containers[key].unstable.compression
            nullable string
            • none

              No compression.

            • lz4

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

      • Variant #2

        • containers[key].script
          string
        • containers[key].unstable
          nullable object
          • containers[key].unstable.analyze_result
            nullable boolean
          • containers[key].unstable.compression
            nullable string
            • none

              No compression.

            • lz4

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

          • containers[key].unstable.dump_build
            nullable boolean
          • containers[key].unstable.esbuild_log_level
            nullable string
          • containers[key].unstable.minify
            nullable boolean
          • containers[key].unstable.no_bundler
            nullable boolean
  • functions
    nullable map
    • functions[key].networking
      nullable object
      • functions[key].networking.internal_port
        nullable integer
    • functions[key].path
      nullable string
    • functions[key].resources
      nullable object
      • functions[key].resources.cpu
        integer
      • functions[key].resources.memory
        integer
    • functions[key].route_subpaths
      nullable boolean
    • functions[key].strip_prefix
      nullable boolean
    • functions[key].tags
      nullable map

    • Any of the following variants:

      • Variant #1

        • functions[key].build_args
          nullable map

          Build arguments to pass to the build.

        • functions[key].build_path
          nullable string

          Directory to build the Docker image from.

        • functions[key].build_target
          nullable string

          Build target to upload.

        • functions[key].dockerfile
          nullable string

          Dockerfile to build.

        • functions[key].image
          nullable string

          Existing image tag to upload.

        • functions[key].unstable
          nullable object
          • functions[key].unstable.allow_root
            nullable boolean
          • functions[key].unstable.build_method
            nullable 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.

          • functions[key].unstable.bundle
            nullable 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.

          • functions[key].unstable.compression
            nullable string
            • none

              No compression.

            • lz4

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

      • Variant #2

        • functions[key].script
          string
        • functions[key].unstable
          nullable object
          • functions[key].unstable.analyze_result
            nullable boolean
          • functions[key].unstable.compression
            nullable string
            • none

              No compression.

            • lz4

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

          • functions[key].unstable.dump_build
            nullable boolean
          • functions[key].unstable.esbuild_log_level
            nullable string
          • functions[key].unstable.minify
            nullable boolean
          • functions[key].unstable.no_bundler
            nullable boolean
Suggest changes to this page