diff --git a/docs/platforms/unreal/configuration/debug-symbols/img/unreal-debug-symbols.png b/docs/platforms/unreal/configuration/debug-symbols/img/unreal-debug-symbols.png index 0bff09003b3a7..ef0dfebec29ec 100644 Binary files a/docs/platforms/unreal/configuration/debug-symbols/img/unreal-debug-symbols.png and b/docs/platforms/unreal/configuration/debug-symbols/img/unreal-debug-symbols.png differ diff --git a/docs/platforms/unreal/configuration/debug-symbols/index.mdx b/docs/platforms/unreal/configuration/debug-symbols/index.mdx index fe3c3c8ce04af..86b548bfab0ec 100644 --- a/docs/platforms/unreal/configuration/debug-symbols/index.mdx +++ b/docs/platforms/unreal/configuration/debug-symbols/index.mdx @@ -11,19 +11,37 @@ For Android, debug symbols upload is handled by [Sentry Android Gradle Plugin](/ -The automated debug symbols upload is disabled by default and requires configuration. To configure it, navigate to **Project Settings > Plugins > Sentry**, then enter the [Auth Token](https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/), Organization Slug, and Project Name. Note, that the Unreal Engine SDK automatically creates a `sentry.properties` file at the root of your project directory to store the configuration. This configuration file should **never** be made publicly available. +## Automatic Upload + +The automated debug symbols upload is disabled by default and requires configuration. To configure it, navigate to **Project Settings > Plugins > Sentry**, then enable "Upload debug symbols automatically". + +Alternatively, debug symbol upload can be enabled by setting the `SENTRY_UPLOAD_SYMBOLS_AUTOMATICALLY` environment variable to `True`. This can be especially helpful in CI/CD environments where manual configuration is impractical. -You must configure which build configurations, target types, and platforms Sentry will upload debug symbols for in the "Misc" section of the plugin settings. +Sentry will upload debug symbols only for build configurations and target types that are enabled in the "Misc" section of the plugin settings. ![The Unreal Engine debug symbols upload configuration](./img/unreal-debug-symbols.png) -Alternatively, debug symbol upload can be enabled by setting the `SENTRY_UPLOAD_SYMBOLS_AUTOMATICALLY` environment variable to `True`. This can be especially helpful in CI/CD environments where manual configuration is impractical. +The `sentry-cli` require you to specify the organization and project to work with as well as a token to authenticate with Sentry. The Unreal Engine SDK provides two ways to configure these settings - either by using a properties file (default) or environment variables. + +### Properties File + +To configure the `sentry-cli` using properties file enter the [Auth Token](https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/), Organization Slug, and Project Name. Note, that the Unreal Engine SDK automatically creates a `sentry.properties` file at the root of your project directory to store the configuration. This configuration file should **never** be made publicly available. + +### Environment Variables + +The `sentry-cli` can be configured by setting the following environment variables which will be automatically picked up during the debug symbol upload if the properties file is not found: + +```bash +export SENTRY_ORG=___ORG_SLUG___ +export SENTRY_PROJECT=___PROJECT_SLUG___ +export SENTRY_AUTH_TOKEN=___ORG_AUTH_TOKEN___ +``` -### Manual Upload Using sentry-cli +## Manual Upload Using sentry-cli To upload debug symbols to Sentry manually, run `sentry-cli` through the command line. You can either use the provided executables from within the package, or follow the [sentry-cli documentation](/cli/installation/) to make it available globally. To upload debug symbols run the following command: