Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions FEATURES.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ For full details for all fields see https://nginx.org/en/docs/http/ngx_http_acme

| Type | Description | API v5.4 | API v5.5 | Notes |
|------|----------------------|----------|----------|-------------------------------------|
| jwt | Java Web Token (JWT) | X | X | |
| jwt | JSON Web Token (JWT) | X | X | |
| mtls | Mutual TLS | X | X | <li>Supported for HTTP servers</li> |
| oidc | OpenID Connect | X | X | <li>Supported for HTTP servers</li> |

Expand Down Expand Up @@ -210,7 +210,7 @@ For additional details see https://nginx.org/en/docs/http/ngx_http_oidc_module.h

| Type | Description | API v5.4 | API v5.5 | Notes |
|------|------------------------|----------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| jwt | Java Web Token (JWT) | X | X | Based on JWT claims. Supported under <li>.declaration.http.servers[]</li><li>.declaration.http.servers[].location[]</li><li>.declaration.http.servers[].location[].apigateway</li> |
| jwt | JSON Web Token (JWT) | X | X | Based on JWT claims. Supported under <li>.declaration.http.servers[]</li><li>.declaration.http.servers[].location[]</li><li>.declaration.http.servers[].location[].apigateway</li> |

#### Examples

Expand Down
4 changes: 2 additions & 2 deletions contrib/postman/NGINX Declarative API.postman_collection.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion webui/IMPLEMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ webui/
|**Framework**|React 19|UI library|
|**Language**|TypeScript|Type safety|
|**Build Tool**|Vite|Fast dev server & build|
|**Routing**|React Router v6|Client-side routing|
|**Routing**|React Router v7|Client-side routing|
|**State Management**|Zustand|Auth state|
|**Server State**|TanStack Query|API state & caching|
|**HTTP Client**|Axios|API requests|
Expand Down
23 changes: 1 addition & 22 deletions webui/QUICKSTART.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,17 +44,7 @@ Expected output:

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

### 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
### Step 4: Create Your First Configuration
Copy link

Copilot AI Mar 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR title indicates this is only an npm package update, but QUICKSTART removes the login/JWT guidance (and troubleshooting/tips). That’s a user-facing documentation behavior change unrelated to dependency bumps; please either (a) mention this explicitly in the PR description so reviewers understand the intent, or (b) split the doc/auth guidance change into a separate PR.

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot open a new pull request to apply changes based on this feedback


1. Click "Create Config" in navigation
2. Edit the JSON declaration
Expand Down Expand Up @@ -158,16 +148,6 @@ 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 @@ -201,7 +181,6 @@ 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
2 changes: 1 addition & 1 deletion webui/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ npm run test:coverage
|Framework|React 19|
|Language|TypeScript|
|Build|Vite|
|Routing|React Router v6|
|Routing|React Router v7|
|State|Zustand + TanStack Query|
|HTTP|Axios|
|Styling|CSS3 with custom properties|
Expand Down
Loading
Loading