From 24af57ce918bc4a25eb5c04d4878c900eaa1b99c Mon Sep 17 00:00:00 2001 From: chendelin1982 <27513732@qq.com> Date: Sat, 20 Apr 2024 10:11:36 +0100 Subject: [PATCH] add caddy --- docs/apps/caddy.md | 65 ++++++++ docs/apps/chatwoot.md | 4 +- docs/apps/cloudreve.md | 10 ++ docs/apps/collabora.md | 2 +- docs/apps/emqx.md | 4 +- docs/apps/geminiprochat.md | 4 +- docs/apps/homeassistant.md | 10 +- docs/reference/stacks/cd/caddy/_category_.yml | 5 - docs/reference/stacks/cd/caddy/advanced.md | 35 ----- docs/reference/stacks/cd/caddy/guide.md | 146 ------------------ 10 files changed, 85 insertions(+), 200 deletions(-) create mode 100644 docs/apps/caddy.md delete mode 100644 docs/reference/stacks/cd/caddy/_category_.yml delete mode 100644 docs/reference/stacks/cd/caddy/advanced.md delete mode 100644 docs/reference/stacks/cd/caddy/guide.md diff --git a/docs/apps/caddy.md b/docs/apps/caddy.md new file mode 100644 index 00000000..3310dda6 --- /dev/null +++ b/docs/apps/caddy.md @@ -0,0 +1,65 @@ +--- +title: Caddy +slug: /caddy +tags: + - HTTP 服务器 + - https + - 微服务 + - 云原生 +--- + +import Meta from './_include/caddy.md'; + + + +## 入门指南{#guide} + +Websoft9 提供的 Caddy 应用两个用途： + +- 直接运行静态网站 +- 作为反向代理服务 + +下面我们分别对它的使用方法做出详细的说明 + +### 部署静态网站 + +1. Websoft9 控制台安装 Caddy 后，通过【我的应用】管理应用，在**访问**标签页中获取访问信息 + +2. 点击访问地址，可看到一个用于演示的静态页面，即意味着我们只需要用自己的静态网站**替换**当前的演示网站 + + 1. 通过 "我的应用" > "Caddy 容器" 的**编排** 标签页，进入应用的 Git 仓库 + 2. 仓库中的 site 文件夹即存放静态网站的目录 + 3. 上传自己的静态网站文件到 site 目录 + +4. Websoft9 控制台重建应用后生效 + +### 反向代理其他应用 + +参考下面的步骤，体验 Caddy 方向代理的能力： + +1. Websoft9 控制台 "应用商店" 分别运行一个 **Netdata** 和 **Caddy** + +2. 通过 "我的应用" > "Caddy" 的**编排** 标签页中修改 src/Caddyfile 为如下的内容 + ``` + :80 { + reverse_proxy http://netdata_h31py:19999 + } + ``` + +3. 重启 Caddy 应用，访问 Caddy 的 URL，就会发现应用已指向了 Netdata 的页面 + +在 Websoft9 托管平台中，上面的 Netdata 访问的路由： 用户 > Websoft9 网关 > Caddy > Netdata + + +## 配置选项{#configs} + +- Caddy 容器端口：80 是静态网站目录，8080 是反向代理目录 +- 监控所有 URL 的通配符写法： `:80` 或 `：8080` +- [API](https://caddyserver.com/docs/quick-starts/api) +- CLI：`caddy help` +- 配置[模板](https://caddy.community/c/wiki/13) +- Caddy 配置文件：*/etc/caddy/Caddyfile*，已挂载到编排文件 /src/Caddyfile。 + +## 管理维护{#administrator} + +## 故障 diff --git a/docs/apps/chatwoot.md b/docs/apps/chatwoot.md index f1883189..fb5e652b 100644 --- a/docs/apps/chatwoot.md +++ b/docs/apps/chatwoot.md @@ -15,9 +15,7 @@ import Meta from './_include/chatwoot.md'; ### 初始化{#wizard} -1. Websoft9 控制台安装 Chatwoot 后，通过【我的应用】管理应用，在**访问**标签页中获取登录信息 - -2. 向导页面会提示输入 **API KEY**，需要进入[官网注册](https://akaunting.com/register)即可获取 +Websoft9 控制台安装 Chatwoot 后，通过【我的应用】管理应用，在**访问**标签页中获取登录信息 ## 配置选项{#configs} diff --git a/docs/apps/cloudreve.md b/docs/apps/cloudreve.md index 6eb4c186..dd209813 100644 --- a/docs/apps/cloudreve.md +++ b/docs/apps/cloudreve.md @@ -20,10 +20,20 @@ Websoft9 控制台安装 Cloudreve 后，通过【我的应用】管理应用， ### 离线下载 +1. 进入【个人中心】->【管理面板】->【离线下载节点】，编辑此节点 + +2. 启用离线下载任务，参考Websoft9 控制台【访问】中的信息填写各种参数 + +3. 进入【个人主页】->【离线下载】，可以开始离线下载任务了 + ### 文档编辑与预览 +【我的文件】可查看或编辑已经下载的文档 + ## 配置选项{#configs} +- 多语言（✅） + ## 管理维护{#administrator} ## 故障 \ No newline at end of file diff --git a/docs/apps/collabora.md b/docs/apps/collabora.md index 09093a47..62b7fba3 100644 --- a/docs/apps/collabora.md +++ b/docs/apps/collabora.md @@ -36,7 +36,7 @@ Nextcloud 官方对 Collabora 有较好的[集成](https://www.collaboraoffice.c ## 管理控制台 -Collabora CODE 提供了 [Admin Console](https://sdk.collaboraonline.com/docs/installation/Configuration.html#admin-console)用于监控运行状态。 +Collabora CODE 提供了 [Admin Console](https://sdk.collaboraonline.com/docs/installation/Configuration.html#admin-console) 用于监控运行状态。 ## 管理维护{#administrator} diff --git a/docs/apps/emqx.md b/docs/apps/emqx.md index 7843abd6..06fea815 100644 --- a/docs/apps/emqx.md +++ b/docs/apps/emqx.md @@ -14,9 +14,9 @@ import Meta from './_include/emqx.md'; ## 入门指南{#guide} -### 初始化{#wizard} +### 可视化管理 -Websoft9 控制台安装 EMQX 后，通过【我的应用】管理应用，在**访问**标签页中获取登录信息。 +参考：[MQTTX](./mqttx)。 ## 配置选项{#configs} diff --git a/docs/apps/geminiprochat.md b/docs/apps/geminiprochat.md index 1d46d7d6..6cf8d310 100644 --- a/docs/apps/geminiprochat.md +++ b/docs/apps/geminiprochat.md @@ -15,9 +15,7 @@ import Meta from './_include/geminiprochat.md'; ### 初始化{#wizard} -1. Websoft9 控制台安装 GeminiProChat 后，通过【我的应用】管理应用，在**编排**标签页修改 .env 中的 Key - -2. 重建应用后生效 +Websoft9 控制台安装 Flowise 后，通过【我的应用】管理应用，在**访问**标签页中获取登录信息 ## 配置选项{#configs} diff --git a/docs/apps/homeassistant.md b/docs/apps/homeassistant.md index 573d8832..f395ee97 100644 --- a/docs/apps/homeassistant.md +++ b/docs/apps/homeassistant.md @@ -13,10 +13,6 @@ import Meta from './_include/homeassistant.md'; ## 入门指南{#guide} -### 初始化{#wizard} - -Websoft9 控制台安装 Home Assistant 后，通过【我的应用】管理应用，在**访问**标签页中获取登录信息。 - ### 连接 MQTT Home Assistant 应用默认并不包括 MQTT 服务，建议在 Websoft9 控制台安装开源 MQTT 服务器 [Eclipse Mosquitto](./mosquitto)。 @@ -32,4 +28,8 @@ Home Assistant 应用默认并不包括 MQTT 服务，建议在 Websoft9 控制 ## 管理维护{#administrator} -## 故障 \ No newline at end of file +## 故障 + +#### 无法通过域名访问 Home Assistant？ + +目前能仅通过 IP 和端口来访问，通过 Nginx 转发到域名还没有方案 \ No newline at end of file diff --git a/docs/reference/stacks/cd/caddy/_category_.yml b/docs/reference/stacks/cd/caddy/_category_.yml deleted file mode 100644 index 5485bb31..00000000 --- a/docs/reference/stacks/cd/caddy/_category_.yml +++ /dev/null @@ -1,5 +0,0 @@ -position: 3 -label: "Caddy" -collapsible: true -collapsed: true -className: "red" \ No newline at end of file diff --git a/docs/reference/stacks/cd/caddy/advanced.md b/docs/reference/stacks/cd/caddy/advanced.md deleted file mode 100644 index c1021c3b..00000000 --- a/docs/reference/stacks/cd/caddy/advanced.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -sidebar_position: 2 -slug: /caddy/advanced ---- - -# 进阶 - -## 安装 - -Caddy 提供了一个官方兼容性的二进制包，可以下载后直接运行。 -当然，我们也可以采用下面的命令快速安装： - -``` -# Fedora, RedHat, CentOS -yum install yum-plugin-copr -yum copr enable @caddy/caddy -yum install caddy - -# Debian, Ubuntu, Raspbian -sudo apt install -y debian-keyring debian-archive-keyring apt-transport-https -curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/gpg.key' | sudo tee /etc/apt/trusted.gpg.d/caddy-stable.asc -curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/debian.deb.txt' | sudo tee /etc/apt/sources.list.d/caddy-stable.list -sudo apt update -sudo apt install caddy -``` - -## 原理 - -#### 匹配器标记 - -1. * 匹配所有请求（通配符；默认）。 -2. /path 以正斜杠开头以匹配请求路径。 -3. @name 指定一个命名匹配器。 - -## 问题解答 \ No newline at end of file diff --git a/docs/reference/stacks/cd/caddy/guide.md b/docs/reference/stacks/cd/caddy/guide.md deleted file mode 100644 index 6e4a29e8..00000000 --- a/docs/reference/stacks/cd/caddy/guide.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -sidebar_position: 1 -slug: /caddy -tags: - - Caddy - - Web 服务器 ---- - - -# 指南 - -[Caddy](https://caddyserver.com/) 是一款基于 Go 语言编写的强大且可扩展的平台，可以给你的站点、服务和应用程序提供服务。 - -## 场景 - -### 使用 API 配置 Caddy - -参考官方文档：https://caddyserver.com/docs/quick-starts/api - -### 列出目录文件 - -``` -file_server browse -``` - -### 指定反代目录 - -在实践中，我们可能只想对 API 请求使用反向代理，即基本路径为/api/ - -``` -file_server -reverse_proxy /api/* 127.0.0.1:9005 -``` - -## 故障排除{#troubleshoot} - -## 参数 - -### 路径{#path} - -Caddy 配置文件：*/etc/caddy/Caddyfile* - -### 命令行{#cmd} - -``` -$ caddy help - -usage: - caddy [] - -commands: - adapt Adapts a configuration to Caddy's native JSON - add-package Adds Caddy packages (EXPERIMENTAL) - build-info Prints information about this build - environ Prints the environment - file-server Spins up a production-ready file server - fmt Formats a Caddyfile - hash-password Hashes a password and writes base64 - help Shows help for a Caddy subcommand - list-modules Lists the installed Caddy modules - reload Changes the config of the running Caddy instance - remove-package Removes Caddy packages (EXPERIMENTAL) - reverse-proxy A quick and production-ready reverse proxy - run Starts the Caddy process and blocks indefinitely - start Starts the Caddy process in the background and then returns - stop Gracefully stops a started Caddy process - trust Installs a CA certificate into local trust stores - untrust Untrusts a locally-trusted CA certificate - upgrade Upgrade Caddy (EXPERIMENTAL) - validate Tests whether a configuration file is valid - version Prints the version - -``` - -### 服务{#service} - -``` -sudo systemctl start | stop | restart | status caddy -``` - -### 模板{#template} - -Caddy 官方提供了[丰富的模板](https://caddy.community/c/wiki/13)供用户参考、学习和讨论。 - -这里列出几种典型的应用场景： - -#### 域名 + 本地 php-fpm - -``` -domain.com { - root * /var/www/domain.com - encode zstd gzip - file_server - php_fastcgi unix//run/php/php7.4-fpm.sock -} -``` - -#### 域名 + 代理 - -``` -# 代理到本机 -youdomain.example.com { - reverse_proxy https://localhost:9090 { - transport http { - tls_insecure_skip_verify - } - } -} - -# 代理到容器 -collabora.example.com { - encode gzip - - reverse_proxy https://collabora:9980 { - transport http { - tls_insecure_skip_verify - } - } -} - -``` - -#### IP + php-fpm 容器 - -``` -:80 { - root * /srv/public - encode gzip - php_fastcgi php:9000 - file_server -} -``` - -#### IP + 多端口访问 - -``` -:8080 { - respond "I am 8080" -} - -:8081 { - respond "I am 8081" -} -``` - -