Skip to content

Commit 672d356

Browse files
authored
Update docs on running getsentry locally (#11428)
* update docs * revert formatting change ---------
1 parent baff297 commit 672d356

File tree

1 file changed

+7
-8
lines changed
  • develop-docs/development/environment

1 file changed

+7
-8
lines changed

develop-docs/development/environment/index.mdx

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,12 @@ After installation you should be able to run `devenv bootstrap` which will guide
1616

1717
When you're done with setup, you'll want to also review the <Link to="/development/workflow/">development workflow</Link>.
1818

19-
2019
## Keeping your environment up-to-date
2120

2221
Simply run `devenv sync` inside of your sentry or getsentry repo.
2322

2423
NOTE: After running `devenv sync` you may need to restart your terminal to continue.
2524

26-
2725
## Running the Development Server
2826

2927
The `devservices` ensure that you have all the services required for local development running. See the [devservices docs](/services/devservices/) for more information on managing services.
@@ -108,6 +106,8 @@ sentry devservices up snuba
108106

109107
See also: <Link to="/sentry-vs-getsentry/">Sentry vs Getsentry</Link>
110108

109+
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.
110+
111111
Just like running `sentry` (see above), you can start the `devservices` using the following command in the `getsentry` folder:
112112

113113
```shell
@@ -122,26 +122,24 @@ getsentry devserver --workers
122122

123123
**Note**: You **cannot** have both sentry and getsentry devserver running at the same time.
124124

125-
After the server warms up for a little while, you must access it
126-
at [http://dev.getsentry.net:8000](http://dev.getsentry.net:8000/).
127-
Using localhost doesn't work.
125+
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 `yarn dev-ui`) and is now redirecting all http requests to https. To resolve this, open the site in an **incognito window** of your browser.
128126

129127
If you need to overwrite configuration options for your local
130128
environment, you can create `getsentry/conf/settings/devlocal.py` and put the
131129
configuration option overrides there. This module will be automatically imported
132130
by `dev.py` if it exists.
133131

134132
To enable the ingest workers, follow the steps described <Link to="#ingestion-pipeline-relay">here</Link> and run
133+
135134
```shell
136135
getsentry devserver --workers --ingest
137136
```
138137

139-
140138
## Running siloed instances
141139

142-
By default `sentry devserver` will run a monolith mode application server. You can also run ``devserver`` with siloed application instances. Before you do, you need to <Link to="/database-migrations/#cloning-a-monolith-database">create split silo databases</Link>.
140+
By default `sentry devserver` will run a monolith mode application server. You can also run `devserver` with siloed application instances. Before you do, you need to <Link to="/database-migrations/#cloning-a-monolith-database">create split silo databases</Link>.
143141

144-
The devserver command supports `--silo` option that lets you create siloed instances. Any workers, consumers, or celery-beat processes will be started with the same silo mode.
142+
The devserver command supports `--silo` option that lets you create siloed instances. Any workers, consumers, or celery-beat processes will be started with the same silo mode.
145143

146144
```shell
147145
# Start control silo servers
@@ -150,6 +148,7 @@ sentry devserver --silo=control --celery-beat --workers
150148
# Start region silo servers
151149
sentry devserver --silo=region --celery-beat --workers --ingest
152150
```
151+
153152
Siloed servers have the following port assignments:
154153

155154
- 8000 - Webpack

0 commit comments

Comments
 (0)