2. Quickstart

Requirements

Before installing Coze Studio, ensure that your software and hardware environment meets the following requirements:

Requirements	Description
CPU	2 Core
RAM	4 GiB
Docker	Install Docker and Docker Compose in advance, and start the Docker service. For detailed instructions, refer to the Docker documentation: * macOS: It is recommended to use Docker Desktop for installation. Refer to the Docker Desktop For Mac installation guide. * Linux: Refer to the Docker installation guide and the Docker Compose installation guide. * Windows: It is recommended to install using Docker Desktop. Refer to the Docker Desktop For Windows installation guide.

Install Coze Studio

For a simplified deployment process, a one-click solution is available on Volcengine.

Step 1: Clone the source code

Run the following commands in your local project to clone the latest version of the Coze Studio source code.

Clone code
git clone https://github.com/coze-dev/coze-studio.git

Step 2: Deploy and start services

The initial deployment and startup of Coze Studio require retrieving images and building local images. This process may take some time, so please be patient. If you see the message "Container coze-server Started", it means that the Coze Studio service has started successfully.

cd coze-studio
# start service
# for macOS or Linux
make web  
# for windows
cp .env.example .env
docker compose -f ./docker/docker-compose.yml up

Step 3: Register

Register an account by visiting http://localhost:8888/sign, entering your username and password, and clicking the Register button.

Step 4: Configure a model

Configure the model at http://localhost:8888/admin/#model-management by adding a new model.

Step 5: Access the service

Visit Coze Studio at http://localhost:8888/.

What's next

After successfully deploying Coze Studio, if you need to use functions such as plugins and knowledge bases, you also need to configure the relevant components at http://localhost:8888/admin/.

Security risks in public networks

If Coze Studio is to be deployed in a public network environment, it is recommended to pay attention to the following security risks:

• It is recommended to turn off the registration function or enable the email whitelist; otherwise, any user can use it via the link.
• It is recommended to enable the default sandbox environment for the workflow code nodes to enhance security. For detailed configuration instructions.
• It is recommended to configure the network for the deployment environment according to business requirements (such as intranet access) to avoid SSRF risks.
• By default, the Coze Studio server only listens to localhost. When deployed in a public network environment, it is recommended to listen to 0.0.0.0 only when necessary or add additional security measures to prevent the service from being directly exposed to the public network.