Skip to content

Restore login/JWT guidance removed from QUICKSTART.md in npm update PR #125

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

Closed
Copilot wants to merge 2 commits into from
Closed

Restore login/JWT guidance removed from QUICKSTART.md in npm update PR #125

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5b50d26
Initial plan
Copilot Mar 26, 2026
a3fff97
docs: restore login/JWT guidance in QUICKSTART.md
Copilot Mar 26, 2026
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
23 changes: 22 additions & 1 deletion webui/QUICKSTART.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,17 @@ Expected output:

Open browser: <http://localhost:3000>

### Step 4: Create Your First Configuration
### Step 4: Login

For development/testing, use any JWT token format:

```text
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
```

*Note: For production, configure proper JWT validation on the backend.*

### Step 5: Create Your First Configuration

1. Click "Create Config" in navigation
2. Edit the JSON declaration
Expand Down Expand Up @@ -148,6 +158,16 @@ lsof -i :3000
./nginx-dapi.sh -c start
```

### Authentication Fails

**Issue:** "Authentication failed" on login

**Check:**

1. Ensure JWT token is not empty
2. For testing, any valid JWT format works
3. For production, backend must validate the token

## 📱 Development Setup

Want to modify the Web UI?
Expand Down Expand Up @@ -181,6 +201,7 @@ Dev server runs at <http://localhost:3000> with auto-reload.

## 💡 Tips

- **JWT Token:** For development, you can generate tokens at <https://jwt.io>
- **API Docs:** Visit <http://localhost:5000/docs> for interactive API documentation
- **Templates:** Look in `webui/src/pages/CreateConfigPage.tsx` for example configurations
- **Docker Compose:** See `contrib/docker-compose/docker-compose.yaml` for service configuration
Expand Down