update docker-compose && README

This commit is contained in:
Sakurasan
2023-03-30 19:37:05 +08:00
parent 5822fa3d16
commit 074a8e4267
2 changed files with 44 additions and 1 deletions

View File

@@ -1,10 +1,43 @@
# opencatd-open
<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>
OpenCat for Team的开源实现
基本实现了opencatd的全部功能
## 快速上手
```
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
```
## Q&A
关于证书?
- docker部署会白白占用掉VPS的80443很不河里,建议用Nginx/Caddy/Traefik等反代并自动管理HTTPS证书.
没有服务器?
- 可以白嫖一些免费的容器托管服务:如:koyeb 或者其他
# License
See the [LICENSE](License) file for the full license text.
[GNU General Public License v3.0](License)

10
docker/docker-compose.yml Normal file
View File

@@ -0,0 +1,10 @@
version: '3.7'
services:
opencatd:
image: mirrors2/opencatd-open
container_name: opencatd-open
restart: unless-stopped
ports:
- 80:80
volumes:
- /etc/opencatd:/app/db