Skip to main content
Version: Next

Where to download opscotch

opscotch is available for download as zip files or as docker images.

Download zip files​

Downloads for opscotch can be found on the opscotch github releases

There are 3 zip files to download (available for various operating systems):

  • agent
  • packager
  • test runner

Each zip file contains an executable which you will need to extract to your preferred location.

There is a beta program that you can message us asking to apply, just us the contact us form

Docker​

opscotch is available as a docker image.

Browse available packages here

There are two "latest" tags

  • latest is the latest prod agent
    • ghcr.io/opscotch/opscotch-agent:latest
  • latest-dev is the latest non-prod agent
    • ghcr.io/opscotch/opscotch-agent:latest-dev

Docker defaults​

By default the agent will run in the /config directory and attempt to load /config/bootstrap.json.

So long as you ensure your configs are in /config and there is a /config/bootstrap you can simply start the container.

Docker running from local filesystem​

To run docker against your local file system, where bootstrap.json is in the current directory you can do this:

docker \
    run \
    -v .:/config \
    ghcr.io/opscotch/opscotch-agent:latest-dev

Building a custom image from Dockerfile​

If you want to create your own image from a dockerfile perhaps for your prod deployment with a packaged opscotch app (assumes the bootstrap references my-opscotch.app), you can do something like this dockerfile:

FROM ghcr.io/opscotch/opscotch-agent:latest

COPY my-opscotch.bootstrap.json /config/bootstrap.json
COPY my-opscotch.app /config/my-opscotch.app

Docker configuration options​

Here is a list of the docker settings that can be set:

  • CONFIG_DIR

    • the working directory and the directory where configuration is expected
    • defaults to /config
    • when running locally, set with a volume mount:
      • -v .:/config
    • override with an environment variable:
      • -e "CONFIG_DIR=/new-config"

  • BOOTSTRAP_FILE

    • the bootstrap file that is passed to the agent
    • defaults to /${CONFIG_DIR}/bootstrap.json
    • override with an environment variable:
      • -e "BOOTSTRAP_FILE=new-bootstrap.json"

  • BOOTSTRAP_B64

    • the boostrap supplied as a base64 string. This takes precedence over the bootstrap file.
    • defaults to nothing
    • override with an environment variable:
      • -e "BOOTSTRAP_B64=...."

  • RESOURCE_DIR

    • this will set the RESOURCE_DIR environment variable for the agent to use.
    • defaults to nothing
    • when overriding, ensure the paths are present in the container by copying or mounting
    • override with an environment variable:
      • -e "RESOURCE_DIR=/resource1;/resource2"
    • note: it is common to mount your own app resources as well as the opscotch community resources:
      • -v ./app-resources:/app-resources
      • -v ./community-resources:/community-resources
      • -e "RESOURCE_DIR=/app-resources;/community-resources"

  • OPSCOTCH_OPTS

    • additional opscotch agent cli arguments