update

.dockerignore

@@ -1,8 +0,0 @@
-Dockerfile
-.vscode/
-.idea
-.gitignore
-LICENSE
-README.md
-node_modules/
-.svelte-kit/

.env

@@ -1,94 +0,0 @@
-# Use .env.local to change these variables
-# DO NOT EDIT THIS FILE WITH SENSITIVE DATA
-
-MONGODB_URL=#your mongodb URL here
-MONGODB_DB_NAME=chat-ui
-MONGODB_DIRECT_CONNECTION=false
-
-COOKIE_NAME=hf-chat
-HF_ACCESS_TOKEN=#hf_<token> from from https://huggingface.co/settings/token
-HF_API_ROOT=https://api-inference.huggingface.co/models
-
-# used to activate search with web functionality. disabled if none are defined. choose one of the following:
-SERPER_API_KEY=#your serper.dev api key here
-SERPAPI_KEY=#your serpapi key here
-
-# Parameters to enable "Sign in with HF"
-OPENID_CLIENT_ID=
-OPENID_CLIENT_SECRET=
-OPENID_SCOPES="openid profile" # Add "email" for some providers like Google that do not provide preferred_username
-OPENID_PROVIDER_URL=https://huggingface.co # for Google, use https://accounts.google.com
-
-# Parameters to enable a global mTLS context for client fetch requests
-USE_CLIENT_CERTIFICATE=false
-CERT_PATH=#
-KEY_PATH=#
-CA_PATH=#
-CLIENT_KEY_PASSWORD=#
-REJECT_UNAUTHORIZED=true
-
-# 'name', 'userMessageToken', 'assistantMessageToken' are required
-MODELS=`[
-  {
-    "name": "OpenAssistant/oasst-sft-4-pythia-12b-epoch-3.5",
-    "datasetName": "OpenAssistant/oasst1",
-    "description": "A good alternative to ChatGPT",
-    "websiteUrl": "https://open-assistant.io",
-    "userMessageToken": "<|prompter|>",
-    "assistantMessageToken": "<|assistant|>",
-    "messageEndToken": "</s>",
-    "preprompt": "Below are a series of dialogues between various people and an AI assistant. The AI tries to be helpful, polite, honest, sophisticated, emotionally aware, and humble-but-knowledgeable. The assistant is happy to help with almost anything, and will do its best to understand exactly what is needed. It also tries to avoid giving false or misleading information, and it caveats when it isn't entirely sure about the right answer. That said, the assistant is practical and really does its best, and doesn't let caution get too much in the way of being useful.\n-----\n",
-    "promptExamples": [
-      {
-        "title": "Write an email from bullet list",
-        "prompt": "As a restaurant owner, write a professional email to the supplier to get these products every week: \n\n- Wine (x10)\n- Eggs (x24)\n- Bread (x12)"
-      }, {
-        "title": "Code a snake game",
-        "prompt": "Code a basic snake game in python, give explanations for each step."
-      }, {
-        "title": "Assist in a task",
-        "prompt": "How do I make a delicious lemon cheesecake?"
-      }
-    ],
-    "parameters": {
-      "temperature": 0.9,
-      "top_p": 0.95,
-      "repetition_penalty": 1.2,
-      "top_k": 50,
-      "truncate": 1000,
-      "max_new_tokens": 1024
-    }
-  }
-]`
-OLD_MODELS=`[]`# any removed models, `{ name: string, displayName?: string, id?: string }`
-
-PUBLIC_ORIGIN=#https://huggingface.co
-PUBLIC_SHARE_PREFIX=#https://hf.co/chat
-PUBLIC_GOOGLE_ANALYTICS_ID=#G-XXXXXXXX / Leave empty to disable
-PUBLIC_DEPRECATED_GOOGLE_ANALYTICS_ID=#UA-XXXXXXXX-X / Leave empty to disable
-PUBLIC_ANNOUNCEMENT_BANNERS=`[
-    {
-    "title": "Llama v2 is live on HuggingChat! 🦙",
-    "linkTitle": "Announcement",
-    "linkHref": "https://huggingface.co/blog/llama2"
-  }
-]`
-
-PARQUET_EXPORT_DATASET=
-PARQUET_EXPORT_HF_TOKEN=
-PARQUET_EXPORT_SECRET=
-
-RATE_LIMIT= # requests per minute
-MESSAGES_BEFORE_LOGIN=# how many messages a user can send in a conversation before having to login. set to 0 to force login right away
-
-PUBLIC_APP_NAME=ChatUI # name used as title throughout the app
-PUBLIC_APP_ASSETS=chatui # used to find logos & favicons in static/$PUBLIC_APP_ASSETS
-PUBLIC_APP_COLOR=blue # can be any of tailwind colors: https://tailwindcss.com/docs/customizing-colors#default-color-palette
-PUBLIC_APP_DATA_SHARING=#set to 1 to enable options & text regarding data sharing
-PUBLIC_APP_DISCLAIMER=#set to 1 to show a disclaimer on login page
-
-# PUBLIC_APP_NAME=HuggingChat
-# PUBLIC_APP_ASSETS=huggingchat
-# PUBLIC_APP_COLOR=yellow
-# PUBLIC_APP_DATA_SHARING=1
-# PUBLIC_APP_DISCLAIMER=1

.eslintignore

@@ -1,13 +0,0 @@
-.DS_Store
-node_modules
-/build
-/.svelte-kit
-/package
-.env
-.env.*
-!.env.example
-
-# Ignore files for PNPM, NPM and YARN
-pnpm-lock.yaml
-package-lock.json
-yarn.lock

.eslintrc.cjs

@@ -1,43 +0,0 @@
-module.exports = {
-	root: true,
-	parser: "@typescript-eslint/parser",
-	extends: [
-		"eslint:recommended",
-		"plugin:@typescript-eslint/recommended",
-		"plugin:svelte/recommended",
-		"prettier",
-	],
-	plugins: ["@typescript-eslint"],
-	ignorePatterns: ["*.cjs"],
-	overrides: [
-		{
-			files: ["*.svelte"],
-			parser: "svelte-eslint-parser",
-			parserOptions: {
-				parser: "@typescript-eslint/parser",
-			},
-		},
-	],
-	parserOptions: {
-		sourceType: "module",
-		ecmaVersion: 2020,
-		extraFileExtensions: [".svelte"],
-	},
-	rules: {
-		"no-shadow": ["error"],
-		"@typescript-eslint/no-explicit-any": "error",
-		"@typescript-eslint/no-non-null-assertion": "error",
-		"@typescript-eslint/no-unused-vars": [
-			// prevent variables with a _ prefix from being marked as unused
-			"error",
-			{
-				argsIgnorePattern: "^_",
-			},
-		],
-	},
-	env: {
-		browser: true,
-		es2017: true,
-		node: true,
-	},
-};

.gitignore

@@ -1,10 +0,0 @@
-.DS_Store
-node_modules
-/build
-/.svelte-kit
-/package
-.env
-.env.*
-!.env.example
-vite.config.js.timestamp-*
-vite.config.ts.timestamp-*

.npmrc

@@ -1 +0,0 @@
-engine-strict=true

.prettierignore

@@ -1,13 +0,0 @@
-.DS_Store
-node_modules
-/build
-/.svelte-kit
-/package
-.env
-.env.*
-!.env.example
-
-# Ignore files for PNPM, NPM and YARN
-pnpm-lock.yaml
-package-lock.json
-yarn.lock

.prettierrc

@@ -1,8 +0,0 @@
-{
-	"useTabs": true,
-	"trailingComma": "es5",
-	"printWidth": 100,
-	"plugins": ["prettier-plugin-svelte", "prettier-plugin-tailwindcss"],
-	"pluginSearchDirs": ["."],
-	"overrides": [{ "files": "*.svelte", "options": { "parser": "svelte" } }]
-}

Dockerfile

@@ -1,32 +1,121 @@
-# syntax=docker/dockerfile:1
-# read the doc: https://huggingface.co/docs/hub/spaces-sdks-docker
-# you will also find guides on how best to write your Dockerfile
-FROM node:19 as builder-production
+ARG MODEL_NAME
+ARG MODEL_PARAMS
+ARG APP_COLOR
+ARG APP_NAME
+
+
+FROM node:19 as chatui-builder
+ARG MODEL_NAME
+ARG MODEL_PARAMS
+ARG APP_COLOR
+ARG APP_NAME
 
 WORKDIR /app
 
-COPY --link --chown=1000 package-lock.json package.json ./
-RUN --mount=type=cache,target=/app/.npm \
-        npm set cache /app/.npm && \
-        npm ci --omit=dev
+RUN apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
+    git gettext && \
+    rm -rf /var/lib/apt/lists/*
+
+
+RUN git clone https://github.com/huggingface/chat-ui.git
+
+WORKDIR /app/chat-ui
+
+
+COPY .env.local.template .env.local.template
+
+RUN mkdir defaults
+ADD defaults /defaults
+RUN chmod -R 777 /defaults
+RUN --mount=type=secret,id=MONGODB_URL,mode=0444 \
+    MODEL_NAME="${MODEL_NAME:="$(cat /defaults/MODEL_NAME)"}" && export MODEL_NAME \
+    && MODEL_PARAMS="${MODEL_PARAMS:="$(cat /defaults/MODEL_PARAMS)"}" && export MODEL_PARAMS \
+    && APP_COLOR="${APP_COLOR:="$(cat /defaults/APP_COLOR)"}" && export APP_COLOR \
+    && APP_NAME="${APP_NAME:="$(cat /defaults/APP_NAME)"}" && export APP_NAME \
+    && MONGODB_URL=$(cat /run/secrets/MONGODB_URL > /dev/null | grep '^' || cat /defaults/MONGODB_URL) && export MONGODB_URL && \
+    echo "${MONGODB_URL}" && \
+    envsubst < ".env.local.template" > ".env.local" \ 
+    && rm .env.local.template
+
 
-FROM builder-production as builder
 
 RUN --mount=type=cache,target=/app/.npm \
-        npm set cache /app/.npm && \
-        npm ci
+    npm set cache /app/.npm && \
+    npm ci
+
+RUN npm run build
+
+FROM ghcr.io/huggingface/text-generation-inference:0.9.4
+
+ARG MODEL_NAME
+ARG MODEL_PARAMS
+ARG APP_COLOR
+ARG APP_NAME
+
+ENV TZ=Europe/Paris \
+    PORT=3000
+
 
-COPY --link --chown=1000 . .
 
-RUN --mount=type=secret,id=DOTENV_LOCAL,dst=.env.local \
-    npm run build
+RUN apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
+    gnupg \
+    curl \
+    gettext && \
+    rm -rf /var/lib/apt/lists/*
+COPY entrypoint.sh.template entrypoint.sh.template
 
-FROM node:19-slim
+RUN mkdir defaults
+ADD defaults /defaults
+RUN chmod -R 777 /defaults
 
+RUN --mount=type=secret,id=MONGODB_URL,mode=0444 \
+    MODEL_NAME="${MODEL_NAME:="$(cat /defaults/MODEL_NAME)"}" && export MODEL_NAME \
+    && MODEL_PARAMS="${MODEL_PARAMS:="$(cat /defaults/MODEL_PARAMS)"}" && export MODEL_PARAMS \
+    && APP_COLOR="${APP_COLOR:="$(cat /defaults/APP_COLOR)"}" && export APP_COLOR \
+    && APP_NAME="${APP_NAME:="$(cat /defaults/APP_NAME)"}" && export APP_NAME \
+    && MONGODB_URL=$(cat /run/secrets/MONGODB_URL > /dev/null | grep '^' || cat /defaults/MONGODB_URL) && export MONGODB_URL &&  \
+    envsubst < "entrypoint.sh.template" > "entrypoint.sh" \
+    && rm entrypoint.sh.template
+
+
+RUN curl -fsSL https://pgp.mongodb.com/server-6.0.asc | \
+    gpg -o /usr/share/keyrings/mongodb-server-6.0.gpg \
+    --dearmor
+
+RUN echo "deb [ arch=amd64,arm64 signed-by=/usr/share/keyrings/mongodb-server-6.0.gpg ] https://repo.mongodb.org/apt/ubuntu focal/mongodb-org/6.0 multiverse" | tee /etc/apt/sources.list.d/mongodb-org-6.0.list
+
+RUN apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
+    mongodb-org && \
+    rm -rf /var/lib/apt/lists/*
+
+RUN mkdir -p /data/db
+RUN chown -R 1000:1000 /data
+
+RUN curl -fsSL https://deb.nodesource.com/setup_19.x | /bin/bash -
+
+RUN apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
+    nodejs && \
+    rm -rf /var/lib/apt/lists/*
+
+RUN mkdir /app
+RUN chown -R 1000:1000 /app
+
+RUN useradd -m -u 1000 user
+
+# Switch to the "user" user
+USER user
+
+ENV HOME=/home/user \
+    PATH=/home/user/.local/bin:$PATH
+
+RUN npm config set prefix /home/user/.local
 RUN npm install -g pm2
 
-COPY --from=builder-production /app/node_modules /app/node_modules
-COPY --link --chown=1000 package.json /app/package.json
-COPY --from=builder /app/build /app/build
+COPY --from=chatui-builder --chown=1000 /app/chat-ui/node_modules /app/node_modules
+COPY --from=chatui-builder --chown=1000 /app/chat-ui/package.json /app/package.json
+COPY --from=chatui-builder --chown=1000 /app/chat-ui/build /app/build
+
+ENTRYPOINT ["/bin/bash"]
+CMD ["entrypoint.sh"]
+
 
-CMD pm2 start /app/build/index.js -i $CPU_CORES --no-daemon

LICENSE

@@ -1,203 +0,0 @@
-Copyright 2018- The Hugging Face team. All rights reserved.
-
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.

PRIVACY.md

@@ -1,38 +0,0 @@
-## Privacy
-
-> Last updated: July 23, 2023
-
-Users of HuggingChat are authenticated through their HF user account.
-
-By default, your conversations may be shared with the respective models' authors (e.g. if you're chatting with the Open Assistant model, to <a target="_blank" href="https://open-assistant.io/dashboard">Open Assistant</a>) to improve their training data and model over time. Model authors are the custodians of the data collected by their model, even if it's hosted on our platform.
-
-If you disable data sharing in your settings, your conversations will not be used for any downstream usage (including for research or model training purposes), and they will only be stored to let you access past conversations. You can click on the Delete icon to delete any past conversation at any moment.
-
-🗓 Please also consult huggingface.co's main privacy policy at https://huggingface.co/privacy. To exercise any of your legal privacy rights, please send an email to privacy@huggingface.co.
-
-## About available LLMs
-
-The goal of this app is to showcase that it is now (May 2023) possible to build an open source alternative to ChatGPT. 💪
-
-For now, it's running both OpenAssistant's [latest LLaMA based model](https://huggingface.co/OpenAssistant/oasst-sft-6-llama-30b-xor) (which is one of the current best open source chat models) as well as [Meta's newer Llama 2](https://huggingface.co/meta-llama/Llama-2-70b-chat-hf), but the plan in the longer-term is to expose all good-quality chat models from the Hub.
-
-We are not affiliated with Open Assistant nor Meta AI, but if you want to contribute to the training data for the next generation of open models, please consider contributing to https://open-assistant.io/ or https://ai.meta.com/llama/ ❤️
-
-## Technical details
-
-This app is running in a [Space](https://huggingface.co/docs/hub/spaces-overview), which entails that the code for this UI is publicly visible [inside the Space repo](https://huggingface.co/spaces/huggingchat/chat-ui/tree/main).
-
-**Further development takes place on the [huggingface/chat-ui GitHub repo](https://github.com/huggingface/chat-ui).**
-
-The inference backend is running the optimized [text-generation-inference](https://github.com/huggingface/text-generation-inference) on HuggingFace's Inference API infrastructure.
-
-It is therefore possible to deploy a copy of this app to a Space and customize it (swap model, add some UI elements, or store user messages according to your own Terms and conditions). You can also 1-click deploy your own instance using the [Chat UI Spaces Docker template](https://huggingface.co/new-space?template=huggingchat/chat-ui-template).
-
-We welcome any feedback on this app: please participate to the public discussion at https://huggingface.co/spaces/huggingchat/chat-ui/discussions
-
-<a target="_blank" href="https://huggingface.co/spaces/huggingchat/chat-ui/discussions"><img src="https://huggingface.co/datasets/huggingface/badges/raw/main/open-a-discussion-xl.svg" title="open a discussion"></a>
-
-## Coming soon
-
-- User setting to share conversations with model authors (done ✅)
-- LLM watermarking

README.md

@@ -1,325 +1,12 @@
 ---
-title: chat-ui
-emoji: 🔥
-colorFrom: purple
-colorTo: purple
+title: Chat Ui Template
+emoji: 🚀
+colorFrom: indigo
+colorTo: blue
 sdk: docker
 pinned: false
-license: apache-2.0
-base_path: /chat
 app_port: 3000
+suggested_hardware: a10g-small
 ---
 
-# Chat UI
-
-![Chat UI repository thumbnail](https://huggingface.co/datasets/huggingface/documentation-images/raw/f038917dd40d711a72d654ab1abfc03ae9f177e6/chat-ui-repo-thumbnail.svg)
-
-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).
-
-0. [No Setup Deploy](#no-setup-deploy)
-1. [Setup](#setup)
-2. [Launch](#launch)
-3. [Extra parameters](#extra-parameters)
-4. [Deploying to a HF Space](#deploying-to-a-hf-space)
-5. [Building](#building)
-
-##  No Setup Deploy
-
-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.
-
-You can deploy your own customized Chat UI instance with any supported LLM of your choice with only a few clicks to Hugging Face Spaces thanks to the Chat UI Spaces Docker template. Get started [here](https://huggingface.co/new-space?template=huggingchat/chat-ui-template).
-If you'd like to deploy a model with gated access or a model in a private repository, you can simply provide `HUGGING_FACE_HUB_TOKEN` in [Space secrets](https://huggingface.co/docs/hub/spaces-overview#managing-secrets-and-environment-variables). You need to set its value to an access token you can get from [here](https://huggingface.co/settings/tokens).
-
-Read the full tutorial [here](https://huggingface.co/docs/hub/spaces-sdks-docker-chatui#chatui-on-spaces).
-
-## Setup
-
-The default config for Chat UI is stored in the `.env` file. You will need to override some values to get Chat UI to run locally. This is done in `.env.local`.
-
-Start by creating a `.env.local` file in the root of the repository. The bare minimum config you need to get Chat UI to run locally is the following:
-
-```bash
-MONGODB_URL=<the URL to your mongoDB instance>
-HF_ACCESS_TOKEN=<your access token>
-```
-
-### Database
-
-The chat history is stored in a MongoDB instance, and having a DB instance available is needed for Chat UI to work.
-
-You can use a local MongoDB instance. The easiest way is to spin one up using docker:
-
-```bash
-docker run -d -p 27017:27017 --name mongo-chatui mongo:latest
-```
-
-In which case the url of your DB will be `MONGODB_URL=mongodb://localhost:27017`.
-
-Alternatively, you can use a [free MongoDB Atlas](https://www.mongodb.com/pricing) instance for this, Chat UI should fit comfortably within their free tier. After which you can set the `MONGODB_URL` variable in `.env.local` to match your instance.
-
-### Hugging Face Access Token
-
-You will need a Hugging Face access token to run Chat UI locally, if you use a remote inference endpoint. You can get one from [your Hugging Face profile](https://huggingface.co/settings/tokens).
-
-## Launch
-
-After you're done with the `.env.local` file you can run Chat UI locally with:
-
-```bash
-npm install
-npm run dev
-```
-
-## Extra parameters
-
-### OpenID connect
-
-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:
-
-```bash
-OPENID_PROVIDER_URL=<your OIDC issuer>
-OPENID_CLIENT_ID=<your OIDC client ID>
-OPENID_CLIENT_SECRET=<your OIDC client secret>
-```
-
-These variables will enable the openID sign-in modal for users.
-
-### Theming
-
-You can use a few environment variables to customize the look and feel of chat-ui. These are by default:
-
-```
-PUBLIC_APP_NAME=ChatUI
-PUBLIC_APP_ASSETS=chatui
-PUBLIC_APP_COLOR=blue
-PUBLIC_APP_DATA_SHARING=
-PUBLIC_APP_DISCLAIMER=
-```
-
-- `PUBLIC_APP_NAME` The name used as a title throughout the app.
-- `PUBLIC_APP_ASSETS` Is used to find logos & favicons in `static/$PUBLIC_APP_ASSETS`, current options are `chatui` and `huggingchat`.
-- `PUBLIC_APP_COLOR` Can be any of the [tailwind colors](https://tailwindcss.com/docs/customizing-colors#default-color-palette).
-- `PUBLIC_APP_DATA_SHARING` Can be set to 1 to add a toggle in the user settings that lets your users opt-in to data sharing with models creator.
-- `PUBLIC_APP_DISCLAIMER` If set to 1, we show a disclaimer about generated outputs on login.
-
-### Web Search
-
-You can enable the web search by adding either `SERPER_API_KEY` ([serper.dev](https://serper.dev/)) or `SERPAPI_KEY` ([serpapi.com](https://serpapi.com/)) to your `.env.local`.
-
-### Custom models
-
-You can customize the parameters passed to the model or even use a new model by updating the `MODELS` variable in your `.env.local`. The default one can be found in `.env` and looks like this :
-
-```
-
-MODELS=`[
-  {
-    "name": "OpenAssistant/oasst-sft-4-pythia-12b-epoch-3.5",
-    "datasetName": "OpenAssistant/oasst1",
-    "description": "A good alternative to ChatGPT",
-    "websiteUrl": "https://open-assistant.io",
-    "userMessageToken": "<|prompter|>", # This does not need to be a token, can be any string
-    "assistantMessageToken": "<|assistant|>", # This does not need to be a token, can be any string
-    "userMessageEndToken": "<|endoftext|>", # Applies only to user messages. Can be any string.
-    "assistantMessageEndToken": "<|endoftext|>", # Applies only to assistant messages. Can be any string.
-    "preprompt": "Below are a series of dialogues between various people and an AI assistant. The AI tries to be helpful, polite, honest, sophisticated, emotionally aware, and humble-but-knowledgeable. The assistant is happy to help with almost anything, and will do its best to understand exactly what is needed. It also tries to avoid giving false or misleading information, and it caveats when it isn't entirely sure about the right answer. That said, the assistant is practical and really does its best, and doesn't let caution get too much in the way of being useful.\n-----\n",
-    "promptExamples": [
-      {
-        "title": "Write an email from bullet list",
-        "prompt": "As a restaurant owner, write a professional email to the supplier to get these products every week: \n\n- Wine (x10)\n- Eggs (x24)\n- Bread (x12)"
-      }, {
-        "title": "Code a snake game",
-        "prompt": "Code a basic snake game in python, give explanations for each step."
-      }, {
-        "title": "Assist in a task",
-        "prompt": "How do I make a delicious lemon cheesecake?"
-      }
-    ],
-    "parameters": {
-      "temperature": 0.9,
-      "top_p": 0.95,
-      "repetition_penalty": 1.2,
-      "top_k": 50,
-      "truncate": 1000,
-      "max_new_tokens": 1024,
-      "stop": ["<|endoftext|>"]  # This does not need to be tokens, can be any list of strings
-    }
-  }
-]`
-
-```
-
-You can change things like the parameters, or customize the preprompt to better suit your needs. You can also add more models by adding more objects to the array, with different preprompts for example.
-
-#### Custom prompt templates:
-
-By default the prompt is constructed using `userMessageToken`, `assistantMessageToken`, `userMessageEndToken`, `assistantMessageEndToken`, `preprompt` parameters and a series of default templates.
-
-However, these templates can be modified by setting the `chatPromptTemplate`, `webSearchSummaryPromptTemplate`, and `webSearchQueryPromptTemplate` parameters. Note that if WebSearch is not enabled, only `chatPromptTemplate` needs to be set. The template language is https://handlebarsjs.com. The templates have access to the model's prompt parameters (`preprompt`, etc.). However, if the templates are specified it is recommended to inline the prompt parameters, as using the references (`{{preprompt}}`) is deprecated.
-
-For example:
-
-```
-<System>You are an AI, called ChatAI.</System>
-{{#each messages}}
-  {{#ifUser}}<User>{{content}}</User>{{/ifUser}}
-  {{#ifAssistant}}<Assistant>{{content}}</Assistant>{{/ifAssistant}}
-{{/each}}
-<Assistant>
-```
-
-**chatPromptTemplate**
-
-When quering the model for a chat response, the `chatPromptTemplate` template is used. `messages` is an array of chat messages, it has the format `[{ content: string }, ...]`. To idenify if a message is a user message or an assistant message the `ifUser` and `ifAssistant` block helpers can be used.
-
-The following is the default `chatPromptTemplate`, although newlines and indentiation have been added for readability.
-
-```
-{{preprompt}}
-{{#each messages}}
-  {{#ifUser}}{{@root.userMessageToken}}{{content}}{{@root.userMessageEndToken}}{{/ifUser}}
-  {{#ifAssistant}}{{@root.assistantMessageToken}}{{content}}{{@root.assistantMessageEndToken}}{{/ifAssistant}}
-{{/each}}
-{{assistantMessageToken}}
-```
-
-**webSearchQueryPromptTemplate**
-
-When performing a websearch, the search query is constructed using the `webSearchQueryPromptTemplate` template. It is recommended that that the prompt instructs the chat model to only return a few keywords.
-
-The following is the default `webSearchQueryPromptTemplate`. Note that not all models supports consecutive user-messages which this template uses.
-
-```
-{{userMessageToken}}
-  The following messages were written by a user, trying to answer a question.
-{{userMessageEndToken}}
-{{#each messages}}
-  {{#ifUser}}{{@root.userMessageToken}}{{content}}{{@root.userMessageEndToken}}{{/ifUser}}
-{{/each}}
-{{userMessageToken}}
-  What plain-text english sentence would you input into Google to answer the last question? Answer with a short (10 words max) simple sentence.
-{{userMessageEndToken}}
-{{assistantMessageToken}}Query:
-```
-
-**webSearchSummaryPromptTemplate**
-
-The search-engine response (`answer`) is summarized using the following prompt template. However, when `HF_ACCESS_TOKEN` is provided, a dedicated summary model is used instead. Additionally, the model's `query` response to `webSearchQueryPromptTemplate` is also available to this template.
-
-The following is the default `webSearchSummaryPromptTemplate`. Note that not all models supports consecutive user-messages which this template uses.
-
-```
-{{userMessageToken}}{{answer}}{{userMessageEndToken}}
-{{userMessageToken}}
-  The text above should be summarized to best answer the query: {{query}}.
-{{userMessageEndToken}}
-{{assistantMessageToken}}Summary:
-```
-
-#### Running your own models using a custom endpoint
-
-If you want to, instead of hitting models on the Hugging Face Inference API, you can run your own models locally.
-
-A good option is to hit a [text-generation-inference](https://github.com/huggingface/text-generation-inference) endpoint. This is what is done in the official [Chat UI Spaces Docker template](https://huggingface.co/new-space?template=huggingchat/chat-ui-template) for instance: both this app and a text-generation-inference server run inside the same container.
-
-To do this, you can add your own endpoints to the `MODELS` variable in `.env.local`, by adding an `"endpoints"` key for each model in `MODELS`.
-
-```
-
-{
-// rest of the model config here
-"endpoints": [{"url": "https://HOST:PORT"}]
-}
-
-```
-
-If `endpoints` is left unspecified, ChatUI will look for the model on the hosted Hugging Face inference API using the model name.
-
-### Custom endpoint authorization
-
-#### Basic and Bearer
-
-Custom endpoints may require authorization, depending on how you configure them. Authentication will usually be set either with `Basic` or `Bearer`.
-
-For `Basic` we will need to generate a base64 encoding of the username and password.
-
-`echo -n "USER:PASS" | base64`
-
-> VVNFUjpQQVNT
-
-For `Bearer` you can use a token, which can be grabbed from [here](https://huggingface.co/settings/tokens).
-
-You can then add the generated information and the `authorization` parameter to your `.env.local`.
-
-```
-
-"endpoints": [
-{
-"url": "https://HOST:PORT",
-"authorization": "Basic VVNFUjpQQVNT",
-}
-]
-
-```
-
-### Amazon SageMaker
-
-You can also specify your Amazon SageMaker instance as an endpoint for chat-ui. The config goes like this:
-
-```
-"endpoints": [
-    {
-      "host" : "sagemaker",
-      "url": "", // your aws sagemaker url here
-      "accessKey": "",
-      "secretKey" : "",
-      "sessionToken": "", // optional
-      "weight": 1
-    }
-```
-
-You can get the `accessKey` and `secretKey` from your AWS user, under programmatic access.
-
-#### Client Certificate Authentication (mTLS)
-
-Custom endpoints may require client certificate authentication, depending on how you configure them. To enable mTLS between Chat UI and your custom endpoint, you will need to set the `USE_CLIENT_CERTIFICATE` to `true`, and add the `CERT_PATH` and `KEY_PATH` parameters to your `.env.local`. These parameters should point to the location of the certificate and key files on your local machine. The certificate and key files should be in PEM format. The key file can be encrypted with a passphrase, in which case you will also need to add the `CLIENT_KEY_PASSWORD` parameter to your `.env.local`.
-
-If you're using a certificate signed by a private CA, you will also need to add the `CA_PATH` parameter to your `.env.local`. This parameter should point to the location of the CA certificate file on your local machine.
-
-If you're using a self-signed certificate, e.g. for testing or development purposes, you can set the `REJECT_UNAUTHORIZED` parameter to `false` in your `.env.local`. This will disable certificate validation, and allow Chat UI to connect to your custom endpoint.
-
-#### Models hosted on multiple custom endpoints
-
-If the model being hosted will be available on multiple servers/instances add the `weight` parameter to your `.env.local`. The `weight` will be used to determine the probability of requesting a particular endpoint.
-
-```
-
-"endpoints": [
-{
-"url": "https://HOST:PORT",
-"weight": 1
-}
-{
-"url": "https://HOST:PORT",
-"weight": 2
-}
-...
-]
-
-```
-
-## Deploying to a HF Space
-
-Create a `DOTENV_LOCAL` secret to your HF space with the content of your .env.local, and they will be picked up automatically when you run.
-
-## Building
-
-To create a production version of your app:
-
-```bash
-npm run build
-```
-
-You can preview the production build with `npm run preview`.
-
-> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.
+Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference

package.json

@@ -1,63 +0,0 @@
-{
-	"name": "chat-ui",
-	"version": "0.5.0",
-	"private": true,
-	"packageManager": "npm@9.5.0",
-	"scripts": {
-		"dev": "vite dev",
-		"build": "vite build",
-		"preview": "vite preview",
-		"check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
-		"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
-		"lint": "prettier --plugin-search-dir . --check . && eslint .",
-		"format": "prettier --plugin-search-dir . --write .",
-		"test": "MONGODB_URL=mongodb://127.0.0.1:27017/ vitest"
-	},
-	"devDependencies": {
-		"@iconify-json/carbon": "^1.1.16",
-		"@iconify-json/eos-icons": "^1.1.6",
-		"@sveltejs/adapter-node": "^1.2.4",
-		"@sveltejs/kit": "^1.15.10",
-		"@tailwindcss/typography": "^0.5.9",
-		"@types/jsdom": "^21.1.1",
-		"@types/marked": "^4.0.8",
-		"@types/parquetjs": "^0.10.3",
-		"@typescript-eslint/eslint-plugin": "^5.45.0",
-		"@typescript-eslint/parser": "^5.45.0",
-		"eslint": "^8.28.0",
-		"eslint-config-prettier": "^8.5.0",
-		"eslint-plugin-svelte": "^2.27.3",
-		"prettier": "^2.8.0",
-		"prettier-plugin-svelte": "^2.8.1",
-		"prettier-plugin-tailwindcss": "^0.2.7",
-		"svelte": "^3.58.0",
-		"svelte-check": "^3.2.0",
-		"tslib": "^2.4.1",
-		"typescript": "^4.9.3",
-		"unplugin-icons": "^0.16.1",
-		"vite": "^4.3.9",
-		"vitest": "^0.31.0"
-	},
-	"type": "module",
-	"dependencies": {
-		"@huggingface/hub": "^0.5.1",
-		"@huggingface/inference": "^2.2.0",
-		"autoprefixer": "^10.4.14",
-		"aws4fetch": "^1.0.17",
-		"date-fns": "^2.29.3",
-		"dotenv": "^16.0.3",
-		"handlebars": "^4.7.8",
-		"highlight.js": "^11.7.0",
-		"jsdom": "^22.0.0",
-		"marked": "^4.3.0",
-		"mongodb": "^5.3.0",
-		"nanoid": "^4.0.2",
-		"openid-client": "^5.4.2",
-		"parquetjs": "^0.11.2",
-		"postcss": "^8.4.21",
-		"serpapi": "^1.1.1",
-		"tailwind-scrollbar": "^3.0.0",
-		"tailwindcss": "^3.3.1",
-		"zod": "^3.21.4"
-	}
-}

postcss.config.js

@@ -1,6 +0,0 @@
-export default {
-	plugins: {
-		tailwindcss: {},
-		autoprefixer: {},
-	},
-};

svelte.config.js

@@ -1,29 +0,0 @@
-import adapter from "@sveltejs/adapter-node";
-import { vitePreprocess } from "@sveltejs/kit/vite";
-import dotenv from "dotenv";
-
-dotenv.config({ path: "./.env.local" });
-dotenv.config({ path: "./.env" });
-
-process.env.PUBLIC_VERSION = process.env.npm_package_version;
-
-/** @type {import('@sveltejs/kit').Config} */
-const config = {
-	// Consult https://kit.svelte.dev/docs/integrations#preprocessors
-	// for more information about preprocessors
-	preprocess: vitePreprocess(),
-
-	kit: {
-		adapter: adapter(),
-
-		paths: {
-			base: process.env.APP_BASE || "",
-		},
-		csrf: {
-			// handled in hooks.server.ts, because we can have multiple valid origins
-			checkOrigin: false,
-		},
-	},
-};
-
-export default config;

tailwind.config.cjs

@@ -1,29 +0,0 @@
-const defaultTheme = require("tailwindcss/defaultTheme");
-const colors = require("tailwindcss/colors");
-
-import dotenv from "dotenv";
-dotenv.config({ path: "./.env" });
-
-/** @type {import('tailwindcss').Config} */
-export default {
-	darkMode: "class",
-	content: ["./src/**/*.{html,js,svelte,ts}"],
-	theme: {
-		extend: {
-			colors: {
-				primary: colors[process.env.PUBLIC_APP_COLOR],
-			},
-			// fontFamily: {
-			// 	sans: ['"Inter"', ...defaultTheme.fontFamily.sans]
-			// },
-			fontSize: {
-				xxs: "0.625rem",
-				smd: "0.94rem",
-			},
-		},
-	},
-	plugins: [
-		require("tailwind-scrollbar")({ nocompatible: true }),
-		require("@tailwindcss/typography"),
-	],
-};

tsconfig.json

@@ -1,18 +0,0 @@
-{
-	"extends": "./.svelte-kit/tsconfig.json",
-	"compilerOptions": {
-		"allowJs": true,
-		"checkJs": true,
-		"esModuleInterop": true,
-		"forceConsistentCasingInFileNames": true,
-		"resolveJsonModule": true,
-		"skipLibCheck": true,
-		"sourceMap": true,
-		"strict": true,
-		"target": "ES2018"
-	}
-	// Path aliases are handled by https://kit.svelte.dev/docs/configuration#alias
-	//
-	// If you want to overwrite includes/excludes, make sure to copy over the relevant includes/excludes
-	// from the referenced tsconfig.json - TypeScript does not merge them in
-}

vite.config.ts

@@ -1,12 +0,0 @@
-import { sveltekit } from "@sveltejs/kit/vite";
-import { defineConfig } from "vite";
-import Icons from "unplugin-icons/vite";
-
-export default defineConfig({
-	plugins: [
-		sveltekit(),
-		Icons({
-			compiler: "svelte",
-		}),
-	],
-});