You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<!-- Use this checklist to make sure your PR is ready for merge. You may
delete any sections you don't need. -->
## DESCRIBE YOUR PR
- The permission change no longer works, due to Relay having a different
base docker container. I opted to use busybox to make the permission
change (with the new user/group id) to make it fully copy pastable, the
alternative would be a `sudo chown` from the host.
- Fixed the `$(pwd)` quoting, this would fail on paths with spaces.
- Switched the registry to ghcr.io as the dockerhub image is seemingly
deprecated
<img width="1165" height="131" alt="image"
src="https://github.com/user-attachments/assets/0e1ff9bc-0d71-4a42-946b-b45e13b44769"
/>
Fixes: INGEST-579
## PRE-MERGE CHECKLIST
*Make sure you've checked the following before merging your changes:*
- [x] Checked Vercel preview for correctness, including links
- [x] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [ ] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)
Copy file name to clipboardExpand all lines: docs/product/relay/getting-started.mdx
+18-22Lines changed: 18 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ Getting started with [Relay](/product/relay/) is as simple as using the default
9
9
<Alert>
10
10
11
11
The Relay server is called `relay`. Download binaries from [GitHub
12
-
Releases](https://github.com/getsentry/relay/releases). A Docker image is provided on [DockerHub](https://hub.docker.com/r/getsentry/relay/).
12
+
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).
13
13
14
14
</Alert>
15
15
@@ -30,18 +30,14 @@ container and copying in the files.
30
30
31
31
```shell {tabTitle:Run in Docker}
32
32
# Adjust permissions for the configuration directory
33
-
# The :z option is only necessary on selinux.
34
-
# See https://docs.docker.com/storage/bind-mounts/#configure-the-selinux-label.
35
-
docker run --rm -it \
36
-
-v $(pwd)/config/:/work/.relay/:z \
37
-
--entrypoint bash \
38
-
getsentry/relay \
39
-
-c 'chown -R relay:relay /work/.relay'
33
+
chown -R 65532:65532 ./config
40
34
41
35
# Generate the configuration
42
-
docker run --rm -it \
43
-
-v $(pwd)/config/:/work/.relay/:z \
44
-
getsentry/relay \
36
+
# The :z option is only necessary on selinux.
37
+
# See https://docs.docker.com/storage/bind-mounts/#configure-the-selinux-label.
38
+
docker run --rm -it \
39
+
-v "$(pwd)"/config/:/work/.relay/:z \
40
+
ghcr.io/getsentry/relay \
45
41
config init
46
42
```
47
43
@@ -128,9 +124,9 @@ To register Relay with Sentry:
128
124
1. Copy the contents of the public key, either by inspecting the `credentials.json` file or by running:
129
125
130
126
```shell {tabTitle:Run in Docker}
131
-
docker run --rm -it \
132
-
-v $(pwd)/config/:/work/.relay/ \
133
-
getsentry/relay \
127
+
docker run --rm -it \
128
+
-v "$(pwd)"/config/:/work/.relay/ \
129
+
ghcr.io/getsentry/relay \
134
130
credentials show
135
131
```
136
132
@@ -154,10 +150,10 @@ This process registers Relay with Sentry so it is ready to send messages. See
154
150
After registering Relay with Sentry, it is ready to run:
155
151
156
152
```shell {tabTitle:Run in Docker}
157
-
docker run --rm -it \
158
-
-v $(pwd)/config/:/work/.relay/ \
159
-
-p 3000:3000 \
160
-
getsentry/relay \
153
+
docker run --rm -it \
154
+
-v "$(pwd)"/config/:/work/.relay/ \
155
+
-p 3000:3000 \
156
+
ghcr.io/getsentry/relay \
161
157
run
162
158
```
163
159
@@ -181,10 +177,10 @@ Refer to the [Logging](../monitoring/#logging) page for more information on how
181
177
If you moved your config folder (for example, for security reasons), use the `--config` option to specify the location:
0 commit comments