Coze Loop

Deployment method 1: Docker deployment (Docker Compose)

Please install and start Docker Engine before you start.

Procedure:

1. Clone the source code. Run the following command to obtain the latest version of the Coze Loop source code.

   # Clone the code
   git clone https://github.com/coze-dev/coze-loop.git

   # Enter the coze-loop directory
   cd coze-loop
   

2. Configure a model. 1. Enter the coze-loop directory. 2. Edit the file release/deployment/docker-compose/conf/model_config.yaml. 3. Modify the api_key and model fields. Take Volcengine Ark as an example: api_key: Volcengine Ark API Key. Users in China can refer to the Volcengine Ark documentation, while users outside China can refer to the BytePlus ModelArk documentation. model: The Endpoint ID of the Volcengine Ark model access point. Users within China can refer to the Volcengine Ark documentation; users outside China can refer to the BytePlus ModelArk documentation. 3. Start the service. Run the following commands to quickly deploy the open-source version of Coze Loop using Docker Compose.

   # Start the service (default: development mode)
   # Run in the coze-loop/ directory
   make compose-up
   

1. Access the Coze Loop open-source version through your browser http://localhost:8082.

Deployment method 2: Kubernetes deployment using Helm Chart

The Kubernetes cluster has been prepared, the Nginx Ingress add-ons have been enabled, and the Kubectl and Helm tools have been installed. To quickly try it out locally, you can deploy a Kubernetes cluster using Minikube. For detailed steps, refer to Quick Start.

Procedure:

1. Run the following command to obtain the Helm Chart package.

   helm pull oci://docker.io/cozedev/coze-loop --version 1.0.0-helm
   tar -zxvf coze-loop-1.0.0-helm.tgz && cd coze-loop && rm -f ../coze-loop-1.0.0-helm.tgz
   

2. Configure a model. Go to the coze-loop directory and edit the release/deployment/helm-chart/umbrella/conf/model_config.yaml file. Configure the following fields, using Volcengine Ark as an example: api_key: Volcengine Ark API Key. Users in mainland China can refer to the Volcengine Ark documentation, while users outside mainland China can refer to the BytePlus ModelArk documentation. model: The Endpoint ID of the Volcengine Ark model access point. Users in China can refer to the Volcengine Ark documentation, while users outside China can refer to the BytePlus ModelArk documentation. 3. Configure Ingress rules. Ingress is used to expose services to external networks. You need to configure the templates/ingress.yaml file in the project directory according to the actual cluster situation, manually modify parameters such as ingressClassName, and configure elements such as class, instance, host, and IP allocation. 4. Deploy and start the service. Execute the following commands to quickly deploy the open-source version of Coze Loop using Helm.

   # Run in the coze-loop/ directory
   make helm-up
   # After the service deployment is complete, check the status of the cluster pods
   make helm-pod
   # Check the service startup logs. If both the app and nginx are running normally, the deployment is successful
   make helm-logf-app
   make helm-logf-nginx
   

5. Access the Coze Loop open source edition via a browser. The access domain name and URL depend on the domain name and URL assigned to your cluster. 6. Start customizing your Coze Loop project. Refer to the examples in the examples/ directory. Modify values.yaml to override the default settings. After making changes, rerun make helm-up for the changes to take effect.

[!WARNING] If you want to deploy Coze Loop in a public network environment, it is recommended to assess security risks before you begin, and take corresponding protection measures. Possible security risks include account registration functions, Coze Server listening address configurations, SSRF (Server - Side Request Forgery), and some horizontal privilege escalations in APIs. For more details, refer to Quickstart.

Quick Start

Refer to Quick Start to learn in detail how to install and deploy the latest version of Coze Loop.

Developer guide

• System architecture: Learn about the technical architecture and core components of Coze Loop Open-source Edition.
• Startup mode: When installing and deploying Coze Loop Open-source Edition, the default development mode allows backend file modifications without requiring service redeployment.
• Model configuration: Coze Loop Open-source Edition supports various LLM models through the Eino framework. Refer to this document to view the supported model list and learn how to configure models.
• Code development and testing: Learn how to perform secondary development and testing based on Coze Loop Open-source Edition.
• Fault troubleshooting: Learn how to check container status and system logs.