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.

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

Rafiki Admin UI Errors When Running Directly via pnpm dev #3110

Open
JoblersTune opened this issue Nov 20, 2024 · 0 comments
Open

Rafiki Admin UI Errors When Running Directly via pnpm dev #3110

JoblersTune opened this issue Nov 20, 2024 · 0 comments
Labels
pkg: frontend Changes in the frontend package.

Comments

@JoblersTune
Copy link
Collaborator

JoblersTune commented Nov 20, 2024

Currently, Rafiki offers two different ways to spin up the local playground using Docker Compose:

  1. With Authentication: Spins up the Kratos containers.
  2. Without Authentication: Does not spin up the Kratos containers.

But the third way of accessing Rafiki Admin is by running the Remix app directly in dev mode on your local machine. However, it is annoying when you run this command to get the app up in dev mode, because the application exits with an error stating that no Kratos container URL was provided. Chances are you don't want auth enabled when you're spinning up the app locally since you wouldn't be able to interact with it past the login pages anyway.

Authentication can be disabled by setting AUTH_ENABLED=false, this should ideally be the default behavior when using pnpm dev to spin up the UI. Or at least maybe we could have a note somewhere telling people about this. Or even just remove the dev command option from the package.json file so people know to rather spin it up in dev mode via Docker instead.

Steps to Reproduce

cd into the frontend package and run pnpm dev
Observe the error: No Kratos container URL provided.
Expected Behavior:
When running the Rafiki Admin UI in dev mode with AUTH_ENABLED=false, the application should not require a Kratos container URL. This behavior should be default when dev mode is detected to avoid unnecessary configuration hurdles for developers. This way you have access to the app immediately without further config.

Proposed Solution

  • Set AUTH_ENABLED=false as part of the dev command, or
  • Add documentation or comments in the relevant files to clarify this behavior for developers, or
  • Remove the dev command option from the package.json file so people know to rather spin it up in dev mode via Docker instead. The Docker Compose no-auth setup works seamlessly with the Admin UI in dev mode.
@github-project-automation github-project-automation bot moved this to Backlog in Rafiki Nov 20, 2024
@JoblersTune JoblersTune added the pkg: frontend Changes in the frontend package. label Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg: frontend Changes in the frontend package.
Projects
Status: Backlog
Development

No branches or pull requests

1 participant