Add docker-compose instructions

[dcramer]

Easy way to utilize the sidecar in a random project is just adding it to a docker-compose.yml.

We should add a simple snippet for that so folks can copypasta.

e.g.

version: "3.7"
services:
  spotlight:
    image: ghcr.io/getsentry/spotlight:latest
    restart: on-failure
    ports:
      - "8969:8969"

[michael-skovik]

Is there any way to configure spotlight/sidecar through docker compose? I am trying to change the sidecar url but it does not seem possible through e.g ENV variables when looking through the code.

[Shubhdeep12]

hey @michael-skovik i think this might help you - https://spotlightjs.com/sidecar/docker/#_top:~:text=If%20you%E2%80%99re%20already%20using%20Docker%20Compose%2C%20we%20recommend%20adding%20Spotlight%20to%20your%20docker%2Dcompose.yml%20file%3A

[michael-skovik]

@Shubhdeep12 I don't have any problem getting sidecar to run in Docker. It is just that I would want it to serve on another URL than localhost:8969 (which is controlled by sidecarUrl set during init()). If it already is possible to configure sidecar with Docker, it would be nice if it was detailed in the docs.

[BYK]

@michael-skovik we support SENTRY_SPOTLIGHT env variable for Python, Node, Ruby, and PHP SDKs. Which SDK are you using?

[BYK]

Closing as I think https://spotlightjs.com/sidecar/docker/#docker-compose serves the purpose now.