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
Copy file name to clipboardExpand all lines: develop-docs/development-infrastructure/environment/index.mdx
+20-10Lines changed: 20 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
---
2
2
title: Environment
3
-
description: This guide steps you through configuring a local development environment for the Sentry server on macOS and Linux.
3
+
description: This guide steps you through configuring a local development environment for the Sentry server on macOS.
4
4
sidebar_order: 2
5
5
---
6
6
7
-
If you're using
8
-
another operating system (Plan 9, BeOS, Windows, …) the instructions are still roughly the same, but we don't maintain any official documentation
9
-
for anything else for now.
7
+
We primarily support development on macOS (arm64 only), but Linux (amd64) should be possible too.
8
+
If you run into any problems on either platform, please open an issue on [devenv](https://github.com/getsentry/devenv/).
9
+
10
10
11
11
## Setup
12
12
@@ -16,11 +16,17 @@ After installation you should be able to run `devenv bootstrap` which will guide
16
16
17
17
When you're done with setup, you'll want to also review the <Linkto="/development/workflow/">development workflow</Link>.
18
18
19
+
19
20
## Keeping your environment up-to-date
20
21
21
-
Simply run `devenv sync` inside of your sentry or getsentry repo.
22
+
First make sure your branch is rebased or remerged onto latest `master`.
23
+
24
+
Running `devenv sync` (which runs `devenv/sync.py`) will bring your environment up-to-date (dependencies, migrations, etc.).
25
+
26
+
You may also need to run `direnv allow` if you haven't already (sometimes it's easy to miss the prompt).
27
+
28
+
Any issues? See [troubleshooting](#troubleshooting).
22
29
23
-
NOTE: After running `devenv sync` you may need to restart your terminal to continue.
24
30
25
31
## Running the Development Server
26
32
@@ -94,9 +100,11 @@ After the server is running we can visit the dev server using `https` at port `:
94
100
95
101
See also: <Linkto="/application/sentry-vs-getsentry/">Sentry vs Getsentry</Link>
96
102
97
-
Before running `getsentry`, you might need to run `devenv sync` inside the `getsentry` directory if you have previously run `sentry` locally, as there might be differences between the environments.
103
+
To set up and keep getsentry up to date, you need to run `devenv sync` inside `sentry` before you run `devenv sync` inside `getsentry`.
104
+
105
+
`getsentry` depends on what commit `../sentry` is checked out to, so keeping your sentry repo up to date is important.
98
106
99
-
Just like running `sentry` (see above), you can start the `devservices` using the following command in the `getsentry`folder:
107
+
Just like running `sentry` (see above), you can start the `devservices` using the following command in the `getsentry`repo:
100
108
101
109
```shell
102
110
devservices up
@@ -120,7 +128,9 @@ After that, you can start the development server inside the `getsentry` folder:
120
128
devservices serve
121
129
```
122
130
123
-
**Note**: You **cannot** have both sentry and getsentry devserver running at the same time.
131
+
<Alerttitle="Note">
132
+
You **cannot** have both sentry and getsentry devserver running at the same time.
133
+
</Alert>
124
134
125
135
After the server warms up, access it at [http://dev.getsentry.net:8000](http://dev.getsentry.net:8000/). Using localhost won't work. Note that the **http** protocol is used, not **https**. If you encounter a certificate error while accessing it locally, it might be because your browser has remembered that `dev.getsentry.net` previously used the https protocol (possibly while running `pnpm dev-ui`) and is now redirecting all http requests to https. To resolve this, open the site in an **incognito window** of your browser.
The more up-to-date troubleshooting docs for the internal development environment on MacOS are <Linkto="https://www.notion.so/sentry/devenv-troubleshooting-1448b10e4b5d8080ba04f452e33de48d">here</Link>.
188
+
The more up-to-date troubleshooting docs for the _internal_ development environment on MacOS are <Linkto="https://www.notion.so/sentry/devenv-troubleshooting-1448b10e4b5d8080ba04f452e33de48d">here</Link>.
179
189
180
190
You might also be interested in <Linkto="/development/continuous-integration/#troubleshooting-ci">Troubleshooting CI</Link>.
0 commit comments