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

Next revision		Previous revision
computing:librechat [2026/10/17 18:28] – created oemb1905computing:librechat [2026/10/17 19:46] (current) – oemb1905
Line 1: Line 1:
-# LibreChat Complete Setup Tutorial +------------------------------------------- 
-**Addressed to: Libre** +  * **librechat**  
-Domain: `chat.haacksnetworking.org` +  * **Jonathan Haack** 
-Stack: Debian 13, npm (no Docker for LibreChat), Apache reverse proxy, PM2, MongoDB 8.0, DeepInfra DeepSeek V4 Flash, custom MCP document tools (docx, xlsx, pdf, pptx).+  * **Haack's Networking** 
 +  * **webmaster@haacksnetworking.org**
  
----+-------------------------------------------
  
-## 1. Prerequisites+//librechat//      
  
-```bash+------------------------------------------- 
 + 
 +=== Introduction === 
 +~~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.To begin with, let's install required dependencies, webserver, database, and service manager. 
 + 
 +<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
-``` 
  
-### Node.js 24 
-```bash 
 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
-``` 
  
-### MongoDB 8.0 (Debian 13 uses Bookworm repo) 
-```bash 
 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 28: Line 29:
 sudo apt install -y mongodb-org sudo apt install -y mongodb-org
 sudo systemctl enable --now mongod sudo systemctl enable --now mongod
-``` 
  
-### PM2 
-```bash 
 sudo npm install -g pm2 sudo npm install -g pm2
-```+</code>
  
----+Now, let's clone the librechat repo and setup the virtual environment and the server configuration.
  
-## 2. Install LibreChat +<code>
- +
-```bash+
 cd /opt cd /opt
 sudo git clone https://github.com/LibreChat-AI/LibreChat.git sudo git clone https://github.com/LibreChat-AI/LibreChat.git
Line 46: Line 42:
 cp .env.example .env cp .env.example .env
 nano .env nano .env
-```+</code> 
 + 
 +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:
  
-Essential `.env` values: +<code>
-```env+
 MONGO_URI=mongodb://127.0.0.1:27017/LibreChat MONGO_URI=mongodb://127.0.0.1:27017/LibreChat
  
Line 63: 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>
  
-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.
  
-```bash+<code>
 npm run reinstall npm run reinstall
-npm run backend          # test once, then Ctrl+C+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              # follow the printed command +pm2 startup           
-```+</code>
  
----+You can optionally setup a firewall:
  
-## 3. Apache Reverse Proxy + HTTPS+<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:
  
-### Modules +<code>
-```bash+
 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>
  
-### Certificate +Here is your http vhost ''nano /etc/apache2/sites-available/chat.haacksnetworking.org.conf''
-```bash +
-sudo apt install -y certbot python3-certbot-apache +
-sudo certbot --apache -d chat.haacksnetworking.org +
-```+
  
-### VirtualHost +<code> 
-```apache+<VirtualHost *:80> 
 +    ServerName chat.haacksnetworking.org 
 +    Redirect permanent / https://chat.haacksnetworking.org/ 
 +</VirtualHost> 
 +</code> 
 + 
 +Here is your https vhost ''nano /etc/apache2/sites-available/chat.haacksnetworking.org-le-ssl.conf'' 
 + 
 +<code>
 <VirtualHost *:443> <VirtualHost *:443>
     ServerName chat.haacksnetworking.org     ServerName chat.haacksnetworking.org
Line 104: 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 132: 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> +
-```+
  
-```bash+<code>
 sudo a2ensite librechat sudo a2ensite librechat
 sudo apache2ctl configtest sudo apache2ctl configtest
 sudo systemctl reload apache2 sudo systemctl reload apache2
-```+</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
-```bash +
-sudo ufw allow OpenSSH +
-sudo ufw allow 'Apache Full' +
-sudo ufw enable +
-```+
  
----+<code> 
 +mongosh --quiet --eval 'db = db.getSiblingDB("LibreChat"); db.users.find({}, {email:1, role:1}).pretty()' 
 +</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> 
- +ALLOW_REGISTRATION=false 
-```yaml +</code>
-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" +
- +
-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 +
-``` +
- +
----+
  
-## 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:
  
-```bash+<code>
 cd /opt cd /opt
 mkdir -p /opt/mcp-docs mkdir -p /opt/mcp-docs
Line 199: Line 212:
 source venv/bin/activate source venv/bin/activate
 pip install mcp python-docx openpyxl pandas reportlab python-pptx pip install mcp python-docx openpyxl pandas reportlab python-pptx
-```+</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: 
  
-```python+<code>
 #!/usr/bin/env python3 #!/usr/bin/env python3
 import json import json
Line 379: Line 392:
 if __name__ == "__main__": if __name__ == "__main__":
     mcp.run(transport="stdio")     mcp.run(transport="stdio")
-```+</code>
  
-```bash+<code>
 chmod +x /opt/mcp-docs/server.py chmod +x /opt/mcp-docs/server.py
 mkdir -p /opt/LibreChat/generated_docs mkdir -p /opt/LibreChat/generated_docs
 deactivate deactivate
-``` 
- 
-Restart LibreChat: 
- 
-```bash 
 pm2 restart librechat pm2 restart librechat
-```+</code>
  
----+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:
  
-## 6. Using the Tools +<code>
- +
-1. In a chat, open the tools / MCP menu. +
-2. Add or enable the **document-tools** MCP server. +
-3. Ask for a document. Available tools: +
-   - `create_docx` — Word +
-   - `create_xlsx` — Excel +
-   - `create_pdf` — PDF +
-   - `create_pptx` — PowerPoint +
- +
-Example prompts: +
- +
-- "Create a Word document titled 'Solar System' with paragraphs and bullets about the planets. Give me the download link." +
-- "Make an Excel file named 'Employees' with headers Name, Department, Salary and three sample rows." +
-- "Create a PDF titled 'Monthly Report' with a heading and a few paragraphs." +
-- "Create a PowerPoint titled 'Project Update' with slides for Goals, Progress, and Next Steps." +
- +
-Files appear at `https://chat.haacksnetworking.org/downloads/...`. +
- +
---- +
- +
-## 7. Admin and Registration +
- +
-First account is admin. Verify: +
- +
-```bash +
-mongosh --quiet --eval 'db = db.getSiblingDB("LibreChat"); db.users.find({}, {email:1, role:1}).pretty()' +
-``` +
- +
-To disable public registration, add to `.env`: +
- +
-```env +
-ALLOW_REGISTRATION=false +
-``` +
- +
-Then create users with `npm run create-user`. +
- +
---- +
- +
-## 8. Updates +
- +
-```bash+
 cd /opt/LibreChat cd /opt/LibreChat
 pm2 stop librechat pm2 stop librechat
Line 442: Line 409:
 npm run smart-reinstall npm run smart-reinstall
 pm2 restart librechat pm2 restart librechat
-``` +</code>
- +
---- +
- +
-## Quick Checklist +
- +
-1. Node 24 + MongoDB (Bookworm repo) +
-2. Clone → `.env` (secrets, domains, HOST, DeepInfra key) → `npm run reinstall` +
-3. PM2 +
-4. Apache modules + Certbot + VirtualHost (with `ProxyPass /downloads !` + Alias) +
-5. `librechat.yaml` (DeepSeek + webSearch + mcpServers) +
-6. MCP server in `/opt/mcp-docs` with docx / xlsx / pdf / pptx tools +
-7. Restart LibreChat and enable the document-tools MCP server in chat+
  
-**This is the full working configuration.**+ --- //[[alerts@haacksnetworking.org|oemb1905]] 2026/10/17 19:44//
computing/librechat.1792261710.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