Skip to content

Commit 77d05e1

Browse files
Docs: Improve Integration documentation (#25)
1 parent 70fa9aa commit 77d05e1

File tree

2 files changed

+9
-7
lines changed

2 files changed

+9
-7
lines changed

docs/DEVELOPMENT.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,9 +103,8 @@ make clean # Stop and remove containers, images, and volumes
103103
### Testing Commands
104104

105105
```bash
106-
make test # Run all tests (unit + image validation)
107-
make test-unit # Run unit tests for server logic only
108-
make test-image # Run Docker image build validation tests
106+
make test # Run all tests (unit + image validation)
107+
make test-file FILE=<path> # Run test file(s), e.g. make test-file FILE=tests/loaders/
109108
```
110109

111110
### Code Quality Commands
@@ -154,6 +153,7 @@ This project uses feature branches and GitHub Actions for CI/CD with **automated
154153
- `feature/*` - New features
155154
- `fix/*` - Bug fixes
156155
- `hotfix/*` - Urgent production fixes
156+
- `docs/*` - Documentation updates
157157

158158
**Development workflow:**
159159

docs/INTEGRATIONS.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,17 @@ Guide for integrating n8n OpenAI Bridge with various clients.
1818

1919
### User Context Integration
2020

21-
Open WebUI automatically forwards user information via HTTP headers when `ENABLE_FORWARD_USER_INFO_HEADERS=true`:
21+
Open WebUI automatically forwards user information via HTTP headers when `ENABLE_FORWARD_USER_INFO_HEADERS=true`. Set it in your OpenWebUI configuration, [learn more about in the official OpenWebUI documentation](https://docs.openwebui.com/getting-started/env-configuration/#enable_forward_user_info_headers):
2222
- `X-OpenWebUI-User-Id` - User's unique identifier
2323
- `X-OpenWebUI-User-Email` - User's email address
2424
- `X-OpenWebUI-User-Name` - User's display name
2525
- `X-OpenWebUI-User-Role` - User's role (admin, user, etc.)
2626
- `X-OpenWebUI-Chat-Id` - Chat session identifier
2727

28-
To enable OpenWebUI header support, add them to your `.env`:
28+
To enable OpenWebUI header support, add them to the n8n-openai-bridge encironment, for example in `.env` (second value with each ENV VAR):
2929

3030
```bash
31-
SESSION_ID_HEADERS=X-Session-Id,X-Chat-Id,X-OpenWebUI-Chat-Id
31+
SESSION_ID_HEADERS=X-Session-Id,X-OpenWebUI-Chat-Id
3232
USER_ID_HEADERS=X-User-Id,X-OpenWebUI-User-Id
3333
USER_EMAIL_HEADERS=X-User-Email,X-OpenWebUI-User-Email
3434
USER_NAME_HEADERS=X-User-Name,X-OpenWebUI-User-Name
@@ -45,7 +45,7 @@ This allows your n8n workflows to:
4545

4646
### Setup
4747

48-
Add to your `librechat.yaml` configuration:
48+
Add to your `librechat.yaml` configuration, [learn more about it in the official documentation](https://www.librechat.ai/docs/configuration/librechat_yaml/object_structure/custom_endpoint):
4949

5050
```yaml
5151
endpoints:
@@ -66,6 +66,8 @@ endpoints:
6666
summary: true
6767
```
6868
69+
Librechat requires a valid `models.default` value which must not be empty but will be overridden by the models that have been fetched.
70+
6971
### Configuration Notes
7072

7173
- `apiKey`: Must match your `BEARER_TOKEN` from `.env`

0 commit comments

Comments
 (0)