gmakstutis/ragflow
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
ragflow/docker
History
writinwaters ab6e6019a7
Added a list of supported models (#3214) 
### What problem does this PR solve?

_Briefly describe what this PR aims to solve. Include background context
that will help reviewers understand the purpose of the PR._

### Type of change


- [x] Documentation Update
2024-11-05 15:21:37 +08:00
..
nginx add nginx path for sdk handlers (#2899) (#2900) 2024-10-21 09:47:45 +08:00
.env Refactor README on different docker version. (#2775) 2024-10-10 15:30:32 +08:00
docker-compose-admin-tool.yml Added kibana (#2286) 2024-09-06 16:02:44 +08:00
docker-compose-base.yml Replaced redis with Valkey (#3164) 2024-11-02 20:05:12 +08:00
docker-compose-CN-oc9.yml added back oc9 (#2663) 2024-09-29 18:32:48 +08:00
docker-compose-gpu-CN-oc9.yml added back oc9 (#2663) 2024-09-29 18:32:48 +08:00
docker-compose-gpu.yml Fix docker file bugs (#2662) 2024-09-29 18:24:24 +08:00
docker-compose.yml allowing docker container to access service on host (#2895) 2024-10-23 16:43:21 +08:00
entrypoint.sh Fix error commands (#2778) 2024-10-10 10:38:57 +08:00
init-kibana.sh Added kibana (#2286) 2024-09-06 16:02:44 +08:00
init.sql Format file format from Windows/dos to Unix (#1949) 2024-08-15 09:17:36 +08:00
launch_backend_service.sh Add build image and launch from source in README (#2658) 2024-09-29 16:28:07 +08:00
README.md Added a list of supported models (#3214) 2024-11-05 15:21:37 +08:00
service_conf.yaml Updated README on debugging web and python (#2544) 2024-09-24 11:46:03 +08:00

README.md

README

Docker environment variables

Look into .env, there're some important variables.

  • STACK_VERSION
    The Elasticsearch version. Defaults to 8.11.3

  • ES_PORT
    Port to expose Elasticsearch HTTP API to the host. Defaults to 1200.

  • ELASTIC_PASSWORD
    The Elasticsearch password.

  • MYSQL_PASSWORD
    The MySQL password. When updated, you must also revise the mysql.password entry in service_conf.yaml accordingly.

  • MYSQL_PORT
    The exported port number of MySQL Docker container, needed when you access the database from outside the docker containers.

  • MINIO_USER
    The MinIO username. When updated, you must also revise the minio.user entry in service_conf.yaml accordingly.

  • MINIO_PASSWORD
    The MinIO password. When updated, you must also revise the minio.password entry in service_conf.yaml accordingly.

  • SVR_HTTP_PORT
    The port number on which RAGFlow's backend API server listens.

  • RAGFLOW-IMAGE
    The Docker image edition. Available options:

    • infiniflow/ragflow:dev-slim (default): The RAGFlow Docker image without embedding models
    • infiniflow/ragflow:dev: The RAGFlow Docker image with embedding models. See the

  • TIMEZONE
    The local time zone.

Service Configuration

service_conf.yaml defines the system-level configuration for RAGFlow and is used by RAGFlow's API server and task executor.

  • ragflow

    • host: The IP address of the API server.
    • port: The serving port of API server.

  • mysql

    • name: The database name in MySQL used by RAGFlow.
    • user: The database name in MySQL used by RAGFlow.
    • password: The database password. When updated, you must also revise the MYSQL_PASSWORD variable in .env accordingly.
    • port: The serving port of MySQL inside the container. When updated, you must also revise the MYSQL_PORT variable in .env accordingly.
    • max_connections: The maximum database connection.
    • stale_timeout: The timeout duration in seconds.

  • minio

    • user: The MinIO username. When updated, you must also revise the MINIO_USER variable in .env accordingly.
    • password: The MinIO password. When updated, you must also revise the MINIO_PASSWORD variable in .env accordingly.
    • host: The serving IP and port inside the docker container. This is not updating until changing the minio part in docker-compose.yml

  • user_default_llm
    Newly signed-up users use LLM configured by this part; otherwise, you need to configure your own LLM on the Settings page.

    • factory: The LLM suppliers. "OpenAI"， "Tongyi-Qianwen", "ZHIPU-AI", "Moonshot", "DeepSeek", "Baichuan", and "VolcEngine" are supported.
    • api_key: The API key for the specified LLM.

  • oauth
    The OAuth configuration for signing up or signing in to RAGFlow using a third-party account.

    • github: Go to Github, register a new application, the client_id and secret_key will be given.