Files
opencatd-open/README.md
2024-12-18 01:08:23 +08:00

103 lines
3.8 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# ~~opencatd-open~~ [OpenTeam](https://github.com/mirrors2/opencatd-open)
本项目即将更名,后续请关注 👉🏻 https://github.com/mirrors2/openteam
<a title="Docker Image CI" target="_blank" href="https://github.com/mirrors2/opencatd-open/actions"><img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/mirrors2/opencatd-open/ci.yaml?label=Actions&logo=github&style=flat-square"></a>
<a title="Docker Pulls" target="_blank" href="https://hub.docker.com/r/mirrors2/opencatd-open"><img src="https://img.shields.io/docker/pulls/mirrors2/opencatd-open.svg?logo=docker&label=docker&style=flat-square"></a>
[![Telegram group](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.swo.moe%2Fstats%2Ftelegram%2FOpenTeamChat&query=count&color=2CA5E0&label=Telegram%20Group&logo=telegram&cacheSeconds=3600&style=flat-square)](https://t.me/OpenTeamChat) [![Telegram channel](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.swo.moe%2Fstats%2Ftelegram%2FOpenTeamLLM&query=count&color=2CA5E0&label=Telegram%20Channel&logo=telegram&cacheSeconds=3600&style=flat-square)](https://t.me/OpenTeamLLM)
opencatd-open is an open-source, team-shared service for ChatGPT API that can be safely shared with others for API usage.
---
OpenCat for Team的开源实现
~~基本~~实现了opencatd的全部功能
(openai附属能力:whisper,tts,dall-e(text to image)...)
## Extra Support:
| 🎯 | 🚧 |Extra Provider|
| --- | --- | --- |
|[OpenAI](./doc/azure.md) | ✅|Azure, Github Marketplace|
|[Claude](./doc/azure.md) | ✅|VertexAI|
|[Gemini](./doc/gemini.md) | ✅||
| ... | ... |
## 快速上手
```
docker run -d --name opencatd -p 80:80 -v /etc/opencatd:/app/db mirrors2/opencatd-open
```
## docker-compose
```
version: '3.7'
services:
opencatd:
image: mirrors2/opencatd-open
container_name: opencatd-open
restart: unless-stopped
ports:
- 80:80
volumes:
- /etc/opencatd:/app/db
```
or
```
wget https://github.com/mirrors2/opencatd-open/raw/main/docker/docker-compose.yml
```
## 支持的命令
>获取 root 的 token
- `docker exec opencatd-open opencatd root_token`
>重置 root 的 token
- `docker exec opencatd-open opencatd reset_root`
>导出 user info -> user.json (docker file path: /app/db/user.json)
- `docker exec opencatd-open opencatd save`
>导入 user.json -> db
- `docker exec opencatd-open opencatd load`
## Q&A
关于证书?
- docker部署会白白占用掉VPS的80443很不河里,建议用Nginx/Caddy/Traefik等反代并自动管理HTTPS证书.
没有服务器?
- 可以白嫖一些免费的容器托管服务:如:
- [![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/ppAoCV?referralCode=TW5RNa)
- [Zeabur](https://zeabur.com/zh-CN)
- [koyeb](https://koyeb.io/)
- [Fly.io](https://fly.io/)
- 或者其他
使用Nginx + Docker部署
- [使用Nginx + Docker部署](./doc/deploy.md)
pandora for team
- [pandora for team](./doc/pandora.md)
如何自定义HOST地址? (仅OpenAI)
- 需修改环境变量,优先级递增(全局配置谨慎修改)
- Cloudflare AI Gateway地址 `AIGateWay_Endpoint=https://gateway.ai.cloudflare.com/v1/123456789/xxxx/openai/chat/completions`
- 自定义的endpoint `OpenAI_Endpoint=https://your.domain/v1/chat/completions`
设置主页跳转地址?
- 修改环境变量 `CUSTOM_REDIRECT=https://your.domain`
## 获取更多信息
[![TG](https://telegram.org/img/favicon.ico)](https://t.me/OpenTeamLLM)
## 赞助
[![Buy Me A Coffee](https://img.shields.io/badge/Buy%20Me%20A%20Coffee-FFDD55?style=flat-square&logo=buy-me-a-coffee&logoColor=black)](https://www.buymeacoffee.com/littlecjun)
# License
[![GitHub License](https://img.shields.io/github/license/mirrors2/opencatd-open.svg?logo=github&style=flat-square)](https://github.com/mirrors2/opencatd-open/blob/main/License)