Skip to content

Commit

Permalink
docs(self-hosted): recommend users to rerun install.sh for restart (#…
Browse files Browse the repository at this point in the history
…1255)

* docs(self-hosted): recommend users to rerun install.sh for restart

* docs(self-hosted): use stronger words for install.sh
  • Loading branch information
aldy505 committed May 13, 2024
1 parent b061714 commit 68ee307
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 4 deletions.
4 changes: 4 additions & 0 deletions src/docs/integrations/discord/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ discord.bot-token: "<bot token>"

After you update the <code>config.yml</code>, restart your Sentry server to continue the setup process.

<Alert title="Note" level="info">
After changing configuration files, re-run the <code>./install.sh</code> script, to rebuild and restart the containers. See the <Link to="/self-hosted/#configuration">configuration section</Link> for more information.
</Alert>

## Configure your Discord interactions endpoint

Now that Sentry is running and it knows your Discord credentials, we need to set up a way for Discord to interact with Sentry.
Expand Down
4 changes: 4 additions & 0 deletions src/docs/integrations/pagerduty.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,7 @@ pagerduty.app-id: 'PV5SD0T'
```

Restart your Sentry instance and follow our [documentation on configuring the PagerDuty integration](https://docs.sentry.io/product/integrations/pagerduty/) to use the integration.

<Alert title="Note" level="info">
After changing configuration files, re-run the <code>./install.sh</code> script, to rebuild and restart the containers. See the <Link to="/self-hosted/#configuration">configuration section</Link> for more information.
</Alert>
4 changes: 4 additions & 0 deletions src/docs/integrations/slack/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ slack.signing-secret: <signing secret>

After you update the <code>config.yml</code> you need to restart your Sentry server to continue configuring the Slack app.

<Alert title="Note" level="info">
After changing configuration files, re-run the <code>./install.sh</code> script, to rebuild and restart the containers. See the <Link to="/self-hosted/#configuration">configuration section</Link> for more information.
</Alert>

Now that you’ve created your app and updated your Sentry config, you can navigate to __Interactivity & Shortcuts__ under __Features__.

Toggle on __Interactivity__.
Expand Down
2 changes: 1 addition & 1 deletion src/docs/self-hosted/email.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: 'Self-Hosted Email'
---

<Alert title="Note" level="info">
Remember that you'd need to restart all Sentry services once you change your settings. See the <Link to="/self-hosted/#configuration">configuration section</Link> for more information.
After changing configuration files, re-run the <code>./install.sh</code> script, to rebuild and restart the containers. See the <Link to="/self-hosted/#configuration">configuration section</Link> for more information.
</Alert>

## Outbound Email
Expand Down
2 changes: 1 addition & 1 deletion src/docs/self-hosted/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ You very likely will want to adjust the default configuration for your Sentry in
You can find more about configuring Sentry at [the configuration section of our developer documentation](/config/).

<Alert title="Note" level="info">
Once you change your configuration, you'll need to restart all Sentry services by running <code>docker compose restart web worker cron sentry-cleanup</code> (or just <code>docker compose restart</code> to restart everything).
Once you change your configuration, it's highly recommended to re-run <code>./install.sh</code> script rather than restarting all services using <code>docker compose restart</code>. This ensures no other configuration or migrations that might be missing when something is toggled on.
</Alert>

### Enabling Preview Features
Expand Down
4 changes: 2 additions & 2 deletions src/docs/self-hosted/sso.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ auth-google.client-secret: '<client secret>'
```

<Alert title="Note" level="info">
Remember that you'd need to restart all Sentry services once you change your settings. See the <Link to="/self-hosted/#configuration">configuration section</Link> for more information.
After changing configuration files, re-run the <code>./install.sh</code> script, to rebuild and restart the containers. See the <Link to="/self-hosted/#configuration">configuration section</Link> for more information.
</Alert>

### GitHub Auth
Expand Down Expand Up @@ -118,7 +118,7 @@ github-login.client-secret: '<Client secret>'
This will also enable the [GitHub Integration](/integrations/github/) for your instance.

<Alert title="Note" level="info">
Remember that you'd need to restart all Sentry services once you change your settings. See the <Link to="/self-hosted/#configuration">configuration section</Link> for more information.
After changing configuration files, re-run the <code>./install.sh</code> script, to rebuild and restart the containers. See the <Link to="/self-hosted/#configuration">configuration section</Link> for more information.
</Alert>

### Custom Providers
Expand Down

0 comments on commit 68ee307

Please sign in to comment.