Cpolar 简明开关手册

cpolar_handbook.md

🚀 Cpolar 简明开关手册

适用于 macOS、Linux（树莓派）与 Windows 系统
说明：本文假设你已完成 cpolar 安装，并通过 cpolar service install 将其注册为系统服务。

---

🧩 macOS 系统

macOS 下的 Cpolar 运行方式与 Linux 类似，同样采用 launchctl 管理服务。
（前提：已执行过 sudo cpolar service install）

常用命令

# 启动服务
sudo cpolar service start

# 停止服务
sudo cpolar service stop

# 重启服务
sudo cpolar service restart

说明

• macOS 上服务由 LaunchDaemon 管理，安装后生成的配置文件路径通常为：

  /Library/LaunchDaemons/com.cpolar.service.plist
  

• 若修改了配置文件（一般在 ~/.cpolar/cpolar.yml 或 /usr/local/etc/cpolar/cpolar.yml），需重启服务才能生效。

• 可通过以下命令查看是否开机自启：

  sudo launchctl list | grep cpolar

---

🐧 Linux / 树莓派 系统

（前提：已通过 sudo cpolar service install 或官方脚本注册为 systemd 服务）

常用命令

# 启动服务
sudo systemctl start cpolar

# 停止服务
sudo systemctl stop cpolar

# 重启服务
sudo systemctl restart cpolar

# 查看运行状态
sudo systemctl status cpolar

说明

• 服务默认配置文件路径：

  /usr/local/etc/cpolar/cpolar.yml
  

• 若修改配置文件，请执行 sudo systemctl restart cpolar 以应用变更。

• 管理开机自启：

  sudo systemctl enable cpolar   # 设置开机自启
  sudo systemctl disable cpolar  # 取消开机自启

---

🪟 Windows 系统

Windows 版本自带服务管理器，通过 cpolar service 命令操作。

常用命令

# 启动服务
cpolar service start

# 停止服务
cpolar service stop

# 重启服务
cpolar service restart

说明

• 默认配置文件路径：

  C:\Users\<用户名>\.cpolar\cpolar.yml
  

• 若修改了配置文件，请执行：

  cpolar service restart

• 可在系统服务面板中查看状态：

  Win + R → services.msc → 查找 “cpolar”
  

• Windows 下 Cpolar 会注册名为 cpolar 的系统服务，可设置为自动启动。

---

🧰 附录：通用命令

# 查看版本号
cpolar version

# 测试配置文件是否正常
cpolar -t -f /path/to/cpolar.yml

---

📎 备注

• 修改配置后务必 重启cpolar服务，否则新配置不会生效。
• 若遇到认证或端口错误，请确认配置文件中的 authtoken 与 remote_addr 正确无误。
• 若希望服务随系统启动，请启用系统级开机自启（详见上文各系统说明）。