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].buildArgs
          nullable map

          Build arguments to pass to the build.

        • actors[key].buildPath
          nullable string

          Directory to build the Docker image from.

        • actors[key].buildTarget
          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.allowRoot
            nullable boolean
          • actors[key].unstable.buildMethod
            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.

            • remote

              Use Rivet Cloud for building.

          • actors[key].unstable.bundle
            nullable string
            • dockerImage

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

            • ociBundle

              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.analyzeResult
            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.dumpBuild
            nullable boolean
          • actors[key].unstable.esbuildLogLevel
            nullable string
          • actors[key].unstable.minify
            nullable boolean
          • actors[key].unstable.noBundler
            nullable boolean
  • containers
    nullable map
    • containers[key].tags
      nullable map

    • Any of the following variants:

      • Variant #1

        • containers[key].buildArgs
          nullable map

          Build arguments to pass to the build.

        • containers[key].buildPath
          nullable string

          Directory to build the Docker image from.

        • containers[key].buildTarget
          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.allowRoot
            nullable boolean
          • containers[key].unstable.buildMethod
            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.

            • remote

              Use Rivet Cloud for building.

          • containers[key].unstable.bundle
            nullable string
            • dockerImage

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

            • ociBundle

              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.analyzeResult
            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.dumpBuild
            nullable boolean
          • containers[key].unstable.esbuildLogLevel
            nullable string
          • containers[key].unstable.minify
            nullable boolean
          • containers[key].unstable.noBundler
            nullable boolean
  • functions
    nullable map
    • functions[key].networking
      nullable object
      • functions[key].networking.internalPort
        nullable integer
    • functions[key].path
      nullable string
    • functions[key].resources
      nullable object
      • functions[key].resources.cpu
        integer
      • functions[key].resources.memory
        integer
    • functions[key].routeSubpaths
      nullable boolean
    • functions[key].runtime
      nullable object
      • functions[key].runtime.environment
        nullable map
    • functions[key].stripPrefix
      nullable boolean
    • functions[key].tags
      nullable map

    • Any of the following variants:

      • Variant #1

        • functions[key].buildArgs
          nullable map

          Build arguments to pass to the build.

        • functions[key].buildPath
          nullable string

          Directory to build the Docker image from.

        • functions[key].buildTarget
          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.allowRoot
            nullable boolean
          • functions[key].unstable.buildMethod
            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.

            • remote

              Use Rivet Cloud for building.

          • functions[key].unstable.bundle
            nullable string
            • dockerImage

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

            • ociBundle

              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.analyzeResult
            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.dumpBuild
            nullable boolean
          • functions[key].unstable.esbuildLogLevel
            nullable string
          • functions[key].unstable.minify
            nullable boolean
          • functions[key].unstable.noBundler
            nullable boolean
  • rivetkit
    nullable object
    • rivetkit.buildArgs
      nullable map

      Build arguments to pass to the build.

    • rivetkit.buildPath
      nullable string

      Directory to build the Docker image from.

    • rivetkit.buildTarget
      nullable string

      Build target to upload.

    • rivetkit.dockerfile
      nullable string

      Dockerfile to build.

    • rivetkit.image
      nullable string

      Existing image tag to upload.

    • rivetkit.networking
      nullable object
      • rivetkit.networking.internalPort
        nullable integer
    • rivetkit.path
      nullable string
    • rivetkit.registry
      string
    • rivetkit.resources
      nullable object
      • rivetkit.resources.cpu
        integer
      • rivetkit.resources.memory
        integer
    • rivetkit.routeSubpaths
      nullable boolean
    • rivetkit.runtime
      nullable object
      • rivetkit.runtime.environment
        nullable map
    • rivetkit.server
      string
    • rivetkit.stripPrefix
      nullable boolean
    • rivetkit.tags
      nullable map
    • rivetkit.unstable
      nullable object
      • rivetkit.unstable.allowRoot
        nullable boolean
      • rivetkit.unstable.buildMethod
        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.

        • remote

          Use Rivet Cloud for building.

      • rivetkit.unstable.bundle
        nullable string
        • dockerImage

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

        • ociBundle

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

      • rivetkit.unstable.compression
        nullable string
        • none

          No compression.

        • lz4

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

Suggest changes to this page