From 074a8e42674cc89eb2abaa4def42b3f17b707f75 Mon Sep 17 00:00:00 2001
From: Sakurasan <1173092237@qq.com>
Date: Thu, 30 Mar 2023 19:37:05 +0800
Subject: [PATCH] update docker-compose && README
---
README.md | 35 ++++++++++++++++++++++++++++++++++-
docker/docker-compose.yml | 10 ++++++++++
2 files changed, 44 insertions(+), 1 deletion(-)
create mode 100644 docker/docker-compose.yml
diff --git a/README.md b/README.md
index 6d31409..ffd572f 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,43 @@
# opencatd-open
+
+
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的80，443很不河里,建议用Nginx/Caddy/Traefik等反代并自动管理HTTPS证书.
+
+没有服务器?
+- 可以白嫖一些免费的容器托管服务:如:koyeb 或者其他
# License
-See the [LICENSE](License) file for the full license text.
\ No newline at end of file
+[GNU General Public License v3.0](License)
\ No newline at end of file
diff --git a/docker/docker-compose.yml b/docker/docker-compose.yml
new file mode 100644
index 0000000..154e9fe
--- /dev/null
+++ b/docker/docker-compose.yml
@@ -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
\ No newline at end of file