Haack's Wiki

User Tools

Site Tools

Trace:
computing:librechat

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
computing:librechat [2026/10/17 18:42] – oemb1905computing:librechat [2026/10/17 19:46] (current) – oemb1905
Line 13: Line 13:
 === Introduction === === Introduction ===
 ~~NOTOC~~ ~~NOTOC~~
-This is a tutorial for Debian users to setup Librechat and attach a custom API to it. I chose to use Deepinfra for cost and speed reasons, but/and used the open weight DeepSeek v4 Flash model via the Deepinfra API. I also built an MCP server to create docx, xlsx, pptx, and pdf files using python under the hood. Lastly, I used the built-in and free keenable service so that the chat could scrape websites. I've tested some common tasks that from other fully proprietary offerings and so far, so good. I prefer apache reverse proxies over nginx so I also included the vhost config I'm using, which includes the download directory for the MCP server and tooling. Librechat has two installation methods: npm or docker and I chose npm. Service management and systemd unit building is handled by pm2, an npm-based service manager that automatically cuts your systemd unit. +This is a tutorial for Debian users to setup Librechat and attach a custom API to it. I chose to use Deepinfra for cost and speed reasons, but/and used the open weight DeepSeek v4 Flash model via the Deepinfra API. I also built an MCP server to create docx, xlsx, pptx, and pdf files using python under the hood. Lastly, I used the built-in and free keenable service so that the chat could scrape websites.To begin with, let's install required dependencies, webserver, database, and service manager.
- +
-===== 1. Prerequisites =====+
  
 <code> <code>
 sudo apt update && sudo apt upgrade -y sudo apt update && sudo apt upgrade -y
 sudo apt install -y git build-essential curl gnupg python3-pip python3-venv sudo apt install -y git build-essential curl gnupg python3-pip python3-venv
-</code> 
  
-==== Node.js 24 ==== 
- 
-<code> 
 curl -fsSL https://deb.nodesource.com/setup_24.x | sudo -E bash - curl -fsSL https://deb.nodesource.com/setup_24.x | sudo -E bash -
 sudo apt install -y nodejs sudo apt install -y nodejs
 sudo npm install -g npm@11 sudo npm install -g npm@11
 node -v && npm -v node -v && npm -v
-</code> 
  
-==== MongoDB 8.0 (Debian 13 uses Bookworm repo) ==== 
- 
-<code> 
 wget -qO - https://www.mongodb.org/static/pgp/server-8.0.asc | sudo gpg --dearmor -o /usr/share/keyrings/mongodb-server-8.0.gpg wget -qO - https://www.mongodb.org/static/pgp/server-8.0.asc | sudo gpg --dearmor -o /usr/share/keyrings/mongodb-server-8.0.gpg
 echo "deb [ signed-by=/usr/share/keyrings/mongodb-server-8.0.gpg ] https://repo.mongodb.org/apt/debian bookworm/mongodb-org/8.0 main" | sudo tee /etc/apt/sources.list.d/mongodb-org-8.0.list echo "deb [ signed-by=/usr/share/keyrings/mongodb-server-8.0.gpg ] https://repo.mongodb.org/apt/debian bookworm/mongodb-org/8.0 main" | sudo tee /etc/apt/sources.list.d/mongodb-org-8.0.list
Line 39: Line 29:
 sudo apt install -y mongodb-org sudo apt install -y mongodb-org
 sudo systemctl enable --now mongod sudo systemctl enable --now mongod
-</code> 
  
-==== PM2 ==== 
-<code> 
 sudo npm install -g pm2 sudo npm install -g pm2
 </code> </code>
  
-===== 2. Install LibreChat =====+Now, let's clone the librechat repo and setup the virtual environment and the server configuration.
  
 <code> <code>
Line 57: Line 44:
 </code> </code>
  
-Essential ''.env'' values:+Email and other add-ons and other niceties and such can all be set up later to one's liking and as they see fit. The bare bones requirements are: 
 <code> <code>
 MONGO_URI=mongodb://127.0.0.1:27017/LibreChat MONGO_URI=mongodb://127.0.0.1:27017/LibreChat
Line 72: Line 60:
 HOST=127.0.0.1 HOST=127.0.0.1
  
 +# This creates an env variable for your deepinfra key, which gets called in librechat.yaml
 DEEPINFRA_API_KEY=sk-di-your_key_here DEEPINFRA_API_KEY=sk-di-your_key_here
 </code> </code>
  
-Generate secrets with ''openssl rand -hex 32'' and ''openssl rand -hex 16'' for the IV.+Use ''openssl rand -hex 32'' and ''openssl rand -hex 16'' for the IV in order to generate secrets. Start service for first time and debug. Once it is functional and working - not before - then run the pm2 commands which will auto-generate systemd units and give you control of them with pm2 commands.
  
 <code> <code>
 npm run reinstall npm run reinstall
-npm run backend #test, debug, then use pm2 instead         +npm run backend #test, debug, then use pm2 instead       
 pm2 start npm --name librechat -- run backend pm2 start npm --name librechat -- run backend
 pm2 save pm2 save
-pm2 startup              +pm2 startup          
 </code> </code>
  
-===== 3. Apache Reverse Proxy + HTTPS =====+You can optionally setup a firewall: 
 + 
 +<code> 
 +sudo ufw allow OpenSSH 
 +sudo ufw allow 'Apache Full' 
 +sudo ufw enable 
 +</code> 
 + 
 + 
 +Create or edit ''/opt/LibreChat/librechat.yaml'': 
 + 
 +<code> 
 + 
 +# minimum information and parameters 
 +version: 1.3.17 
 +cache: true 
 + 
 +endpoints: 
 +  custom: 
 +    - name: "DeepInfra DeepSeek" 
 +      apiKey: "${DEEPINFRA_API_KEY}" 
 +      baseURL: "https://api.deepinfra.com/v1/openai" 
 +      models: 
 +        default: ["deepseek-ai/DeepSeek-V4-Flash"] 
 +        fetch: false 
 +      titleConvo: true 
 +      titleModel: "deepseek-ai/DeepSeek-V4-Flash" 
 +      modelDisplayLabel: "DeepSeek V4 Flash" 
 + 
 +# this is a built in and free in cost web scraper  
 +webSearch: 
 +  searchProvider: "keenable" 
 +  scraperProvider: "keenable" 
 +  rerankerType: "none" 
 + 
 +# don't add this block until after initial setup and when you later create the mcp server 
 +mcpServers: 
 +  document-tools: 
 +    type: stdio 
 +    command: /opt/mcp-docs/venv/bin/python 
 +    args: 
 +      - /opt/mcp-docs/server.py 
 +    timeout: 60000 
 +</code> 
 + 
 +pm2 restart librechat  
 + 
 +Once librechat is running properly under pm2, the next most important step is setting up the apache reverse proxy and setting up the admin account. I just use the default apache virtual host for the domain, let apache cut and generate the cert using the non-RP vhost config, and then once the librechat service is running locally, I swap the virtual hosts with the reverse proxy versions instead and then restart the service. Here are the packages and the cert cutting commands:
  
 <code> <code>
 sudo a2enmod proxy proxy_http proxy_wstunnel ssl rewrite headers socache_shmcb sudo a2enmod proxy proxy_http proxy_wstunnel ssl rewrite headers socache_shmcb
 sudo systemctl restart apache2 sudo systemctl restart apache2
 +sudo apt install certbot letsencrypt python3-certbot-apache
 +sudo certbot --authenticator standalone --installer apache -d chat.haacksnetworking.org --pre-hook "systemctl stop apache2" --post-hook "systemctl start apache2"
 </code> </code>
 +
 +Here is your http vhost ''nano /etc/apache2/sites-available/chat.haacksnetworking.org.conf''
  
 <code> <code>
-sudo apt install -y certbot python3-certbot-apache +<VirtualHost *:80> 
-sudo certbot --apache -d chat.haacksnetworking.org+    ServerName chat.haacksnetworking.org 
 +    Redirect permanent / https://chat.haacksnetworking.org/ 
 +</VirtualHost>
 </code> </code>
  
-==== VirtualHost ====+Here is your https vhost ''nano /etc/apache2/sites-available/chat.haacksnetworking.org-le-ssl.conf''
  
 <code> <code>
Line 110: Line 152:
     ProxyRequests Off     ProxyRequests Off
  
-    # Exclude downloads from proxy (must come before ProxyPass /)+    # Exclude downloads from proxy - must come before ProxyPass / 
 +    # You create this down below for MCP downloads
     ProxyPass /downloads !     ProxyPass /downloads !
     Alias /downloads /opt/LibreChat/generated_docs     Alias /downloads /opt/LibreChat/generated_docs
Line 138: Line 181:
     CustomLog ${APACHE_LOG_DIR}/librechat-access.log combined     CustomLog ${APACHE_LOG_DIR}/librechat-access.log combined
 </VirtualHost> </VirtualHost>
 +</code>
  
-<VirtualHost *:80> +Once you swap the vhosts with the reverse proxy configs you enable the vhosts, check the config, and reload the latest apache2 config for the currently running service.
-    ServerName chat.haacksnetworking.org +
-    Redirect permanent / https://chat.haacksnetworking.org/ +
-</VirtualHost> +
-</code>+
  
 <code> <code>
Line 151: Line 191:
 </code> </code>
  
-==== Firewall ====+You can now go to your domain.com in your web browser and setup your admin account. Make sure to verify it with mongodb on the backend. After setting up the account, run
  
 <code> <code>
-sudo ufw allow OpenSSH +mongosh --quiet --eval 'db = db.getSiblingDB("LibreChat"); db.users.find({}, {email:1, role:1}).pretty()'
-sudo ufw allow 'Apache Full' +
-sudo ufw enable+
 </code> </code>
  
-===== 4. librechat.yaml (DeepSeek + Web Search + MCP) ===== +If you want to disable public registration, add the following to ''/opt/LibreChat/.env'':
- +
-Create or edit ''/opt/LibreChat/librechat.yaml'':+
  
 <code> <code>
-version: 1.3.17 +ALLOW_REGISTRATION=false
-cache: true +
- +
-endpoints: +
-  custom: +
-    - name: "DeepInfra DeepSeek" +
-      apiKey: "${DEEPINFRA_API_KEY}" +
-      baseURL: "https://api.deepinfra.com/v1/openai" +
-      models: +
-        default: ["deepseek-ai/DeepSeek-V4-Flash"] +
-        fetch: false +
-      titleConvo: true +
-      titleModel: "deepseek-ai/DeepSeek-V4-Flash" +
-      modelDisplayLabel: "DeepSeek V4 Flash" +
- +
-webSearch: +
-  searchProvider: "keenable" +
-  scraperProvider: "keenable" +
-  rerankerType: "none" +
- +
-mcpServers: +
-  document-tools: +
-    type: stdio +
-    command: /opt/mcp-docs/venv/bin/python +
-    args: +
-      - /opt/mcp-docs/server.py +
-    timeout: 60000+
 </code> </code>
  
-===== 5. MCP Document-Tools Server (docx, xlsx, pdf, pptx) =====+Then create users with ''npm run create-user'' and just enter the parameters and restart the service. Once you are logged in, select the model you attached in the upper left drop down menu and test it for functionality. So long as it is working, you can now move on to creating an mcp server to do some common tasks like create docx, xlsx, pptx, and pdf files. Here's what I came up with:
  
 <code> <code>
Line 204: Line 214:
 </code> </code>
  
-Create ''/opt/mcp-docs/server.py'':+Create ''/opt/mcp-docs/server.py'' and create python programs that do the various tasks on the host/vm running librechat: 
  
 <code> <code>
Line 388: Line 398:
 mkdir -p /opt/LibreChat/generated_docs mkdir -p /opt/LibreChat/generated_docs
 deactivate deactivate
-</code> 
- 
-Restart LibreChat: 
- 
-<code> 
 pm2 restart librechat pm2 restart librechat
 </code> </code>
  
-===== 6. Admin Registration and Verification ===== +The python above is 4 programs that do each of the various tasks of creating doc files, spreadsheets, powerpoints, and pdfs. You can customize names to your preference. I have not gotten to the point of needing to update yet, but/and the barebones update pathway would be something like this:
- +
-First account is admin. Verify: +
-<code> +
-mongosh --quiet --eval 'db = db.getSiblingDB("LibreChat"); db.users.find({}, {email:1, role:1}).pretty()' +
-</code> +
- +
-To disable public registration, add to ''.env'': +
- +
-<code> +
-ALLOW_REGISTRATION=false +
-</code> +
- +
-Then create users with ''npm run create-user''. +
- +
-===== 8. Updates =====+
  
 <code> <code>
Line 421: Line 411:
 </code> </code>
  
-When time permits, I will add more explanation and step-through comments above. + --- //[[alerts@haacksnetworking.org|oemb1905]] 2026/10/17 19:44//
- +
- --- //[[alerts@haacksnetworking.org|oemb1905]] 2026/10/17 18:31//+
computing/librechat.1792262557.txt.gz · Last modified: by oemb1905

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: GNU Free Documentation License 1.3
GNU Free Documentation License 1.3 Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki