Skip to main content

Configuration

Email​

To send emails, you will have to configure the email driver. This is necessary for inviting new users to your workspace.
Docmost supports both SMTP and Postmark email drivers.

Using SMTP​

MAIL_DRIVER=smtp
SMTP_HOST=
SMTP_PORT=
SMTP_USERNAME=
SMTP_PASSWORD=
SMTP_SECURE=
MAIL_FROM_ADDRESS=[email protected]
MAIL_FROM_NAME=Docmost

Using Postmark:​

MAIL_DRIVER=postmark
POSTMARK_TOKEN=
MAIL_FROM_ADDRESS=[email protected]
MAIL_FROM_NAME=Docmost

File Storage​

Docmost supports local storage, S3-compatible storage, and Azure Blob Storage drivers. The default driver is local storage.

STORAGE_DRIVER=local

Using S3-Compatible Storage​

If you wish to use an S3-compatible storage, you have to add the below environment variables:

STORAGE_DRIVER=s3
AWS_S3_ACCESS_KEY_ID=
AWS_S3_SECRET_ACCESS_KEY=
AWS_S3_REGION=
AWS_S3_BUCKET=
AWS_S3_ENDPOINT=
AWS_S3_FORCE_PATH_STYLE=

Being S3-compatible means Docmost can work with AWS S3, Backblaze, Wasabi, DigitalOcean Spaces, Minio, and other S3-compatible providers.

Using Azure Blob Storage​

If you wish to use Azure Blob Storage, you have to add the below environment variables:

STORAGE_DRIVER=azure
AZURE_STORAGE_ACCOUNT_NAME=
AZURE_STORAGE_ACCOUNT_KEY=
AZURE_STORAGE_CONTAINER=

File upload size limit​

The maximum file size that can be uploaded on the editor.

FILE_UPLOAD_SIZE_LIMIT=100mb

File import size limit​

The maximum size limit for an import file.

FILE_IMPORT_SIZE_LIMIT=200mb

AI​

OpenAI / Azure OpenAI​

AI_DRIVER=openai
OPENAI_API_KEY=sk-proj-xxxxxxxxxxxxx
AI_EMBEDDING_MODEL=text-embedding-3-small
AI_COMPLETION_MODEL=gpt-4o-mini
# optional
OPENAI_API_URL=
# AI_EMBEDDING_SUPPORTS_MRL=false

OpenAI-Compatible​

AI_DRIVER=openai-compatible
OPENAI_API_KEY=your-api-key
OPENAI_API_URL=https://api.your_provider.com/v1
AI_EMBEDDING_MODEL=your-embedding-model
AI_COMPLETION_MODEL=your-completion-model
# optional
AI_EMBEDDING_DIMENSION=1024
AI_EMBEDDING_SUPPORTS_MRL=false

Google Gemini​

AI_DRIVER=gemini
GEMINI_API_KEY=AIzaSyxxxxx
AI_EMBEDDING_MODEL=gemini-embedding-001
AI_COMPLETION_MODEL=gemini-2.5-flash

Ollama​

AI_DRIVER=ollama
OLLAMA_API_URL=http://localhost:11434
AI_EMBEDDING_MODEL=nomic-embed-text
AI_COMPLETION_MODEL=qwen2.5:7b

By default, Docmost uses the database for full-text search. In the paid editions, you can optionally configure Typesense as the search driver for improved search performance and relevance.

Using Typesense​

You can add the Typesense compose service to your existing Docmost docker-compose.yml file. See Typesense installation guide.

  typesense:
    image: typesense/typesense:30.1
    restart: on-failure
    ports:
      - "8108:8108"
    volumes:
      - ./typesense-data:/data
    command: '--data-dir /data --api-key=YOUR_KEY --enable-cors'

Environment variables:

SEARCH_DRIVER=typesense
TYPESENSE_API_KEY=YOUR_KEY
TYPESENSE_URL=http://localhost:8108
TYPESENSE_LOCALE=en

Iframe embedding​

Docmost blocks other origins from embedding your instance in an <iframe> by default.

Public shared pages (/share/...) are exempt and can always be embedded from any origin, regardless of the settings below.

Allow embedding from any origin​

IFRAME_EMBED_ALLOWED=true

When IFRAME_EMBED_ALLOWED=true and no allowlist is provided, Docmost emits no framing header, so any origin can embed it.

Allow embedding from specific origins​

IFRAME_EMBED_ALLOWED=true
IFRAME_ALLOWED_ORIGINS=https://intranet.example.com,https://portal.example.com

Integrations​

To preview links from external tools, follow the integration guides for provider setup, workspace installation, and account connections.

See integration environment variables for the configuration reference.

Telemetry​

We anonymously collect the active version, user count, page count, space and workspace count. To disable telemetry:

DISABLE_TELEMETRY=true

Refer to the Environment Variables to see all available environment variables.