Update README.md

README.md

@@ -1 +1,77 @@
-# frpc
+# frpc
+## 项目简介
+基于 [fatedier/frp](https://github.com/fatedier/frp) 原版 frp 内网穿透客户端 frpc 的一键安装卸载脚本和 docker 镜像.支持群晖NAS,Linux 服务器和 docker 等多种环境安装部署.
+
+- GitHub [stilleshan/frpc](https://github.com/stilleshan/frpc)
+- Docker [stilleshan/frpc](https://hub.docker.com/r/stilleshan/frpc)
+
+## 使用说明
+以下分为四种部署方法,请根据实际情况自行选择:
+- 群晖NAS docker 安装 **[支持 docker 的群晖机型首选]**
+- 群晖NAS 一键脚本安装 **[不支持 docker 的群晖机型]**
+- Linux 服务器 一键脚本安装 **[内网 Linux 服务器或虚拟机]**
+- Linux 服务器 docker 安装 **[内网 Linux 服务器或虚拟机]**
+
+### 群晖NAS docker 安装
+[群晖NAS使用Docker安装配置frpc内网穿透教程](https://www.ioiox.com/archives/26.html)
+
+### 群晖NAS 一键脚本安装
+[群晖NAS安装配置免费frp内网穿透教程](https://www.ioiox.com/archives/6.html)
+
+### Linux 服务器 一键脚本安装
+安装
+```shell
+wget https://raw.githubusercontent.com/stilleshan/frpc/master/frpc_linux_install.sh && chmod +x frpc_linux_install.sh && ./frpc_linux_install.sh
+```
+
+使用
+```shell
+vi /usr/local/frp/frpc.ini
+# 修改 frpc.ini 配置
+sudo systemctl restart frpc
+# 重启 frpc 服务即可生效
+```
+
+卸载
+```shell
+wget https://raw.githubusercontent.com/stilleshan/frpc/master/frpc_linux_uninstall.sh && chmod +x frpc_linux_uninstall.sh && ./frpc_linux_uninstall.sh
+```
+
+### Linux 服务器 docker 安装
+为避免因 **frpc.ini** 文件的挂载,格式或者配置的错误导致容器无法正常运行并循环重启.请确保先配置好 **frpc.ini** 后在运行启动.
+
+先 **git clone** 本仓库,并正确配置 **frpc.ini** 文件.
+```shell
+git clone https://github.com/stilleshan/frpc.git
+# git clone 本仓库
+vi /root/frpc/frpc.ini
+# 配置 frpc.ini 文件
+```
+
+执行以下命令启动服务
+```shell
+docker run -d --name=frpc --restart=always -v /root/frpc/frpc.ini:/frp/frpc.ini stilleshan/frpc
+```
+> 以上命令 -v 挂载的目录是以 git clone 本仓库为例,也可以在任意位置手动创建 frpc.ini 文件,并修改命令中的挂载路径.
+
+服务运行中修改 **frpc.ini** 配置后需重启 **frpc** 服务.
+```shell
+vi /root/frp/frpc.ini
+# 修改 frpc.ini 配置
+docker restart frpc
+# 重启 frpc 容器即可生效
+```
+
+## 版本更新
+- latest 为最新版
+- Tags 为历史版本
+
+## 相关链接
+更多frp相关信息可参考我的博客
+- Blog [www.ioiox.com](https://www.ioiox.com)
+- GitHub [stilleshan/frpc](https://github.com/stilleshan/frpc)
+- Docker [stilleshan/frpc](https://hub.docker.com/r/stilleshan/frpc)
+- 原版frp项目 [fatedier/frp](https://github.com/fatedier/frp)
+- [群晖NAS使用Docker安装配置frpc内网穿透教程](https://www.ioiox.com/archives/26.html) 
+- [群晖NAS安装配置免费frp内网穿透教程](https://www.ioiox.com/archives/6.html)
+- [新手入门 - 详解 frp 内网穿透 frpc.ini 配置](https://www.ioiox.com/archives/79.html)