[Question]: Portainer etc. Compatible docker-compose.yml and .env files

[prononext]

What is your question?

Does anyone maybe has a portainer compatible docker-compose.yml and .env file for LibreChat.

I have been trying a long time but there are no clear errors which tell me what .env's are missing in my setup.

It is not really clear what environment variables are required for basic setup.

It would be really nice if someone could share please :-)

More Details

That console logs I get on the librechat service:

LibreChat@0.7.4-rc1 backend
cross-env NODE_ENV=production node api/server/index.js
node:buffer:319
throw new ERR_INVALID_ARG_TYPE(
^
TypeError [ERR_INVALID_ARG_TYPE]: The first argument must be of type string or an instance of Buffer, ArrayBuffer, or Array or an Array-like Object. Received undefined
at Function.from (node:buffer:319:9)
at Object. (/app/api/server/utils/crypto.js:4:20)
at Module._compile (node:internal/modules/cjs/loader:1358:14)
at Module._extensions..js (node:internal/modules/cjs/loader:1416:10)
at Module.load (node:internal/modules/cjs/loader:1208:32)
at Module._load (node:internal/modules/cjs/loader:1024:12)
at Module.require (node:internal/modules/cjs/loader:1233:19)
at require (node:internal/modules/helpers:179:18)
at Object. (/app/api/server/utils/index.js:7:21)
at Module._compile (node:internal/modules/cjs/loader:1358:14) {
code: 'ERR_INVALID_ARG_TYPE'
}
Node.js v20.14.0
npm notice
npm notice New minor version of npm available! 10.7.0 -> 10.8.1
npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.8.1
npm notice To update run: npm install -g npm@10.8.1
npm notice

What is the main subject of your question?

Installation

Screenshots

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[danny-avila]

I believe @fuegovic has a portainer setup, I forget where he has it hosted so pinging for help

[fuegovic]

Here's my portainer compose file, just map the volumes to somewhere that make sense for your setup:

version: "3.9"

services:

  # LibreChat
  api:
    container_name: LibreChat
    image: ghcr.io/danny-avila/librechat-dev:latest
    ports:
      - "${PORT}:${PORT}"
    restart: always
    env_file:
      - stack.env
    volumes:
      - C:/data/LibreChat/images:/app/client/public/images
      - C:/data/LibreChat/uploads/temp:/app/uploads/temp
      - C:/data/LibreChat/api/logs:/app/api/logs/ 
      - C:/data/LibreChat/app/data:/app/app/data
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:3080/health"]
      interval: 30s
      timeout: 5s
      retries: 3

  # Meilisearch
  meilisearch:
    container_name: Meilisearch
    image: getmeili/meilisearch:latest
    ports:
      - 7700:7700
    restart: always
    env_file:
      - stack.env
    volumes:
      - C:/data/LibreChat/meili_data_v1.8:/meili_data
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:7700/health"]
      interval: 30s
      timeout: 5s
      retries: 3

  #Vectordb
  vectordb:
    container_name: VectorDB
    image: ankane/pgvector:latest
    restart: always
    environment:
      POSTGRES_DB: librechat
      POSTGRES_USER: username
      POSTGRES_PASSWORD: password
    volumes:
      - C:/data/LibreChat/pgdata2:/var/lib/postgresql/data
    ports:
      - "5432:5432"

  #RAG API
  rag_api:
    container_name: RAG-API
    image: ghcr.io/danny-avila/librechat-rag-api-dev:latest
    restart: always
    environment:
      - DB_HOST=vectordb
      - DB_PORT=5432
      - POSTGRES_DB=librechat
      - POSTGRES_USER=username
      - POSTGRES_PASSWORD=password
    ports:
      - "8008:8000"
    depends_on:
      - vectordb
    env_file:
      - stack.env

volumes:
  pgdata2:

And .env config:

APP_TITLE=LibreChat
HOST=0.0.0.0
PORT=3080
MONGO_URI=
DOMAIN_CLIENT=https://librechat.example.com
DOMAIN_SERVER=https://librechat.example.com
NO_INDEX=true
------=
DEBUG_LOGGING=true
DEBUG_CONSOLE=false
PROXY=
------=
ENDPOINTS=openAI,chatGPTBrowser,gptPlugins,assistants,anthropic,bingAI,google,customgpt
---=
CONFIG_PATH="https://raw.githubusercontent.com/fuegovic/lc-config-yaml/main/librechat.yaml"
---=
ANYSCALE_API_KEY=user_provided
APIPIE_API_KEY=user_provided
COHERE_API_KEY=user_provided
FIREWORKS_API_KEY=user_provided
GROQ_API_KEY=user_provided
HUGGINGFACE_TOKEN=user_provided
MISTRAL_API_KEY=user_provided
OPENROUTER_KEY=user_provided
PERPLEXITY_API_KEY=user_provided
SHUTTLEAI_API_KEY=user_provided
TOGETHERAI_API_KEY=user_provided
---=
ANTHROPIC_API_KEY=user_provided
---=
BINGAI_TOKEN=user_provided
---=
GOOGLE_KEY=user_provided
---=
OPENAI_API_KEY=user_provided
ASSISTANTS_API_KEY=user_provided
DEBUG_OPENAI=false
DEBUG_PLUGINS=true
------=
CREDS_KEY=
CREDS_IV=
---=
SEARCH=true
MEILI_NO_ANALYTICS=true
MEILI_HOST=http://host.docker.internal:7700
MEILI_MASTER_KEY=DrhYf7zENyR6AlUCKmnz0eYASOQdl6zxH7s7MKFSfFCt
------=
OPENAI_MODERATION=false
OPENAI_MODERATION_API_KEY=
BAN_VIOLATIONS=true
BAN_DURATION=1000 * 60 * 60 * 2
BAN_INTERVAL=20
LOGIN_VIOLATION_SCORE=1
REGISTRATION_VIOLATION_SCORE=1
CONCURRENT_VIOLATION_SCORE=1
MESSAGE_VIOLATION_SCORE=1
NON_BROWSER_VIOLATION_SCORE=20
LOGIN_MAX=7
LOGIN_WINDOW=5
REGISTER_MAX=5
REGISTER_WINDOW=60
LIMIT_CONCURRENT_MESSAGES=true
CONCURRENT_MESSAGE_MAX=2
LIMIT_MESSAGE_IP=true
MESSAGE_IP_MAX=40
MESSAGE_IP_WINDOW=1
LIMIT_MESSAGE_USER=false
MESSAGE_USER_MAX=40
MESSAGE_USER_WINDOW=1
---=
CHECK_BALANCE=false
------=
ALLOW_EMAIL_LOGIN=true
ALLOW_REGISTRATION=true
ALLOW_SOCIAL_LOGIN=true
ALLOW_SOCIAL_REGISTRATION=true
---=
SESSION_EXPIRY=1000 * 60 * 15
REFRESH_TOKEN_EXPIRY=(1000 * 60 * 60 * 24) * 7
---=
JWT_SECRET=
JWT_REFRESH_SECRET=
------=
RAG_API_URL=http://host.docker.internal:8008
DB_HOST=vectordb
DB_PORT=5432
EMBEDDINGS_PROVIDER=huggingface
HF_TOKEN=

Note:

• The librechat.yaml config files I use are publicly hosted here: https://github.com/fuegovic/lc-config-yaml you can choose one that fits your needs in my collection or provide your own with a publicly accessible URL ( CONFIG_PATH= )
• I use Mongodb Atlas, so you'll need to provide your own MONGO_URI=, see: https://www.librechat.ai/docs/configuration/mongodb/mongodb_atlas
• Update your DOMAIN_CLIENT= and DOMAIN_SERVER= to point to your own domain (required if you enable social auth)
• You should generate new CREDS_KEY=, CREDS_IV=, JWT_SECRET= and JWT_REFRESH_SECRET= with this tool: https://www.librechat.ai/toolkit/creds_generator
• I use HF for embeding, with this setup you also need to provide a Hugging Face (write) token, HF_TOKEN= , see: https://www.librechat.ai/docs/configuration/rag_api#custom-configuration---hugging-face
• I've set every API key to user_provided in the example .env above but you can replace that with your actual keys
• Refer to our docs for other config options (like social logins, firebase, etc.) see: https://www.librechat.ai/docs/configuration

[prononext]

I somehow continue to get an error when trying to upload files:

error: There was an uncaught error: EACCES: permission denied, mkdir '/app/uploads/temp/6675f0724f8ac21e41a80d3a

[prononext]

Just Missing Image Support for Docker Secrets and I can Provide a fully secure, portainer compatible Compose File 🙏

[aauro]

Just Missing Image Support for Docker Secrets and I can Provide a fully secure, portainer compatible Compose File 🙏

any update? I'm struggling a bit as well. thank you

[prononext]

@aauro Is there any Secrets Support on the Docker image now?

[scholzri]

I somehow continue to get an error when trying to upload files:

error: There was an uncaught error: EACCES: permission denied, mkdir '/app/uploads/temp/6675f0724f8ac21e41a80d3a

@prononext I get the same error and then the librechat container crashes. Did you eventually solve this issue?