From 0f7edd9ebf3fd43b13b8018aac74235a32aee583 Mon Sep 17 00:00:00 2001 From: s1gr1d <32902192+s1gr1d@users.noreply.github.com> Date: Thu, 19 Feb 2026 16:13:18 +0100 Subject: [PATCH] docs(nuxt): Remove duplicated setup instructions --- packages/nuxt/README.md | 100 +--------------------------------------- 1 file changed, 2 insertions(+), 98 deletions(-) diff --git a/packages/nuxt/README.md b/packages/nuxt/README.md index eae1b36b03e5..b7978c288ffd 100644 --- a/packages/nuxt/README.md +++ b/packages/nuxt/README.md @@ -13,9 +13,9 @@ This SDK is for [Nuxt](https://nuxt.com/). If you're using [Vue](https://vuejs.org/) see our [Vue SDK here](https://github.com/getsentry/sentry-javascript/tree/develop/packages/vue). -## Links +## Setup Instructions and Documentation -- [Official Nuxt SDK Docs](https://docs.sentry.io/platforms/javascript/guides/nuxt/) +Check out the [Official Nuxt SDK Docs](https://docs.sentry.io/platforms/javascript/guides/nuxt/) for further information on configuration and usage. ## Compatibility @@ -26,102 +26,6 @@ The minimum supported version of Nuxt is `3.7.0` (`3.14.0+` recommended). This package is a wrapper around `@sentry/node` for the server and `@sentry/vue` for the client side, with added functionality related to Nuxt. -## Manual Setup - -### 1. Prerequisites & Installation - -1. Install the Sentry Nuxt SDK: - - ```bash - # Using npm - npm install @sentry/nuxt - - # Using yarn - yarn add @sentry/nuxt - ``` - -### 2. Nuxt Module Setup - -The Sentry Nuxt SDK is based on [Nuxt Modules](https://nuxt.com/docs/api/kit/modules). - -1. Add `@sentry/nuxt/module` to the modules section of `nuxt.config.ts`: - -```javascript -// nuxt.config.ts -export default defineNuxtConfig({ - modules: ['@sentry/nuxt/module'], -}); -``` - -### 3. Client-side setup - -Add a `sentry.client.config.ts` file to the root of your project: - -```javascript -import { useRuntimeConfig } from '#imports'; -import * as Sentry from '@sentry/nuxt'; - -Sentry.init({ - // If set up, you can use your runtime config here - dsn: useRuntimeConfig().public.sentry.dsn, -}); -``` - -### 4. Server-side setup - -Add a `sentry.server.config.ts` file to the root of your project: - -```javascript -import * as Sentry from '@sentry/nuxt'; - -// Only run `init` when process.env.SENTRY_DSN is available. -if (process.env.SENTRY_DSN) { - Sentry.init({ - dsn: 'your-dsn', - }); -} -``` - -Using `useRuntimeConfig` does not work in the Sentry server config file due to technical reasons (the file has to be -loaded before Nuxt is loaded). To be able to use `process.env` you either have to add `--env-file=.env` to your node -command - -```bash -node --env-file=.env .output/server/index.mjs -``` - -or use the `dotenv` package: - -```javascript -import dotenv from 'dotenv'; -import * as Sentry from '@sentry/nuxt'; - -dotenv.config(); - -Sentry.init({ - dsn: process.env.SENTRY_DSN, -}); -``` - -## Uploading Source Maps - -To upload source maps, you have to enable client source maps in your `nuxt.config.ts`. Then, you add your project -settings to `sentry` in your `nuxt.config.ts`: - -```javascript -// nuxt.config.ts -export default defineNuxtConfig({ - sourcemap: { client: 'hidden' }, - - modules: ['@sentry/nuxt/module'], - sentry: { - org: 'your-org-slug', - project: 'your-project-slug', - authToken: process.env.SENTRY_AUTH_TOKEN, - }, -}); -``` - ## Troubleshoot If you encounter any issues with error tracking or integrations, refer to the official [Sentry Nuxt SDK documentation](https://docs.sentry.io/platforms/javascript/guides/nuxt/). If the documentation does not provide the necessary information, consider opening an issue on GitHub.