Dify-on-wechat 搭建

![logo.png](https://data.golovin.cn/img/c33bfe4c7d3011514848f8b09070e1be.logo.png?imagevanblog)

# Docker 编写部署升级指南

## 警告
`docker-legacy` 目录中的文件将很快停止维护，并将从存储库中删除。如果您仍在使用它们，请尽快切换到新版本。

---

## 升级步骤

### 1. 备份您定制的 `docker-compose.yaml` 文件（可选）
```bash
cd /data/project/dify/docker
cp docker-compose.yaml docker-compose.yaml.$(date +%s).bak
```

---

### 2. 设置 Git 用户信息（如果未设置）
在拉取最新代码之前，确保 Git 用户信息已配置：
```bash
git config --global user.email "you@example.com"
git config --global user.name "Your Name"
```
将 `you@example.com` 替换为你的邮箱，`Your Name` 替换为你的名字。

---





### 3. 从主分支获取最新代码
```bash
git checkout main
```

如果本地有未提交的修改，可以暂存这些修改以避免冲突：
```bash
git stash
```

拉取远程仓库的最新代码：
```bash
git pull origin main
```

如果之前暂存了修改，恢复这些修改：
```bash
git stash pop
```

如果恢复时出现冲突，手动解决冲突：

```bash
# 例如 Auto-merging docker/docker-compose.yaml
# CONFLICT (content): Merge conflict in docker/docker-compose.yaml
# 表示需要解决docker-compose.yaml中的冲突，无法自动合并
vim docker-compose.yaml

# 查找冲突标记（通常是<<<<<<<，=======，>>>>>>> 根据业务需求，手动解决冲突，保留或修改相应的代码
```

然后提交：
```bash
git add docker-compose.yaml
git commit -m "Resolve merge conflict after stash pop"
```

---

### 4. 停止服务
在 `docker` 目录中执行以下命令停止服务：
```bash
docker compose down
```

---

### 5. 备份数据
备份 `volumes` 目录中的数据：
```bash
tar -cvf volumes-$(date +%s).tgz volumes
```

---

### 6. 升级服务
启动升级后的服务：
```bash
docker compose up -d
```

---

## 注意事项
- 如果升级过程中遇到问题，可以通过备份文件恢复到之前的版本。
- 确保在升级前备份所有重要数据。
- 如果使用自定义配置，请在升级后重新检查配置文件。

---

## 参考
- [Git 官方文档](https://git-scm.com/doc)
- [Docker Compose 官方文档](https://docs.docker.com/compose/)


# 使用

## 1、调整函数超时时间

- 实际使用过程中发现工作流调用函数会15+超时报错
- 了解下来发现其机制是建立在sandbox 沙箱机制上的，函数在其中运行，然后拿回结果
- 因此要修改两个docker环境变量的配置：沙盒配置的超时时间、服务等待沙盒返回的超时时间
1. SANDBOX_WORKER_TIMEOUT: ${SANDBOX_WORKER_TIMEOUT:-60}
2. SERVER_WORKER_CONNECTIONS: ${SERVER_WORKER_CONNECTIONS:-60}

- 然后保存docker-compose.yaml后，在当前目录执行重启命令，测试是否生效
- docker compose down
- docker compose up -d

Dify升级指南

<img src="https://data.golovin.cn/img/7fcf5325968fa5ff4e36d80fafcccc69.IMG_3045.PNG?imagevanblog" width="70%">



:::info{title="相关信息"}
**以下内容均基于MAC端，建议如下：**
1. **登录美区 Apple ID**
2. **将地区设置为美国，并将英语设置为首选语音**
3. **将英语（美国）设置为 Siri 语言**
:::




# 方式1 重写配置：

**不关闭sip，开启全局vpn代理的方式**

**注意：重写配置方式是互斥的，选择适合自己想要的组合执行**

## 1、Override XcodeLLM only

```sh
curl -L https://raw.githubusercontent.com/Kyle-Ye/XcodeLLMEligible/release/0.2/scripts/override.sh | bash -s -- install override xcodellm
```
## 2、Override Apple Intelligence only

```sh
curl -L https://raw.githubusercontent.com/Kyle-Ye/XcodeLLMEligible/release/0.2/scripts/override.sh | bash -s -- install override greymatter
```

## 3、For Apple Intelligence + Cleanup

```sh
curl -L https://raw.githubusercontent.com/Kyle-Ye/XcodeLLMEligible/release/0.2/scripts/override.sh | bash -s -- install override greymatter+strontium
```

## 4、For XcodeLLM + Apple Intelligence + Cleanup

```sh
curl -L https://raw.githubusercontent.com/Kyle-Ye/XcodeLLMEligible/release/0.2/scripts/override.sh | bash -s -- install override xcodellm+greymatter+strontium
```


# 方式2 关闭SIP执行

```sh
# sip开启：
csrutil enable
# sip关闭：
csrutil disable
```
## 1、进入Mac的恢复模式
- 关机（一般需要5～10s）
- 长按开机键，不要松开，页面会弹出提示“继续按住以进入设置”
- 直到显示 **【正在载入启动选项】** 时才松开开关键
- 然后点击 **`选项`** ，**`继续`**，然后输入用户密码。（如果有多个管理员账户，会让你先选择哪一个）
- 左上角菜单栏选择 **`实用工具`** => **`终端`**
- 在恢复模式下输入 `csrutil disable` 禁用 **SIP**
- 确认**y** 
- 输入用户名密码确认 ✅ 
- 然后看见 **sip off** 后，菜单栏上选择重启电脑


============以上是恢复模式内的操作==============

============以下是重启后在终端中的操作==============

## 2、用户系统中打开终端

同样打开Mac的终端：

**然后添加启动参数：**

```sh
sudo nvram boot-args="amfi_get_out_of_my_way=1"
```
**然后再次重启**

重启后再次打开终端：
```sh
sudo -i 
```

**然后拖拽[下载的文件](https://github.com/Kyle-Ye/XcodeLLMEligible/releases/download/0.2.0/eligibility_util)**

让终端获取到下载文件目录的真实地址，然后删除多余的名称，比如这里拿到的就是
```sh
/Users/g977
```
然后就可以输入：
```sh
cd /Users/g977 && chmod +x eligibility_util
```
## 3、执行插件指令，开启对应功能

然后执行命令开启AI和图片擦除：

- **1、For XcodeLLM:**
```sh
./eligibility_util forceDomainAnswer --domain-name OS_ELIGIBILITY_DOMAIN_XCODE_LLM --answer 4
```

- **2、For Apple Intelligence (macOS 15.1+ required)**
```sh
./eligibility_util forceDomainAnswer --domain-name OS_ELIGIBILITY_DOMAIN_GREYMATTER --answer 4
```

- **3、For Cleanup as part of Apple Intelligence feature (macOS 15.1 Beta 3+ required)**
```sh
./eligibility_util forceDomainAnswer --domain-name OS_ELIGIBILITY_DOMAIN_STRONTIUM --answer 4
```

看到`Force domain answer successfully`就表示 **ok** 了

## 4、更改系统配置，下载AI模型

然后改 **siri** 语言为**英文**

修改**系统地区**为**美国**，修改**系统语言**为**英文**

这时候就可以成功 **下载智能siri的模型**，**下载照片擦除的模型**，

**然后更改系统语言为中文，不要点击重启，然后直接强制退出`com + Q`**

## 5、恢复 SIP，移除启动参数

最后，再次进入**恢复模式**，执行 **`csrutil enable`** 恢复 **SIP**

然后重启后进入用户系统的终端，删除启动参数：
`sudo nvram -d boot-args`

## 6、效果：

### 1、Apple Intelligence


 <img src="https://data.golovin.cn/img/1c2211dbca4e5159f01b4226d13c00f2.image.png?imagevanblog" width="70%">



 <img src="https://data.golovin.cn/img/ea7842d4bb4cc550f0ad62711f3b9f4c.image.png?imagevanblog" width="70%">


### 2、图乐园APP

 <img src="https://data.golovin.cn/img/987af938a94187e4fcd887b2017ad423.image.png?imagevanblog" width="70%">


### 3、记事本AI功能
---

:::tip{title="提示"}

上述是自行配置的手札，可能不会实时更新；

以下是开源的原文手册教程

可自行研究，后续更新维护内容也可自行查看
:::

# 摘录的原文内容：

**可点击跳转，自行去github上研究配置**

## <div align="center"><a href="https://github.com/Kyle-Ye/XcodeLLMEligible/blob/main/README.md">English</a> | <a href="https://github.com/Kyle-Ye/XcodeLLMEligible/blob/main/README_CN.md">简体中文</a></div>


# Darwin Eligibility Override

本项目旨在不禁用系统完整性保护 (SIP) 或者仅禁用一次的情况下
实现永久在任意 Mac 上使用 Xcode LLM / Apple Intelligence。

> [!NOTE]
> Xcode LLM 仅支持在 macOS 15.0 及更高版本上使用。
>
> Apple Intelligence 仅支持在 macOS 15.1 及更高版本上使用。
>
> XcodeLLM, Apple Intelligence 和 ChatGPT 集成已在 Mac mini (M4 Pro, 2024) + macOS 15.2 上测试正常。


## 注意事项

这个项目仅用于学习和研究目的。

如果您选择使用此项目，您将自行承担风险，并有责任遵守任何适用法律。

本项目的作者对您使用本项目可能产生的任何后果概不负责。

## 使用方式

### 方案一 util 工具（推荐）

在脚本执行期间需要临时禁用一次 SIP 并在启动参数中添加 "amfi_get_out_of_my_way=1"。

> [!TIP]
> 如果你在如何禁用 SIP 或设置启动参数方面遇到问题，请参阅[手动执行](#manual-execution)部分以了解更多详细信息。

```shell
# Force XcodeLLM to be eligible
curl -L https://raw.githubusercontent.com/Kyle-Ye/XcodeLLMEligible/release/0.2/scripts/override.sh | bash -s -- install util xcodellm
# Force Apple Intelligence to be eligible
curl -L https://raw.githubusercontent.com/Kyle-Ye/XcodeLLMEligible/release/0.2/scripts/override.sh | bash -s -- install util greymatter
# Force Cleanup to be eligible
curl -L https://raw.githubusercontent.com/Kyle-Ye/XcodeLLMEligible/release/0.2/scripts/override.sh | bash -s -- install util strontium
# For Apple Intelligence + Cleanup
curl -L https://raw.githubusercontent.com/Kyle-Ye/XcodeLLMEligible/release/0.2/scripts/override.sh | bash -s -- install override greymatter+strontium
# For XcodeLLM + Apple Intelligence + Cleanup
curl -L https://raw.githubusercontent.com/Kyle-Ye/XcodeLLMEligible/release/0.2/scripts/override.sh | bash -s -- install override xcodellm+greymatter+strontium
```

### 方案二 override 文件

完全不需要禁用 SIP。

```shell
# Override XcodeLLM only
curl -L https://raw.githubusercontent.com/Kyle-Ye/XcodeLLMEligible/release/0.2/scripts/override.sh | bash -s -- install override xcodellm
# Override Apple Intelligence only
curl -L https://raw.githubusercontent.com/Kyle-Ye/XcodeLLMEligible/release/0.2/scripts/override.sh | bash -s -- install override greymatter
```

> [!NOTE]
> override 文件方案是互斥的。
>
> 本仓库仅提供了单独了 Xcode LLM 和 Apple Intelligence 的 override 文件。
>
> 如果需要覆盖多个，请使用 util 工具方案分别覆盖后导出 override 文件供自己未来使用。

## 卸载

### 方案一 util 工具

```shell
# For XcodeLLM:
curl -L https://raw.githubusercontent.com/Kyle-Ye/XcodeLLMEligible/release/0.2/scripts/override.sh | bash -s -- uninstall util xcodellm
# For Apple Intelligence
curl -L https://raw.githubusercontent.com/Kyle-Ye/XcodeLLMEligible/release/0.2/scripts/override.sh | bash -s -- uninstall util greymatter
# For Clenaup as part of Apple Intelligence feature
curl -L https://raw.githubusercontent.com/Kyle-Ye/XcodeLLMEligible/release/0.2/scripts/override.sh | bash -s -- uninstall util strontium
```

### 方案二 override 文件

```shell
# For XcodeLLM:
curl -L https://raw.githubusercontent.com/Kyle-Ye/XcodeLLMEligible/release/0.2/scripts/override.sh | bash -s -- uninstall override xcodellm
# For Apple Intelligence
curl -L https://raw.githubusercontent.com/Kyle-Ye/XcodeLLMEligible/release/0.2/scripts/override.sh | bash -s -- uninstall override greymatter
# For Apple Intelligence + Cleanup
curl -L https://raw.githubusercontent.com/Kyle-Ye/XcodeLLMEligible/release/0.2/scripts/override.sh | bash -s -- uninstall override greymatter+strontium
# For XcodeLLM + Apple Intelligence + Cleanup
curl -L https://raw.githubusercontent.com/Kyle-Ye/XcodeLLMEligible/release/0.2/scripts/override.sh | bash -s -- uninstall override xcodellm+greymatter+strontium
```

## 手动执行

### 方案一 util 工具 （推荐）

1. 在恢复模式下通过 `csrutil disable` 禁用 SIP

2. 添加启动参数 `sudo nvram boot-args="amfi_get_out_of_my_way=1"`并**重启**

3. 从[发布页面](https://github.com/Kyle-Ye/XcodeLLMEligible/releases)下载可执行文件 `eligibility_util` 并添加执行权限。

> 以下的命令假设下载的文件在 `~/Downloads` 文件夹。

```shell
chmod +x ~/Downloads/eligibility_util
```

4. 执行以下命令

```shell
cd ~/Downloads
# For XcodeLLM:
./eligibility_util forceDomainAnswer --domain-name OS_ELIGIBILITY_DOMAIN_XCODE_LLM --answer 4
# For Apple Intelligence (macOS 15.1+ required)
./eligibility_util forceDomainAnswer --domain-name OS_ELIGIBILITY_DOMAIN_GREYMATTER --answer 4
# For Cleanup as part of Apple Intelligence feature (macOS 15.1 Beta 3+ required)
./eligibility_util forceDomainAnswer --domain-name OS_ELIGIBILITY_DOMAIN_STRONTIUM --answer 4
```

4. 在恢复模式下通过 `csrutil enable` 恢复 SIP
5. 删除启动参数 `sudo nvram -d boot-args`

> 如果你不熟悉 SIP 操作，请阅读 [Disabling and Enabling System Integrity Protection](https://developer.apple.com/documentation/security/disabling_and_enabling_system_integrity_protection)。
>
> 你只能在恢复模式或禁用 SIP 的普通模式下设置boot-args。
>
> 设置boot-args后，记得重新启动以使更改生效。

> [!TIP]
> 更多技术细节，请参阅 [Kyle-Ye/eligibility](https://github.com/Kyle-Ye/eligibility)

### 方案二 override 文件

完全不需要禁用 SIP。

1. 从[发布页面](https://github.com/Kyle-Ye/XcodeLLMEligible/releases)下载需要的 `*.eligibility_overrides.data` 文件并重命名为 `eligibility_overrides.data`

> 对于 Xcode LLM，下载 [xcodellm.eligibility_overrides.data](https://github.com/Kyle-Ye/XcodeLLMEligible/releases/download/0.2.0/xcodellm.eligibility_overrides.data)
> 
> 对于 Apple Intelligence，下载 [greymatter.eligibility_overrides.data](https://github.com/Kyle-Ye/XcodeLLMEligible/releases/download/0.2.0/greymatter.eligibility_overrides.data)

2. 在 `/private/var/root/Library/Daemon\ Containers` 下找到 `eligibilityd` 的容器 UUID

通过以下命令查看所有的 UUID
```shell
sudo ls /private/var/root/Library/Daemon\ Containers
```

3. 将第一步下载的文件移动到相应的 Deamon 容器的 `Data/Library/Caches/NeverRestore/` 文件夹中。如果您不确定哪个是 eligibilityd 的容器目录，您可以一个一个地尝试，或者将下载的文件添加到所有 Deamon 容器中。

```shell
sudo mkdir /private/var/root/Library/Daemon\ Containers/<UUID>/Data/Library/Caches/NeverRestore
sudo cp eligibility_overrides.data /private/var/root/Library/Daemon\ Containers/<UUID>/Data/Library/Caches/NeverRestore/
```

4. 重启 eligitbilityd 服务

```shell
sudo pkill -9 eligibilityd
sudo launchctl kickstart -k system/com.apple.eligibilityd
```

## 故障排除

> [!TIP]
> eligibility_util 和 eligibility_util_sip 的区别在于，后者可以用于开启了SIP的环境（仅部分功能可用）。

### 方案一 util 工具问题

1. 如果看到以下输出

```shell
zsh: no such file or directory: ./eligibility_util
```

请确保当前工作路径含有 `eligibility_util` 的文件。

2. 如果看到以下输出

```shell
zsh permission denied: ./eligibility_util
```

请确保已添加了执行权限 `chmod +x ./eligibility_util`。(检查[手动执行](#手动执行)的第 3 步)

3. 如果看到以下输出

```shell
>[1] 61672 killed ./eligibility_util
```

请确保已禁用了 SIP 设置了正确的 boot-args 并已重启。(检查[手动执行](#手动执行)的第 1 步和第 2 步)

4. 其他问题

```shell
curl -L https://raw.githubusercontent.com/Kyle-Ye/XcodeLLMEligible/release/0.2/scripts/override.sh | bash -s -- doctor
```

### 方案二 override 文件问题

如果你无法访问 Daemon Container 相关文件夹，请检查你使用的终端App是否拥有完全磁盘访问权限。

路径：设置 App -> 隐私和安全性 -> 完全磁盘访问权限 -> 添加你的终端App并允许访问。

### 其他 Xcode LLM 相关问题

1. 确认覆盖生效并且你有正确的 Answer。
```
./eligibility_util_sip getDomainAnswer --domain-name OS_ELIGIBILITY_DOMAIN_XCODE_LLM
```

2. 重新启用 SIP，然后打开 Xcode 下载模型。

See detail for [#4](https://github.com/Kyle-Ye/XcodeLLMEligible/issues/4)

### 其他 Apple Intelligence 相关问题

> 建议：
> 1. 登录美区 Apple ID
> 2. 将地区设置为美国，并将英语设置为首选语音
> 3. 将英语（美国）设置为 Siri 语言

1. 确认覆盖生效并且你有正确的 Answer。

```
./eligibility_util_sip getDomainAnswer --domain-name OS_ELIGIBILITY_DOMAIN_GREYMATTER
```

2. 进入设置 App > "Apple Intelligence & Siri"，点击 "Join Apple Intelligence Waitlist" 按钮。

3. 你将看到 "Joined Waitlist" 标签，然后耐心等待一段时间。 


4. 你将看到 "Preparing" 标签，然后继续耐心等待一段时间。

5. 你将收到 "Apple Intelligence is Here" 通知。

6. 你现在可以打开 Apple Intelligence 并使用它。


## FAQ

1. 在系统更新之后这种方式还会生效吗？

大概率会。Eligibility Override 不需要你在系统更新后再次执行一遍命名。

但是 Apple 可能会在未来更改 eligibility 机制，所以不能保证在系统更新后仍然有效。

2. 为什么在设置里没有 Apple Intelligence？

Apple Intelligence 只在 macOS 15.1 及更高版本上可用。

3. 为什么在设置里没有 ChatGPT 相关?

ChatGPT 集成只在 macOS 15.2 及更高版本上可用。

4. 为什么开启 Apple Intelligence 后，Siri 仍然使用了百度的服务?

Siri 的搜索引擎是由你的地区语言设置和网络环境决定的。请参考互联网上的其他资料选择合适的网络代理进行配置。

eg. https://github.com/VirgilClyne/iRingo

5. 为什么我的 Apple Intelligence 一直卡在下载 100%?

可以尝试关闭 SIP 后删除 AssetsV2 文件夹，然后重新启用 SIP。

```shell
# 关闭SIP (恢复 OS 模式下执行)
csrutil disable
# 重启进入到普通 macOS
# 设置中关闭 Apple Intelligence
# 普通 macOS 的终端中执行
sudo rm -rf /System/Library/AssetsV2
# 开启 SIP (恢复 OS 模式下执行)
csrutil enable
# 设置中开启 Apple Intelligence
```

> See [#62](https://github.com/Kyle-Ye/XcodeLLMEligible/issues/62#issuecomment-2541993096).

6. 为什么我的 Apple Intelligence 中无法使用 ChatGPT?

大概率是网络原因导致，如果你处在不受支持的地区，请确保你使用了全局网络代理等方式来访问该服务。

- 对于 Shadowrocket，开启全局代理即可。
- 对于其他代理工具，请参考其官方文档。

Apple Intelligence 开启手册

# 首先先上效果

- **JAVA类**或者**接口**创建时自动模版生成
- 接口方法**注解模版**自动生成，**包含参数和返回值的自动解析**
- 接口方法**文档doc标注**自动生成，**包含参数和返回值的自动解析**
- 自动生成后，自动光标停留在描述行，并有**TODO**标注，方便描述丝滑添加


 <img src="https://data.golovin.cn/img/0bda1af0e169ec8965dcee7904a4d594.image.png?imagevanblog" width="60%">






# 1. JAVA类、接口IDEA模版配置


:::info{title="JAVA类、接口IDEA模版配置"}

1. 配置项路径：**`File`-->`settings`-->`Editor`-->`File and Code Templates`-->`Files`**
2. 选择**Class**文件（设置**接口**则选择**Interface**文件）

- `${NAME}`：设置类名，与下面的${NAME}一样才能获取到创建的类名
- `TODO`：代办事项的标记，一般生成类或方法都需要添加描述
- `${USER}`、`${DATE}`、`${TIME}`：设置创建类的用户、创建的日期和时间，这些是IDEA内置的方法，还有一些其他的方法在右下方描述框中有详细讲述（虽然是英文），比如你想添加项目名则可以使用`${PROJECT_NAME}`
- 设置版本号，一般新创建的类都是1.0.0版本，这里写死，自行修改
:::

## 1. 效果：


 <img src="https://data.golovin.cn/img/56c458238d4b4f1d81fe25c35f2477f9.image.png?imagevanblog" width="55%">


## 2. 配置图示：

![image.png](https://data.golovin.cn/img/a3782b12f63807cb14dfa6b917342589.image.png?imagevanblog)

## 3. 配置示例代码：

```txt
/**
 * @ClassName ${NAME}
 * @Description // TODO: $end
 * @Author ${USER}
 * @Date ${DATE} ${TIME}
 * @Version 1.0.0
 */
```


# 2. 方法注解模版配置

:::info{title="注解模版配置"}
1. 配置项路径：**`File`-->`settings`-->`Editor`-->`Live Templates`**
2. 新建组：命名为 **`UserDevGroup`**
3. 如下述具体步骤配置，设置生成注释的快捷键为Enter，都配置好后点击OK保存
:::

## 1. 效果：


 <img src="https://data.golovin.cn/img/59ef78599aea5bfbda071ea1baad0d67.image.png?imagevanblog" width="55%">


## 2. 配置图示：（配置成 *）

**1. 配置项关键路径，创建自定义模版组 `UserDevGroup`**

![image.png](https://data.golovin.cn/img/71189d3d39177d493b50658f30d15424.image.png?imagevanblog)

**2. 新建一个方法模版**


 <img src="https://data.golovin.cn/img/249159bbeaa6056e2495ef7985eb8121.image.png?imagevanblog" width="60%">


**3. 设置方法模版，并应用配置（一定要应用，或者点OK保存配置变更）**

![image.png](https://data.golovin.cn/img/de0c95014c2e38b18273fb9bade192d5.image.png?imagevanblog)

**4. 配置变量对应的扩展方法（用于IDEA自动获取数据）**

![image.png](https://data.golovin.cn/img/50c084644057f66b5e22b8cb0a4075f4.image.png?imagevanblog)

**5. 配置应用范围为JAVA项的树列表，并点击OK保存配置**

![image.png](https://data.golovin.cn/img/aff9596ae3db1bae37c976e674d39ab1.image.png?imagevanblog)

## 3. 配置示例代码：（注意第一行是* 而不是完整的/**）

```txt
**
 * @description // TODO: $end$
 * @author lf
 * @date $time$ $date$
 * @param $param$
 * @return $return$
 **/
```

:::tip{title="提示"}
命名为`*`
因为**IDEA**生成注释的默认方式是：/*+模板名+快捷键

比如若设置模板名为**add**快捷键用**Tab**，则生成方式为`/*add+Tab`

如果不采用这样的生成方式**IDEA**中没有内容的方法将不可用，例如获取方法参数的**methodParameters(）**、获取方法返回值的**methodReturnType(）**
:::


# 3. 方法文档doc标注模版配置

:::info{title="文档doc标注模版配置"}
1. 配置项路径：**`File`-->`settings`-->`Editor`-->`Live Templates`**
2. 新建组：命名为 **`UserDocGroup`**
3. 如下述具体步骤配置，设置生成注释的快捷键为Enter，都配置好后点击OK保存
:::

## 1. 效果：


 <img src="https://data.golovin.cn/img/3abe2d8dda3fcebf3e8165e54b15c723.image.png?imagevanblog" width="55%">



## 2. 配置图示：（doc配置成 **）

**1. 配置图示：**
![image.png](https://data.golovin.cn/img/f06d54537a8493d5598189edb0746d94.image.png?imagevanblog)

**2. 变量配置：**

![image.png](https://data.golovin.cn/img/2048e1964212d52b578f1216440fccaf.image.png?imagevanblog)

**3. 同样地，还需要Change应用范围为JAVA项树列表，并点击OK保存**


 <img src="https://data.golovin.cn/img/9da7d5a6123919ddd5951e1b54769536.image.png?imagevanblog" width="60%">


## 3. 配置示例代码：（注意第一行是* 而不是完整的/**）

- template示例代码：

```txt
**
 * @description // TODO: $end$
 * @author lf
 * @date $time$ $date$ $param$ $return$
 **/
```
- param获取脚本

```script
groovyScript("def result = '';def params = \"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] != '')result+='* @param ' + params[i] + ((i < params.size() - 1) ? '\\r\\n' : '')}; return result == '' ? null : '\\r\\n ' + result", methodParameters())
```

- return获取脚本

```script
groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return ' + \"${_1}\"", methodReturnType())
```

# 4. 视频效果

<iframe width="640" height="360" src="https://data.golovin.cn/video/codeTemplate%20Setting.mp4" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>

IDEA注释模板设置（超详细-类和方法）

:::info{title="2024-12-02 更新"}
**添加Mac端自动重置的任务配置方法**
---

**2024-11-22 更新**

**通过脚本重置Navicat试用期的方法（适用于Mac和Windows）**

本文介绍如何通过脚本重置Navicat的试用期，分为Mac和Windows两种环境的详细操作步骤。
:::

---

# Mac端试用期重置方法

## 方案二：自动重置配置

- 转化为sh直接可执行的脚本，可设置为定时任务触发





添加这个sh脚本，找个位置放置：
	`vim /Users/*******/home/scripts/navicat/NavicatRest.sh`

内容如下：

```bash
#!/bin/bash

# Navicat trial reset
NAVICAT_FOLDER=~/Library/Application\ Support/PremiumSoft\ CyberTech/Navicat\ CC/Navicat\ Premium

# Check if the Navicat folder exists before deleting it
if [ -d "$NAVICAT_FOLDER" ]; then
 rm -rf "$NAVICAT_FOLDER"
else
 echo "Navicat folder not found"
 exit 1
fi

# Find the Navicat preferences file
NAVICAT_FILENAME=$(ls -d ~/Library/Preferences/* | grep -i navicat)

# Check if the preferences file exists before using it
if [ -f "$NAVICAT_FILENAME" ]; then
 TRIAL_KEY=$(plutil -p "$NAVICAT_FILENAME" | grep -E "[0-9A-F]{32}" | head -n 1 | awk '{print $1}' | tr -d \")
 
 # Check if the TRIAL_KEY is not empty before removing it
 if [ -n "$TRIAL_KEY" ]; then
 plutil -remove "$TRIAL_KEY" "$NAVICAT_FILENAME" > /dev/null
 else
 echo "Trial key not found"
 exit 1
 fi
else
 echo "Navicat preferences file not found"
 exit 1
fi

open -a "Navicat Premium"
```
- 添加plist自动执行的任务（也可以像linux一样用crontab -e添加定时任务执行）


```bash
cd ~/Library/LaunchAgents/
```
- 添加一个定时任务：
	vim navicat.replace.plist

- 内容如下：


```plist
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
 <key>Label</key>
 <string>com.user.runbashscript</string>
 <key>ProgramArguments</key>
 <array>
 <string>/Users/*******/home/scripts/navicat/NavicatRest.sh</string>
 </array>
 <key>StartCalendarInterval</key>
 <dict>
 <key>Hour</key>
 <integer>13</integer>
 <key>Minute</key>
 <integer>10</integer>
 </dict>
</dict>
</plist>
```

- 查看自动任务语法是否正确，正确会输出OK：

```sh
plutil -lint ~/Library/LaunchAgents/navicat.replace.plist
```
	
正确则会输出：/Users/～/LaunchAgents/navicat.replace.plist: OK

- 然后给自动任务脚本和其中用到的sh文件授权：

```sh
chmod 644 ~/Library/LaunchAgents/navicat.replace.plist
chmod +x /Users/*******/home/scripts/navicat/NavicatRest.sh
```


- 卸载自动任务：
		

```sh
launchctl unload ~/Library/LaunchAgents/navicat.replace.plist
```
- 加载自动任务：
	
```sh
launchctl load ~/Library/LaunchAgents/navicat.replace.plist
```
- 查看是否成功设置自动任务：
	
```sh
launchctl list | grep com.user.runbashscript
```
成功则显示如下：

```sh
*******@Golovins-MacBook-Pro ~ % launchctl list | grep com.user.runbashscript
-	0	com.user.runbashscript
```

## 方案一：navicat函数（时而配置会失效）

将以下脚本添加到 `~/.zprofile` 或其他Shell配置文件中
- 脚本内容：

```bash
navicat() {
 NAVICAT_FOLDER=~/Library/Application\ Support/PremiumSoft\ CyberTech/Navicat\ CC/Navicat\ Premium

 # Check if the Navicat folder exists before deleting it
 if [ -d "$NAVICAT_FOLDER" ]; then
 rm -rf "$NAVICAT_FOLDER"
 else
 echo "Navicat folder not found"
 return 1
 fi

 # Find the Navicat preferences file
 NAVICAT_FILENAME=$(ls -d ~/Library/Preferences/* | grep -i navicat)

 # Check if the preferences file exists before using it
 if [ -f "$NAVICAT_FILENAME" ]; then
 TRIAL_KEY=$(plutil -p "$NAVICAT_FILENAME" | grep -E "[0-9A-F]{32,32}" | head -n 1 | awk '{print $1}' | tr -d ")

 # Check if the TRIAL_KEY is not empty before removing it
 if [ -n "$TRIAL_KEY" ]; then
 plutil -remove "$TRIAL_KEY" "$NAVICAT_FILENAME" > /dev/null
 else
 echo "Trial key not found"
 return 1
 fi
 else
 echo "Navicat preferences file not found"
 return 1
 fi

 open -a "Navicat Premium"
 exit
}
```




### 操作步骤
1. 打开终端，编辑Shell配置文件：
 ```bash
 nano ~/.zprofile
 ```

2. 将上述脚本粘贴到文件末尾并保存。

3. 运行以下命令使配置生效：
 ```bash
 source ~/.zprofile
 ```

4. 每次需要重置试用期时，在终端中运行：
 ```bash
 navicat
 ```

5. 脚本会自动清除试用期记录并启动Navicat。

---

# Windows端试用期重置方法

## 脚本内容
以下是PowerShell版本的脚本，将其保存为 `.ps1` 文件。

```powershell
function Reset-NavicatTrial {
 # Navicat 配置文件夹路径
 $NavicatFolder = "$env:APPDATA\PremiumSoft\Navicat"

 # 检查并删除 Navicat 配置文件夹
 if (Test-Path $NavicatFolder) {
 Remove-Item -Recurse -Force $NavicatFolder
 Write-Host "Navicat folder removed."
 } else {
 Write-Host "Navicat folder not found."
 return
 }

 # 查找偏好文件
 $PreferenceFiles = Get-ChildItem "$env:APPDATA" -Recurse -Include "*.plist" | Where-Object { $_.Name -match "navicat" }

 if ($PreferenceFiles.Count -gt 0) {
 foreach ($file in $PreferenceFiles) {
 try {
 Remove-Item $file.FullName -Force
 Write-Host "Preference file removed: $($file.FullName)"
 } catch {
 Write-Host "Failed to remove: $($file.FullName)"
 }
 }
 } else {
 Write-Host "No preference files found."
 }

 # 启动 Navicat
 $NavicatPath = "C:\Program Files\PremiumSoft\Navicat Premium\navicat.exe"
 if (Test-Path $NavicatPath) {
 Start-Process $NavicatPath
 Write-Host "Navicat started."
 } else {
 Write-Host "Navicat executable not found at $NavicatPath."
 }
}
```

## 操作步骤
1. 将上述脚本保存为 `ResetNavicatTrial.ps1` 文件。

2. 打开PowerShell并运行脚本：
 ```powershell
 .\ResetNavicatTrial.ps1
 ```

3. 如果需要全局使用该功能，可将脚本内容添加到PowerShell配置文件：
 ```powershell
 notepad $PROFILE
 ```
 在打开的文件中粘贴脚本内容并保存。

4. 若遇到权限问题，运行以下命令解除限制：
 ```powershell
 Set-ExecutionPolicy RemoteSigned
 ```

5. 每次需要重置试用期时，运行以下命令：
 ```powershell
 Reset-NavicatTrial
 ```

---

:::warning{title="注意事项"}
- **文件路径确认**：根据你的实际安装路径调整脚本中的路径。
- **备份重要数据**：运行脚本前请备份相关文件。
- **合法使用**：仅用于测试或学习目的，遵守相关法律法规。
:::

Docker 编写部署升级指南

警告

升级步骤

1. 备份您定制的 docker-compose.yaml 文件（可选）

2. 设置 Git 用户信息（如果未设置）

首先先上效果

添加Mac端自动重置的任务配置方法

Mac端试用期重置方法

方案二：自动重置配置

1. 备份您定制的 `docker-compose.yaml` 文件（可选）