diff --git a/docs/product/relay/getting-started.mdx b/docs/product/relay/getting-started.mdx index 1eddbe93d7565..bc18dfc095a85 100644 --- a/docs/product/relay/getting-started.mdx +++ b/docs/product/relay/getting-started.mdx @@ -9,7 +9,7 @@ Getting started with [Relay](/product/relay/) is as simple as using the default The Relay server is called `relay`. Download binaries from [GitHub -Releases](https://github.com/getsentry/relay/releases). A Docker image is provided on [DockerHub](https://hub.docker.com/r/getsentry/relay/). +Releases](https://github.com/getsentry/relay/releases). A Docker image is provided on the [Github Container Registry](https://github.com/getsentry/relay/pkgs/container/relay). @@ -30,18 +30,14 @@ container and copying in the files. ```shell {tabTitle:Run in Docker} # Adjust permissions for the configuration directory -# The :z option is only necessary on selinux. -# See https://docs.docker.com/storage/bind-mounts/#configure-the-selinux-label. -docker run --rm -it \ - -v $(pwd)/config/:/work/.relay/:z \ - --entrypoint bash \ - getsentry/relay \ - -c 'chown -R relay:relay /work/.relay' +chown -R 65532:65532 ./config # Generate the configuration -docker run --rm -it \ - -v $(pwd)/config/:/work/.relay/:z \ - getsentry/relay \ +# The :z option is only necessary on selinux. +# See https://docs.docker.com/storage/bind-mounts/#configure-the-selinux-label. +docker run --rm -it \ + -v "$(pwd)"/config/:/work/.relay/:z \ + ghcr.io/getsentry/relay \ config init ``` @@ -128,9 +124,9 @@ To register Relay with Sentry: 1. Copy the contents of the public key, either by inspecting the `credentials.json` file or by running: ```shell {tabTitle:Run in Docker} - docker run --rm -it \ - -v $(pwd)/config/:/work/.relay/ \ - getsentry/relay \ + docker run --rm -it \ + -v "$(pwd)"/config/:/work/.relay/ \ + ghcr.io/getsentry/relay \ credentials show ``` @@ -154,10 +150,10 @@ This process registers Relay with Sentry so it is ready to send messages. See After registering Relay with Sentry, it is ready to run: ```shell {tabTitle:Run in Docker} -docker run --rm -it \ - -v $(pwd)/config/:/work/.relay/ \ - -p 3000:3000 \ - getsentry/relay \ +docker run --rm -it \ + -v "$(pwd)"/config/:/work/.relay/ \ + -p 3000:3000 \ + ghcr.io/getsentry/relay \ run ``` @@ -181,10 +177,10 @@ Refer to the [Logging](../monitoring/#logging) page for more information on how If you moved your config folder (for example, for security reasons), use the `--config` option to specify the location: ```shell {tabTitle:Run in Docker} -docker run --rm -it \ - -v $(pwd)/config/:/etc/relay/ \ - -p 3000:3000 \ - getsentry/relay \ +docker run --rm -it \ + -v "$(pwd)"/config/:/etc/relay/ \ + -p 3000:3000 \ + ghcr.io/getsentry/relay \ run --config /etc/relay/ ```