Skip to content

General Application Settings

Core Application Settings

These variables control the core behaviour and environment of the application.

This does not need to be updated if using the provided Docker Compose file. If you change the ports here, make sure you update the relevant ports in the Docker Compose files.

Environment VariableDescriptionTypeDefault Value
BACKEND_PORTPort the main backend service will listen on.number3030
METRICS_PORTPort for Prometheus metrics.number9464
FRONTEND_URLThe base URL of the frontend application.string (URL)http://localhost:3000
BACKEND_URLThe base URL of this backend application.string (URL)http://localhost:3030
NUXT_PUBLIC_API_BASEThe base API endpoint for the frontend to communicate with the backend. See the comments in example.env for more information.string (URL)http://localhost:3030/api
NUXT_PUBLIC_WS_BASEThe base ws endpoint for the frontend to communicate with the backend. See the comments in example.env for more information.string (URL)ws://localhost:3030
TIMEZONEThe timezone the application will operate in.string (e.g., UTC, America/New_York)UTC
CUSTOM_PROMPTA custom prompt to be used in conversation generation.stringnull
ADVANCED_EXTRACTIONExtract text from files using the GPT4o vision capabilities (expensive but highest quality text extraction).true or falsefalse
MAX_WORKERSNumber of files that can be processed in parallel.number3
NO_CHAT_FUNCTIONSSet this to true if you do not want the chat to have access to function calls. This is useful for self-hosted models that either do not support function calling or get easily confused by it.true or falsefalse
INTERNAL_APP_COMMUNICATION_PORTThis is the port used for internal communication between the different backend services. It should not be changed unless you know what you are doing.number3032
MAIN_APP_URLThis is the url for the services to connect to the main backend application. It should not be changed unless you know what you are doing.string (URL)https://acid_backend:3032

Serving Behind a Unique URL (e.g. a Reverse Proxy)

To host the service behind a reverse proxy or otherwise through a custom domain name, you will need to update the following variables: FRONTEND_URL, BACKEND_URL, NUXT_PUBLIC_API_BASE, and NUXT_PUBLIC_WS_BASE. Unfortunately, Microsoft login will not work when served on a unique URL, as the redirect address will not match what is registered in the EntraID portal. Make sure other components, such as storage, are also defined correctly with the correct URLs.

The app currently will not work if self-signed certificates are used. If using a reverse proxy, you will need to either serve the app using HTTP and tell the browser to treat the URL as secure (e.g. by adding it to the Insecure origins treated as secure option at chrome://flags/) OR, and preferably, make sure there is a signed certificate for the app (frontend and backend) and the storage service if also hosting this.

Database Configuration

Weaviate

This does not need to be updated if using the provided Docker Compose file.

Environment VariableDescriptionTypeDefault Value
WEAVIATE_HOSTHostname of the Weaviate instance.stringweaviate
WEAVIATE_PORTPort of the Weaviate instance.string8080
WEAVIATE_SCHEMEConnection scheme for Weaviate (http or https).stringhttp
WEAVIATE_API_KEYAPI key for Weaviate authentication (if enabled).string@5D%t$3b49NWx
WEAVIATE_GRPC_HOSTGRPC host for Weaviatestringweaviate
WEAVIATE_GRPC_PORTPort for GRPC communication.number50051
WEAVIATE_REPLICASNumber of replicas for Weaviate data.number1
WEAVIATE_BACKUP_RESTORE_IDID for Weaviate backup/restore operations.stringnull
WEAVIATE_BACKUP_HOURLY_FREQUENCYHow often (in hours) to perform Weaviate backups.number24

Redis

In-memory data store.

This does not need to be updated if using the provided Docker Compose file.

Environment VariableDescriptionTypeDefault Value
REDIS_URLComma-separated list of Redis connection URLs.string (comma-separated)redis://redis:6379
REDIS_PORTPort used by Redis. Must match the port in the REDIS_URLstring6379
REDIS_PWPassword for Redis authentication.string596Lf6

AcademicID - Smart & ethical AI for academia