From 05885118ff76b9059078d5cf594a9d5c72f51be2 Mon Sep 17 00:00:00 2001
From: Nite07 <admin@nite07.com>
Date: Tue, 7 May 2024 01:27:10 +0800
Subject: [PATCH] :wrench: Modify Dockerfile :memo: Add README.md

---
 .github/workflows/docker.yml | 31 ++++++++++++++++++++++
 Dockerfile                   | 50 +++++++++++++++++++++++++++++++++++-
 README.md                    | 33 ++++++++++++++++++++++++
 3 files changed, 113 insertions(+), 1 deletion(-)
 create mode 100644 .github/workflows/docker.yml
 create mode 100644 README.md

diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml
new file mode 100644
index 0000000..870eda2
--- /dev/null
+++ b/.github/workflows/docker.yml
@@ -0,0 +1,31 @@
+name: docker
+
+on:
+  schedule:
+    - cron: "0 0 * * 1"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v5
+        with:
+          push: true
+          tags: nite07/tailscale-derp-docker:latest
+          platforms: linux/amd64,linux/arm64,linux/arm/v7
diff --git a/Dockerfile b/Dockerfile
index 29c6cc7..ae2c204 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -19,4 +19,52 @@ VOLUME ["/app/certs"]
 
 CMD /app/derper --hostname=$DERP_DOMAIN \
     --certdir=/app/certs \
-    --verify-clients=true
+    --verify-clients=true \
+    --certmode manual
+
+# derper --help
+# 使用方法说明:
+#   -a string
+#         服务器HTTP/HTTPS监听地址，格式为":port"、"ip:port"或IPv6的"[ip]:port"。如果省略IP地址，则默认监听所有接口。如果端口为443或使用-manual证书模式，则提供HTTPS服务，否则提供HTTP服务。 (默认 ":443")
+#   -accept-connection-burst int
+#         接受新连接的突发限制 (默认 9223372036854775807)
+#   -accept-connection-limit float
+#         接受新连接的速率限制 (默认 +Inf)
+#   -bootstrap-dns-names string
+#         可选的、以逗号分隔的主机名列表，这些主机名将在/bootstrap-dns上提供
+#   -c string
+#         配置文件路径
+#   -certdir string
+#         存储Let's Encrypt证书的目录，如果地址的端口为:443 
+#   -certmode string
+#         获取证书的模式。可能的选项包括：manual, letsencrypt (默认 "letsencrypt")
+#   -derp
+#         是否运行DERP服务器。设置为false的唯一原因是如果你正在停用服务器，但希望保持其引导DNS功能仍在运行。 (默认 true)
+#   -dev
+#         在本地开发模式下运行 (会覆盖 -a)
+#   -hostname string
+#         Let's Encrypt的主机名，如果地址的端口为:443 (默认 "derp.tailscale.com")
+#   -http-port int
+#         提供HTTP服务的端口。设置为-1以禁用。侦听器绑定到与-a标志指定的相同IP（如果有）。 (默认 80)
+#   -mesh-psk-file string
+#         如果非空，为包含网格预共享密钥文件的路径。它应该包含一些十六进制字符串；空白将被修剪。
+#   -mesh-with string
+#         可选的、以逗号分隔的主机名列表，用于网格连接；列表中可以包含服务器自己的主机名
+#   -stun
+#         是否运行STUN服务器。它将绑定到与--addr标志值相同的IP（如果有）。 (默认 true)
+#   -stun-port int
+#         提供STUN服务的UDP端口。监听器绑定到与-a标志指定的相同IP（如果有）。 (默认 3478)
+#   -tcp-keepalive-time duration
+#         TCP保活时间 (默认 10m0s)
+#   -tcp-user-timeout duration
+#         TCP用户超时时间 (默认 15s)
+#   -unpublished-bootstrap-dns-names string
+#         可选的、以逗号分隔的主机名列表，这些主机名将在/bootstrap-dns上提供，但不会公布在列表中
+#   -verify-client-url string
+#         如果非空，是一个准入控制器URL，用于允许客户端连接；参见 tailcfg.DERPAdmitClientRequest
+#   -verify-client-url-fail-open
+#         如果无法访问--verify-client-url，是否放行 (默认 true)
+#   -verify-clients
+#         通过本地tailscaled实例验证连接到此DERP服务器的客户端。
+#   -version
+#         打印版本并退出
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f714ab7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# Usage
+
+```shell
+docker run -d --name derper \
+  -p 80:80 -p 443:443 -p 3478:3478 \
+  -e DERP_DOMAIN=example.com \
+  -v /path/to/certs:/app/certs \
+  nite07/tailscale-derp-docker:latest
+```
+
+## Docker Compose
+
+```yaml
+version: "3.8"
+services:
+  derper:
+    container_name: derper
+    ports:
+      - 80:80
+      - 443:443
+      - 3478:3478
+    environment:
+      - DERP_DOMAIN=example.com
+    volumes:
+      - /path/to/certs:/app/certs
+    image: nite07/tailscale-derp-docker:latest
+```
+
+# Env
+
+| Name        | Description        |
+| ----------- | ------------------ |
+| DERP_DOMAIN | The domain to use. |