Skip to main content

CoStrict 后端部署工具

项目概述

CoStrict 后端部署工具是基于 Docker Compose 的企业级 AI 代码助手后端服务部署解决方案。该项目提供了完整的微服务架构,包含 AI 网关、身份认证、代码分析、聊天服务等核心组件,支持私有化部署和云端服务两种模式。

查看此项目的部署架构,部署的服务器要求、环境要求、模型要求、模型下载地址等,请访问 前言

快速开始

开始前,请确保你对Linux命令行又一定的了解,请确保你已经根据软件要求安装好了Docker 和 Compose.

1. 获取部署配置

方式一:通过 Github Release

访问一下地址:

https://github.com/zgsm-sangfor/costrict-deploy-docker/releases/

下载最新的release压缩包 costrict-backend-deploy-vX.X.X.tar.gz ,如: costrict-backend-deploy-v0.0.2.tar.gz

将压缩包复制到服务器,然后解压

# costrict-server 就是部署目录,请牢记这个目录,请牢记这个目录,请牢记这个目录,这是你的部署目录,后面将会用到
# 这个目录将存储大部分运行数据,请保证磁盘稳定、充足
mkdir ./costrict-server
# 将所有文件解压到 costrict-server,注意,costrict-backend-deploy-v0.0.2.tar.gz 替换为你下载的实际版本的压缩包。
tar -zxf costrict-backend-deploy-v0.0.2.tar.gz -C costrict-server
# 进入到部署目录
cd ./costrict-server

注意,./costrict-server 就是部署目录,

2. 准备后端服务镜像

注意,如果你是离线环境部署,继续查看本节,如果你的服务器能正常访问整个互联网(包括docker.io、quay.io、docker.elastic.co等),可以直接跳过这个步骤,部署时会自动拉取所有镜像。

CoStrict后端需要的镜像,可以查看 scripts/newest-images.list 文件获取完整列表,你也可以手动拉取这些镜像

我们提供了百度网盘的下载地址:

网盘地址

https://pan.baidu.com/s/5H0ppvaTja4g2MKZs0Ki1-g

当前最新版本: v0.0.3

下载后所有的tar包并复制到服务器的某个目录(比如/root/images),运行:

# /root/images 就是tar包所在目录,请注意替换
# scripts/load-images.sh 是部署目录下的脚本,请自行查找
bash scripts/load-images.sh -l /root/images

3. 环境配置

编辑配置文件(注意,是编辑,不是新建,就在部署目录下,且已经存在一些内容):

vim configure.sh

关键配置参数:

为了快速开始,你只需要配置第一个参数为服务器的ip即可,CoStrict客户端将会通过这个ip访问CoStrict后台服务,请务必配置这个参数后继续

# 注意,这个配置就在第一行,直接编辑即可.
COSTRICT_BACKEND=""

4. 服务部署

只需要一行命令,就可以拉起所有的costrict服务。

bash costrict.sh install

运行结束后,会提示类似的内容,请找个文本文件记录下来:

[INFO]  管理用户访问 (casdoor) http://192.168.79.130:39009/
[INFO] 配置Chat模型请访问 (nacos) http://192.168.79.130:31808/
[INFO] BaseUrl请设置 http://192.168.79.130:39080/

服务配置

模型配置

当前版本已经移除了higress, 如果需要配置模型,请到nacos中配置,访问nacos,如http://192.168.79.130:31808/(请注意,请你以实际输出为准)

登录nacos

用户名: nacos
密码:nacos
  1. 打开 配置管理-> 配置列表-> costrict(在配置管理这四个大字的下方)。
  2. 找到 model-config 配置,点击编辑,根据提示编辑配置内容,其他不要动。
  3. 编辑后发布即可,会自动实时更新。

以下是配置说明/示例,注意:

请严格按照yaml或者json格式配置

请严格按照yaml或者json格式配置

请严格按照yaml或者json格式配置

发布时nacos会有格式检查,如果报错: 配置信息可能有语法错误, 确定提交吗?请不要提交。

# 配置示例和解释,请在nacos中修改,不用复制这个配置。
models:
# 配置示例 1
# id,模型的名称, 你在插件中看到的名字,也就是你在模型列表中看到的名字,随便自定义
- id: Kimi-K2-Moonshot
# 模型的信息
publicInfo:
# 最大输出, 比contextWindow小 (一般32K够用了),请用阿拉伯数字.
maxTokens: 32000
# 上下文窗口,找模型提供者给,如果模型提供者给你的值小于16000,请换更大的模型,请用阿拉伯数字.
contextWindow: 200000
# 模型的key相关
privateConfig:
# 模型的真实名字,找模型提供者给
convertedName: KimiK1000000
# 地址,完整的路径/v1/chat/completions
addr: http://127.0.0.1:6666/v1/chat/completions
# 自定义头,可以添加任意多个
extraHeaders:
# 认证头一般放这里,请询问模型提供者值是多少
Authorization: "sk-xxxxxxxx"
# 是否跳过ssl校验,一般只有服务是https且采用自签名的ssl证书才需要设置,请询问模型提供者。
skipSSLVerify: false
# 配置示例 2,和1一样,只是有更多的补充说明。
# 模型2,需要多少个模型就加多少个,请严格按照yaml格式配置
- id: Qwen3.5
# 模型的一些配置项,详细
publicInfo:
object: model
maxTokens: 32000
contextWindow: 200000
# 是否支持图片
supportsImages: true
supportsComputerUse: false
supportsPromptCache: false
supportsReasoningBudget: false
requiredReasoningBudget: false
# 描述信息
description: Qwen3.5 to glm
# 配额,当前这个功能没有。
creditConsumption: 3
creditDiscount: 1
privateConfig:
convertedName: glm-5-tokens
addr: http://127.0.0.1:32323/v1/chat/completions
extraHeaders:
Authorization: sk-***
skipSSLVerify: false

可选:身份认证系统配置 (Casdoor)

如果没有特殊要求(如:对接第三方认证系统),请直接 跳过此步骤,请跳过此步骤,请跳过此步骤。

第一次测试试用,也请直接 跳过此步骤,请跳过此步骤,请跳过此步骤。

通过以下地址访问 Casdoor 管理界面:

# 安装结束后提示的第一个url
http://{COSTRICT_BACKEND}:{PORT_CASDOOR}

基本用户添加参考: casdoor基本设置

客户端集成

CoStrict 插件配置

  1. 安装 CoStrict VSCode 扩展
  2. 打开扩展设置中的"提供商"页面
  3. 选择 API 提供商为"CoStrict"
  4. 配置后端服务地址:
    CoStrict Base URL: {COSTRICT_BACKEND_BASEURL}
  5. 点击"登录 CoStrict"完成身份验证

登录测试账户:

用户名: costrict
密码: 123

详细安装指南:CoStrict 下载安装文档 (含 VSCodeJetBrains IDE)

服务访问地址:

# 安装后提示的第三个url
默认后端入口: http://{COSTRICT_BACKEND}:{PORT_APISIX_ENTRY}

Others

更多信息

CoStrict - 让 AI 助力您的代码开发之旅