# docker-frp

**Repository Path**: dz-io/docker-frp

## Basic Information

- **Project Name**: docker-frp
- **Description**: 可能是地表最小的frp容器
- **Primary Language**: Docker
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-11-24
- **Last Updated**: 2022-10-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# docker-frp

## 介绍

可能是地表最小的 frp 容器  
**注：服务端镜像为 daze456/frps，客户端为 daze456/frpc**

## 为何最小

本镜像从空镜像开始构建，因此这玩意仅 4M 大小

## 安装教程

Docker 传统，无需安装  
如果你真想安装的话

```bash
docker pull daze456/frps
docker pull daze456/frpc
```

构建并安装：

1. 先克隆仓库
2. 用默认的 dockerfile 构建服务端

   ```bash
   docker build --build-arg type=s -t daze456/frps:latest "."
   ```

3. 构建客户端
   ```bash
   docker build --build-arg type=c -t daze456/frpc:latest "."
   ```

## 使用说明

本仓库支持四种用法

1. 默认配置  
   镜像内包含一个默认的配置文件，开启了 xtcp、kcp 和 仪表板 功能并且同时兼容服务端和客户端([`cfg.ini`](./cfg/cfg.ini))  
   之所以这么写是希望大家用 docker 的端口开放功能限制实际功能，例子：
   ```bash
   docker run -p 7000:7000 daze456/frps # 服务端，不开启任何高级功能
   docker run -p 7000:7000 -e server_addr=服务器地址 -e token=令牌 daze456/frpc # 客户端，不开启任何高级功能
   ```
   当然你可也以手动配置
2. 手动配置  
   新建一个数据卷，然后把文件复制进数据卷，带着数据卷启动  
   例子：
   ```bash
   # 启动辅助容器
   docker run -itd --name frp -v frp-cfg:/cfg busybox
   # 复制文件
   docker cp ./example-config/frpcc.ini frp-cfg:/cfg/cfg.ini
   # 关停辅助容器
   docker stop frp && docker rm frp
   # 启动frp
   docker run -d --name frp -v frp-cfg:/cfg --net=host daze456/frps
   ```
3. 参数启动  
   本容器支持带参启动，例子：
   ```bash
   docker run daze456/frpc --help
   ```
4. 定制镜像  
   您也可以定制镜像，以下是示例 dockerfile：
   ```dockerfile
   FROM daze456/frpc
   ADD ./example-config/frpcs.ini /cfg/cfg.ini
   ```

## 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request

## 一点破事

这玩意很早以前就新建文件夹了，最初是配合我的服务器使用，然后镜像生成完成以后我把这个文件夹忘了（还有个原因是这个镜像不完善）  
最近把它捡起来结合 frp 的 dashboard 功能做出了最终版  
PS：咕了这么久 frp 版本号还是 0.44.0。。。