chat-ui/main/en/developing/copy-huggingchat.html

<meta charset="utf-8" /><meta name="hf:doc:metadata" content="{&quot;title&quot;:&quot;Copy HuggingChat&quot;,&quot;local&quot;:&quot;copy-huggingchat&quot;,&quot;sections&quot;:[{&quot;title&quot;:&quot;Running a copy of HuggingChat locally&quot;,&quot;local&quot;:&quot;running-a-copy-of-huggingchat-locally&quot;,&quot;sections&quot;:[],&quot;depth&quot;:3},{&quot;title&quot;:&quot;Populate database&quot;,&quot;local&quot;:&quot;populate-database&quot;,&quot;sections&quot;:[],&quot;depth&quot;:3}],&quot;depth&quot;:1}">
		<link href="/docs/chat-ui/main/en/_app/immutable/assets/0.e3b0c442.css" rel="modulepreload">
		<link rel="modulepreload" href="/docs/chat-ui/main/en/_app/immutable/entry/start.1b3abf1a.js">
		<link rel="modulepreload" href="/docs/chat-ui/main/en/_app/immutable/chunks/scheduler.b108d059.js">
		<link rel="modulepreload" href="/docs/chat-ui/main/en/_app/immutable/chunks/singletons.52e3a26c.js">
		<link rel="modulepreload" href="/docs/chat-ui/main/en/_app/immutable/chunks/paths.5ae123be.js">
		<link rel="modulepreload" href="/docs/chat-ui/main/en/_app/immutable/entry/app.9a720b7c.js">
		<link rel="modulepreload" href="/docs/chat-ui/main/en/_app/immutable/chunks/index.008de539.js">
		<link rel="modulepreload" href="/docs/chat-ui/main/en/_app/immutable/nodes/0.4de937d1.js">
		<link rel="modulepreload" href="/docs/chat-ui/main/en/_app/immutable/nodes/23.a27b4295.js">
		<link rel="modulepreload" href="/docs/chat-ui/main/en/_app/immutable/chunks/Tip.aeb15ab7.js">
		<link rel="modulepreload" href="/docs/chat-ui/main/en/_app/immutable/chunks/CodeBlock.7b00c886.js">
		<link rel="modulepreload" href="/docs/chat-ui/main/en/_app/immutable/chunks/getInferenceSnippets.562cca10.js"><!-- HEAD_svelte-u9bgzb_START --><meta name="hf:doc:metadata" content="{&quot;title&quot;:&quot;Copy HuggingChat&quot;,&quot;local&quot;:&quot;copy-huggingchat&quot;,&quot;sections&quot;:[{&quot;title&quot;:&quot;Running a copy of HuggingChat locally&quot;,&quot;local&quot;:&quot;running-a-copy-of-huggingchat-locally&quot;,&quot;sections&quot;:[],&quot;depth&quot;:3},{&quot;title&quot;:&quot;Populate database&quot;,&quot;local&quot;:&quot;populate-database&quot;,&quot;sections&quot;:[],&quot;depth&quot;:3}],&quot;depth&quot;:1}"><!-- HEAD_svelte-u9bgzb_END -->      <p></p>  <h1 class="relative group"><a id="copy-huggingchat" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#copy-huggingchat"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>Copy HuggingChat</span></h1> <p data-svelte-h="svelte-w0tuji">The config file for HuggingChat is stored in the <code>chart/env/prod.yaml</code> file. It is the source of truth for the environment variables used for our CI/CD pipeline. For HuggingChat, as we need to customize the app color, as well as the base path, we build a custom docker image. You can find the workflow here.</p>  <div class="course-tip  bg-gradient-to-br dark:bg-gradient-to-r before:border-green-500 dark:before:border-green-800 from-green-50 dark:from-gray-900 to-white dark:to-gray-950 border border-green-50 text-green-700 dark:text-gray-400"><p data-svelte-h="svelte-6hcsws">If you want to make changes to the model config used in production for HuggingChat, you should do so against <code>chart/env/prod.yaml</code>.</p></div>  <h3 class="relative group"><a id="running-a-copy-of-huggingchat-locally" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#running-a-copy-of-huggingchat-locally"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>Running a copy of HuggingChat locally</span></h3> <p data-svelte-h="svelte-uv4sle">If you want to run an exact copy of HuggingChat locally, you will need to do the following first:</p> <ol data-svelte-h="svelte-q3pvdg"><li>Create an <a href="https://huggingface.co/settings/applications/new" rel="nofollow">OAuth App on the hub</a> with <code>openid profile email</code> permissions. Make sure to set the callback URL to something like <code>http://localhost:5173/chat/login/callback</code> which matches the right path for your local instance.</li> <li>Create a <a href="https://huggingface.co/settings/tokens" rel="nofollow">HF Token</a> with your Hugging Face account. You will need a Pro account to be able to access some of the larger models available through HuggingChat.</li> <li>Create a free account with <a href="https://serper.dev/" rel="nofollow">serper.dev</a> (you will get 2500 free search queries)</li> <li>Run an instance of MongoDB, however you want. (Local or remote)</li></ol> <p data-svelte-h="svelte-zq41hb">You can then create a new <code>.env.SECRET_CONFIG</code> file with the following content</p> <div class="code-block relative "><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5   text-gray-600 " title="code excerpt" type="button"><svg class="" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg> <div class="absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0"><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent; "></div> Copied</div></button></div> <pre class=""><!-- HTML_TAG_START --><span class="hljs-attr">MONGODB_URL</span>=&lt;link to your mongo DB from step <span class="hljs-number">4</span>&gt;
<span class="hljs-attr">HF_TOKEN</span>=&lt;your HF token from step <span class="hljs-number">2</span>&gt;
<span class="hljs-attr">OPENID_CONFIG</span>=`{
  PROVIDER_URL: &quot;https://huggingface.co&quot;,
  CLIENT_ID: &quot;&lt;your client ID from step 1&gt;&quot;,
  CLIENT_SECRET: &quot;&lt;your client secret from step 1&gt;&quot;,
}`
<span class="hljs-attr">SERPER_API_KEY</span>=&lt;your serper API key from step <span class="hljs-number">3</span>&gt;
<span class="hljs-attr">MESSAGES_BEFORE_LOGIN</span>=&lt;can be any numerical value, or set to <span class="hljs-number">0</span> to require login&gt;<!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-sece3">You can then run <code>npm run updateLocalEnv</code> in the root of chat-ui. This will create a <code>.env.local</code> file which combines the <code>chart/env/prod.yaml</code> and the <code>.env.SECRET_CONFIG</code> file. You can then run <code>npm run dev</code> to start your local instance of HuggingChat.</p>  <h3 class="relative group"><a id="populate-database" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#populate-database"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>Populate database</span></h3>  <div class="course-tip course-tip-orange bg-gradient-to-br dark:bg-gradient-to-r before:border-orange-500 dark:before:border-orange-800 from-orange-50 dark:from-gray-900 to-white dark:to-gray-950 border border-orange-50 text-orange-700 dark:text-gray-400"><p data-svelte-h="svelte-f6u16w">The <code>MONGODB_URL</code> used for this script will be fetched from <code>.env.local</code>. Make sure it’s correct! The command runs directly on the database.</p></div> <p data-svelte-h="svelte-mg3ner">You can populate the database using faker data using the <code>populate</code> script:</p> <div class="code-block relative "><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5   text-gray-600 " title="code excerpt" type="button"><svg class="" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg> <div class="absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0"><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent; "></div> Copied</div></button></div> <pre class=""><!-- HTML_TAG_START -->npm run populate &lt;flags here&gt;<!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-1d3njku">At least one flag must be specified, the following flags are available:</p> <ul data-svelte-h="svelte-16ks1gz"><li><code>reset</code> - resets the database</li> <li><code>all</code> - populates all tables</li> <li><code>users</code> - populates the users table</li> <li><code>settings</code> - populates the settings table for existing users</li> <li><code>assistants</code> - populates the assistants table for existing users</li> <li><code>conversations</code> - populates the conversations table for existing users</li></ul> <p data-svelte-h="svelte-18qapq6">For example, you could use it like so:</p> <div class="code-block relative "><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5   text-gray-600 " title="code excerpt" type="button"><svg class="" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg> <div class="absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0"><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent; "></div> Copied</div></button></div> <pre class=""><!-- HTML_TAG_START -->npm run populate reset<!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-1fy2q83">to clear out the database. Then login in the app to create your user and run the following command:</p> <div class="code-block relative "><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5   text-gray-600 " title="code excerpt" type="button"><svg class="" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg> <div class="absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0"><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent; "></div> Copied</div></button></div> <pre class=""><!-- HTML_TAG_START -->npm run populate <span class="hljs-built_in">users</span> settings assistants conversations<!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-akoxqx">to populate the database with fake data, including fake conversations and assistants for your user.</p> <a class="!text-gray-400 !no-underline text-sm flex items-center not-prose mt-4" href="https://github.com/huggingface/chat-ui/blob/main/docs/source/developing/copy-huggingchat.md" target="_blank"><span data-svelte-h="svelte-1kd6by1">&lt;</span> <span data-svelte-h="svelte-x0xyl0">&gt;</span> <span data-svelte-h="svelte-1dajgef"><span class="underline ml-1.5">Update</span> on GitHub</span></a>  <p></p> 
			
			<script>
				{
					__sveltekit_1bjd8c = {
						assets: "/docs/chat-ui/main/en",
						base: "/docs/chat-ui/main/en",
						env: {}
					};

					const element = document.currentScript.parentElement;

					const data = [null,null];

					Promise.all([
						import("/docs/chat-ui/main/en/_app/immutable/entry/start.1b3abf1a.js"),
						import("/docs/chat-ui/main/en/_app/immutable/entry/app.9a720b7c.js")
					]).then(([kit, app]) => {
						kit.start(app, element, {
							node_ids: [0, 23],
							data,
							form: null,
							error: null
						});
					});
				}
			</script>