Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Studio docs #9955

Merged
merged 3 commits into from
Feb 2, 2024
Merged

Update Studio docs #9955

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0c2d419
Update Studio docs
Tobbe Feb 2, 2024
8afae30
expand on authImpersonation setting
Tobbe Feb 2, 2024
644783a
longer dash
Tobbe Feb 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .vscode/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,11 @@
"typescript.tsdk": "node_modules/typescript/lib",
"peacock.color": "#b85833",
"cSpell.words": [
"autoplay",
"execa",
"Fastify",
"graphiql",
"opentelemetry",
"pino",
"redwoodjs",
"RWJS"
Expand Down
55 changes: 35 additions & 20 deletions docs/docs/studio.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,27 +47,20 @@ yarn rw studio
The first time you run this command it will likely install the studio package which may take a small amount of time.

#### OpenTelemetry
If you want studio to pick up telemetry from you app automatically please ensure you've setup opentelemetry. A guide on this can be found [here](https://community.redwoodjs.com/t/opentelemetry-support-experimental/4772?u=josh-walker-gm)
If you want studio to pick up telemetry from you app automatically please ensure you've setup opentelemetry. A guide on this can be found [here](https://community.redwoodjs.com/t/opentelemetry-support-experimental/4772)

### Features
#### TOML
The following TOML options are now available which can control the studio behaviour.
```toml
[studio.graphiql.authImpersonation]
# authProvider = undefined (default value)
jwtSecret = 'secret'
# userId = undefined (default value)
# email = undefined (default value)
# roles = undefined (default value)
```

#### GraphiQL Auth Impersonation

You need to configure Studio using settings inside `redwood.toml` for auth
impersonation to work. See the sections below for detailed information.

##### DbAuth

Requires `SESSION_SECRET` envar for cookie encryption.
Requires a `SESSION_SECRET` environment variable for cookie encryption.

TOML example:
`redwood.toml` example:

```toml
[studio.graphiql.authImpersonation]
Expand All @@ -78,9 +71,11 @@ TOML example:

##### Netlify

Since Netlify does not expose the JWT secret used to sign the token in production, impersonation requires a `jwtSecret` to encode and decode the auth token.
Since Netlify does not expose the JWT secret used to sign the token in
production, impersonation requires a `jwtSecret` to encode and decode the auth
token.

TOML example:
`redwood.toml` example:

```toml
[studio.graphiql.authImpersonation]
Expand All @@ -92,9 +87,9 @@ TOML example:

##### Supabase

Requires `SUPABASE_JWT_SECRET` envar for JWT signing.
Requires a `SUPABASE_JWT_SECRET` environment variable for JWT signing.

TOML example:
`redwood.toml` example:

```toml
[studio.graphiql.authImpersonation]
Expand All @@ -103,8 +98,28 @@ TOML example:
userId = "1"
```

#### Database File
Studio stores the ingested telemetry to `studio/prisma.db` within the `.redwood` folder. You should not need to touch this file other than if you wish to delete it to erase any existing telemetry data.
### Settings

All settings for Studio are located in `redwood.toml`, which you can find at
the root of your Redwood project.

* `[studio.graphiql.authImpersonation].*` – Used to gain access to GraphQL
endpoints that require authentication. See section above on auth
impersonation for more details.
* `[studio].basePort` – Studio's web front-end will run on this port (default:
4318). It is also used to calculate the port for the mailer integration and
other things. Please choose a port that is not already in use, and that has a
few more free ports available next to it.

### Database File
Studio stores the ingested telemetry to `studio/prisma.db` within the
`.redwood` folder. You should not need to touch this file other than if you
wish to delete it to erase any existing telemetry data.

## Availability
The setup command is currently available from the `canary` version of Redwood. You can try this out in a new project by running `yarn rw upgrade --tag canary` and following any general upgrade steps recommend on the [forums](https://community.redwoodjs.com/c/announcements/releases-and-upgrade-guides/18).
Along the release of Redwood v7, Studio has been rewritten and is available as
a stable version. Just run `yarn rw studio` to start it! Prior to RW v7 Studio
was available as an experimental feature. If you're still not using the stable
version of RW v7, see this forum topic for information on the old experimental
version of Studio
https://community.redwoodjs.com/t/redwood-studio-experimental/4771
Loading