Guides

Start ComIDP

ComIDP provides an intuitive web interface. You can access it through http://localhost to easily experience the relevant functions of ComIDP and enjoy an efficient and accurate interactive experience.

Contact our sales to download the ComIDP deployment installation package. The compressed package structure is as follows:

docker-compose.yml: ComIDP container startup driver file, including basic configuration information for each service
.env: ComIDP service configuration file
init.sql: Database initialization file
service_conf.yaml: ComIDP Rag service connection configuration information
start.sh: ComIDP startup script

Edit the LICENSE_KEY in the .env file to add your License

LICENSE_KEY=your License

Run the start.sh file

sh start.sh

When you see the following message, it means the project has been successfully started:

Running ComIDP_RAG.

ComIDP Configuration

Configure the operating environment information of ComIDP. The key file .env is as follows

# your License Key
# If you do not have a license key, please visit https://compdf.com to
LICENSE_KEY=your License

# The type of doc engine to use.
# Available options:
# - `elasticsearch` (default)
DOC_ENGINE=${DOC_ENGINE:-elasticsearch}
COMIDP_SERVER_IMAGE=compdfkit/comidp-server:2.2.0
COMIDP_ACTUATOR_IMAGE=compdfkit/comidp-actuator:2.2.0
COMIDP_IMAGE=compdfkit/comidp-rag:2.2.0

# ------------------------------
# docker env var for specifying vector db type at startup
# (based on the vector db type, the corresponding docker
# compose profile will be used)
# ------------------------------
COMPOSE_PROFILES=${DOC_ENGINE}

# The version of Elasticsearch.
STACK_VERSION=8.11.3

# The hostname where the Elasticsearch service is exposed
ES_HOST=es01

# The port used to expose the Elasticsearch service to the host machine,
# allowing EXTERNAL access to the service running inside the Docker container.
ES_PORT=1200

# The password for Elasticsearch.
ELASTIC_PASSWORD=comidp_rag

# The maximum amount of the memory, in bytes, that a specific Docker container can use while running.
# Update it according to the available memory in the host machine.
MEM_LIMIT=8073741824

# The User for MySQL.
MYSQL_USER=root
# The password for MySQL.
MYSQL_PASSWORD=comidp_rag
# The hostname where the MySQL service is exposed
MYSQL_HOST=mysql
# The database of the MySQL service to use
MYSQL_DBNAME=comidp
# The port used to expose the MySQL service to the host machine,
# allowing EXTERNAL access to the MySQL database running inside the Docker container.
MYSQL_PORT=5455

# The hostname where the MinIO service is exposed
MINIO_HOST=minio
# The port used to expose the MinIO console interface to the host machine,
# allowing EXTERNAL access to the web-based console running inside the Docker container.
MINIO_CONSOLE_PORT=9001
# The port used to expose the MinIO API service to the host machine,
# allowing EXTERNAL access to the MinIO object storage service running inside the Docker container.
MINIO_PORT=9000
# The username for MinIO.
# When updated, you must revise the `minio.user` entry in service_conf.yaml accordingly.
MINIO_USER=comidp
# The password for MinIO.
# When updated, you must revise the `minio.password` entry in service_conf.yaml accordingly.
MINIO_PASSWORD=comidp_rag

# The hostname where the Redis service is exposed
REDIS_HOST=redis
# The port used to expose the Redis service to the host machine,
# allowing EXTERNAL access to the Redis service running inside the Docker container.
REDIS_PORT=6379
# The password for Redis.
REDIS_PASSWORD=comidp_rag
REDIS_DATABASE=0

# The port used to expose ComIDP's HTTP API service to the host machine,
# allowing EXTERNAL access to the service running inside the Docker container.
SVR_HTTP_PORT=9380

# The local time zone.
TIMEZONE='Asia/Shanghai'

# user registration switch
REGISTER_ENABLED=1
# rabbitMq
MQ_HOST=rabbitmq
MQ_PORT=5672
MQ_USER=admin
MQ_PASSWORD=admin123

Start ComIDP ​

ComIDP Configuration ​

Start ComIDP

ComIDP Configuration