Skip to content

Commit 10bf802

Browse files
committed
Update README.md
1 parent debc68d commit 10bf802

File tree

1 file changed

+3
-49
lines changed

1 file changed

+3
-49
lines changed

README.md

Lines changed: 3 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,16 @@
22

33
**Find the docs at [hf.co/docs/chat-ui](https://huggingface.co/docs/chat-ui/index).**
44

5-
![Chat UI repository thumbnail](https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/chatui-websearch.png)
5+
![Chat UI repository thumbnail](https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/chat-ui/Frame%2013.png)
66

77
A chat interface using open source models, eg OpenAssistant or Llama. It is a SvelteKit app and it powers the [HuggingChat app on hf.co/chat](https://huggingface.co/chat).
88

99
0. [Quickstart](#quickstart)
1010
1. [Database Options](#database-options)
1111
2. [Launch](#launch)
1212
3. [Optional Docker Image](#optional-docker-image)
13-
4. [No Setup Deploy](#no-setup-deploy)
14-
5. [Extra parameters](#extra-parameters)
15-
6. [Common issues](#common-issues)
16-
7. [Deploying to a HF Space](#deploying-to-a-hf-space)
17-
8. [Building](#building)
18-
9. [Config changes for HuggingChat](#config-changes-for-huggingchat)
19-
10. [Populate database](#populate-database)
20-
11. [Building the docker images locally](#building-the-docker-images-locally)
13+
4. [Extra parameters](#extra-parameters)
14+
5. [Building](#building)
2115

2216
> Note on models: Chat UI only supports OpenAI-compatible APIs via `OPENAI_BASE_URL` and the `/models` endpoint. Provider-specific integrations (legacy `MODELS` env var, GGUF discovery, embeddings, web-search helpers, etc.) are removed, but any service that speaks the OpenAI protocol—Hugging Face router, llama.cpp server, Ollama’s OpenAI bridge, OpenRouter, Anthropic-on-OpenRouter, etc.—will work.
2317
@@ -108,48 +102,8 @@ docker run \
108102

109103
`host.docker.internal` lets the container reach a MongoDB instance on your host machine; swap it for your Atlas URI if you use the hosted option. All environment variables accepted in `.env.local` can be provided as `-e` flags.
110104

111-
## No Setup Deploy
112-
113-
If you don't want to configure, setup, and launch your own Chat UI yourself, you can use this option as a fast deploy alternative.
114-
115-
You can deploy your own customized Chat UI instance with any supported [LLM](https://huggingface.co/models?pipeline_tag=text-generation&sort=trending) of your choice on [Hugging Face Spaces](https://huggingface.co/spaces). To do so, use the chat-ui template [available here](https://huggingface.co/new-space?template=huggingchat/chat-ui-template).
116-
117-
Set `OPENAI_BASE_URL` (for example `https://router.huggingface.co/v1`) and `OPENAI_API_KEY` in [Space secrets](https://huggingface.co/docs/hub/spaces-overview#managing-secrets). `HF_TOKEN` remains supported as a legacy alias if you already have it configured. Create your personal token in your [User Access Tokens settings](https://huggingface.co/settings/tokens).
118-
119-
Read the full tutorial [here](https://huggingface.co/docs/hub/spaces-sdks-docker-chatui#chatui-on-spaces).
120-
121105
## Extra parameters
122106

123-
### OpenID connect
124-
125-
The login feature is disabled by default and users are attributed a unique ID based on their browser. But if you want to use OpenID to authenticate your users, you can add the following to your `.env.local` file:
126-
127-
```env
128-
OPENID_CONFIG=`{
129-
PROVIDER_URL: "<your OIDC issuer>",
130-
CLIENT_ID: "<your OIDC client ID>",
131-
CLIENT_SECRET: "<your OIDC client secret>",
132-
SCOPES: "openid profile",
133-
TOLERANCE: // optional
134-
RESOURCE: // optional
135-
}`
136-
```
137-
138-
These variables will enable the openID sign-in modal for users.
139-
140-
### Trusted header authentication
141-
142-
You can set the env variable `TRUSTED_EMAIL_HEADER` to point to the header that contains the user's email address. This will allow you to authenticate users from the header. This setup is usually combined with a proxy that will be in front of chat-ui and will handle the auth and set the header.
143-
144-
> [!WARNING]
145-
> Make sure to only allow requests to chat-ui through your proxy which handles authentication, otherwise users could authenticate as anyone by setting the header manually! Only set this up if you understand the implications and know how to do it correctly.
146-
147-
Here is a list of header names for common auth providers:
148-
149-
- Tailscale Serve: `Tailscale-User-Login`
150-
- Cloudflare Access: `Cf-Access-Authenticated-User-Email`
151-
- oauth2-proxy: `X-Forwarded-Email`
152-
153107
### Theming
154108

155109
You can use a few environment variables to customize the look and feel of chat-ui. These are by default:

0 commit comments

Comments
 (0)