gofs使用教程-基于golang的开源跨平台文件同步工具
概述
gofs
是基于golang开发的一款开箱即用的跨平台文件同步工具,开源地址如下:https://github.com/no-src/gofs,欢迎点个Star或者提交Issue和PR,共同进步!
安装
首先需要确保已经安装了Go (版本必须是1.18+),然后你就可以使用下面的命令来安装gofs
了
如果你不需要自行从源码编译安装,也可以直接下载最新发布的二进制文件
go install github.com/no-src/gofs/...@latest
在Docker中运行
如果你想要在docker中运行,请在安装或者编译的时候使用-tags netgo
命令行参数或者设置环境变量CGO_ENABLED=0
,否则当你运行docker容器时可能会报找不到gofs
的错误
go install -tags netgo github.com/no-src/gofs/...@latest
后台运行
在windows系统中,你可以使用下面的命令构建一个在后台运行的不带命令行界面的程序
go install -ldflags="-H windowsgui" github.com/no-src/gofs/...@latest
移除Web文件服务器
如果你不需要一个Web文件服务器,可以使用下面命令构建一个体积更小的不带Web文件服务器的程序
go install -tags "no_server" github.com/no-src/gofs/...@latest
快速开始
先决条件
请确保文件同步的源目录和目标目录都已经存在,如果目录不存在,则用你实际的目录替换下面的路径进行提前创建
$ mkdir source dest
生成仅用于测试的证书和密钥文件,生产中请替换为正式的证书
TLS证书和密钥文件仅用于与Web文件服务器和远程磁盘服务端进行安全通讯
$ go run $GOROOT/src/crypto/tls/generate_cert.go --host 127.0.0.1
2021/12/30 17:21:54 wrote cert.pem
2021/12/30 17:21:54 wrote key.pem
查看你的工作目录
$ ls
cert.pem key.pem source dest
本地磁盘
监控本地源目录将变更同步到目标目录
你可以使用logically_delete
命令行参数来启用逻辑删除,从而避免误删数据
$ gofs -source=./source -dest=./dest
全量同步
执行一次全量同步,直接将整个源目录同步到目标目录
$ gofs -source=./source -dest=./dest -sync_once
定时同步
定时执行全量同步,将整个源目录同步到目标目录
# 每30秒钟将源目录全量同步到目标目录
$ gofs -source=./source -dest=./dest -sync_cron="*/30 * * * * *"
守护进程模式
启动守护进程来创建一个工作进程处理实际的任务,并将相关进程的pid信息记录到pid文件中
$ gofs -source=./source -dest=./dest -daemon -daemon_pid
Web文件服务器
启动一个Web文件服务器用于访问远程的源目录和目标目录
Web文件服务器默认使用HTTPS协议,使用tls_cert_file
和tls_key_file
命令行参数来指定相关的证书和密钥文件
如果你不需要使用TLS进行安全通讯,可以通过将tls
命令行参数指定为false
来禁用它
如果将tls
设置为true
,则服务器默认运行端口为443
,反之默认端口为80
,你可以使用server_addr
命令行参数来自定义服务器运行端口,例如-server_addr=":443"
出于安全考虑,你应该设置rand_user_count
命令行参数来随机生成指定数量的用户或者通过users
命令行参数自定义用户信息来保证数据的访问安全,禁止用户匿名访问数据
如果rand_user_count
命令行参数设置大于0,则随机生成的账户密码将会打印到日志信息中,请注意查看
如果你需要启用gzip压缩响应结果,则添加server_compress
命令行参数,但是目前gzip压缩不是很快,在局域网中可能会影响传输效率
# 启动一个Web文件服务器并随机创建3个用户
# 在生产环境中请将`tls_cert_file`和`tls_key_file`命令行参数替换为正式的证书和密钥文件
$ gofs -source=./source -dest=./dest -server -tls_cert_file=cert.pem -tls_key_file=key.pem -rand_user_count=3
远程磁盘服务端
启动一个远程磁盘服务端作为一个远程文件数据源
source
命令行参数详见远程磁盘服务端数据源协议
注意远程磁盘服务端的用户至少要拥有读权限,例如:-users="gofs|password|r"
# 启动一个远程磁盘服务端
# 在生产环境中请将`tls_cert_file`和`tls_key_file`命令行参数替换为正式的证书和密钥文件
# 为了安全起见,请使用复杂的账户密码来设置`users`命令行参数
$ gofs -source="rs://127.0.0.1:8105?mode=server&local_sync_disabled=true&path=./source&fs_server=https://127.0.0.1" -dest=./dest -users="gofs|password|r" -tls_cert_file=cert.pem -tls_key_file=key.pem
远程磁盘客户端
启动一个远程磁盘客户端将远程磁盘服务端的文件变更同步到本地目标目录
使用sync_once
命令行参数,可以直接将远程磁盘服务端的文件整个全量同步到本地目标目录,就跟全量同步一样
使用sync_cron
命令行参数,可以定时将远程磁盘服务端的文件整个全量同步到本地目标目录,就跟定时同步一样
source
命令行参数详见远程磁盘服务端数据源协议
# 启动一个远程磁盘客户端
# 请将`users`命令行参数替换为上面设置的实际账户名密码
$ gofs -source="rs://127.0.0.1:8105" -dest=./dest -users="gofs|password"
远程推送服务端
启动一个远程磁盘服务端作为一个远程文件数据源,并使用push_server
命令行参数启用远程推送服务端
注意远程推送服务端的用户至少要拥有读写权限,例如:-users="gofs|password|rw"
# 启动一个远程磁盘服务端并启用远程推送服务端
# 在生产环境中请将`tls_cert_file`和`tls_key_file`命令行参数替换为正式的证书和密钥文件
# 为了安全起见,请使用复杂的账户密码来设置`users`命令行参数
$ gofs -source="rs://127.0.0.1:8105?mode=server&local_sync_disabled=true&path=./source&fs_server=https://127.0.0.1" -dest=./dest -users="gofs|password|rw" -tls_cert_file=cert.pem -tls_key_file=key.pem -push_server
远程推送客户端
启动一个远程推送客户端将本地文件变更同步到远程推送服务端
使用chunk_size
命令行参数来设置大文件上传时切分的区块大小,默认值为1048576
,即1MB
更多命令行参数用法请参见远程磁盘客户端
# 启动一个远程推送客户端并且启用本地磁盘同步,将source目录下的文件变更同步到本地dest目录和远程推送服务器上
# 请将`users`命令行参数替换为上面设置的实际账户名密码
$ gofs -source="./source" -dest="rs://127.0.0.1:8105?local_sync_disabled=false&path=./dest" -users="gofs|password"
远程磁盘服务端数据源协议
远程磁盘服务端数据源协议基于URI基本语法,详见RFC 3986
方案
方案名称为rs
主机名
远程磁盘服务端数据源在远程磁盘服务端模式下使用0.0.0.0
或者其他本地网卡IP地址作为主机名,在远程磁盘客户端
模式下使用远程磁盘服务端的IP地址或者域名作为主机名
端口号
远程磁盘服务端数据源端口号,默认为8105
参数
仅在远程磁盘服务端模式下设置以下参数
path
远程磁盘服务端真实的本地源目录mode
指定运行模式,只有在远程磁盘服务端模式下需要手动指定为server
,默认为远程磁盘客户端模式fs_server
Web文件服务器地址,例如https://127.0.0.1
local_sync_disabled
是否将远程磁盘服务端的文件变更同步到远程本地的目标目录,可选值为true
或false
,默认值为false
示例
远程磁盘服务端模式下的示例
rs://127.0.0.1:8105?mode=server&local_sync_disabled=true&path=./source&fs_server=https://127.0.0.1
\_/ \_______/ \__/ \____________________________________________________________________________/
| | | |
方案 主机名 端口号 参数
管理接口
基于Web文件服务器的应用管理接口
默认情况下,仅允许私有地址和回环地址访问管理接口的相关路由
你可以通过将manage_private
命令行参数设置为false
来禁用默认行为,允许公网IP访问管理接口的路由
$ gofs -source=./source -dest=./dest -server -tls_cert_file=cert.pem -tls_key_file=key.pem -rand_user_count=3 -manage
性能分析接口
pprof访问地址如下:
https://127.0.0.1/manage/pprof/
配置接口
读取应用程序配置,默认返回json
格式,当前支持json
和yaml
格式
https://127.0.0.1/manage/config
或者使用format
参数来指定返回的配置格式
https://127.0.0.1/manage/config?format=yaml
报告接口
使用report
命令行参数来启用报告接口的路由并且开始收集报告数据,需要先启用manage
命令行参数
报告接口详情参见Report API
https://127.0.0.1/manage/report
日志
默认情况下会启用文件日志与控制台日志,你可以将log_file
命令行参数设置为false
来禁用文件日志
使用log_level
命令行参数设置日志的等级,默认级别是INFO
,可选项为:DEBUG=0
INFO=1
WARN=2
ERROR=3
使用log_dir
命令行参数来设置日志文件目录,默认为./logs/
使用log_flush
命令行参数来设置自动刷新日志到文件中,默认启用
使用log_flush_interval
命令行参数设置自动刷新日志到文件中的频率,默认为3s
使用log_event
命令行参数启用事件日志,所有事件都会记录到文件中,默认为禁用
# 在"本地磁盘"模式下设置日志信息
$ gofs -source=./source -dest=./dest -log_file -log_level=0 -log_dir="./logs/" -log_flush -log_flush_interval=3s -log_event
使用配置文件
如果需要的话,你可以使用配置文件来代替所有的命令行参数,当前支持json
和yaml
格式
所有的配置字段名称跟命令行参数一样,你可以参考配置示例或者配置接口的响应结果
$ gofs -conf=./gofs.yaml
更多信息
帮助信息
$ gofs -h
版本信息
$ gofs -v
关于信息
$ gofs -about
gofs使用教程-基于golang的开源跨平台文件同步工具的更多相关文章
- [转] X-RIME: 基于Hadoop的开源大规模社交网络分析工具
转自http://www.dataguru.cn/forum.php?mod=viewthread&tid=286174 随着互联网的快速发展,涌现出了一大批以Facebook,Twitter ...
- [开源] 基于ABP,Hangfire的开源Sharepoint文件同步程序----SuperRocket.SPSync
(一)项目背景 Sharepoint是微软的一个产品,很多公司都在使用它,也有很多公司以前使用它,现在可能需要移植到别的平台,也可能只是移植其中的文件存储,比如说移植到微软云,或者亚马逊云存储.Sup ...
- nodejs教程---基于expressJs框架,实现文件上传(upload)?
文件上传功能在nodejs初期是一件很难实现的功能,之后出现了formidable勉强能解决这个问题,但是express框架出现之后基于这个框架开发的中间件有更好的方法来处理文件上传,这个中间件就是m ...
- 开源的文件比较工具:WinMerge,KDiff3,diffuse
为了寻找免费的BeyondCompare的替代品,最后经过实用,找到如下一些: 1.diffuse 感受:如果仅仅是比较两个文本类的文件,这个软件也就够用了. 安装好后,对着文件点击右键,会出现&qu ...
- linux下基于rsync + find命令实现文件同步机制
rsync和find是linux系统自带的命令,如果没有安装可以找到系统安装盘或者ISO文件,里面有rpm包,安装一下就可以了. 具体思路如下: 1)可以实现定时进 ...
- Golang优秀开源项目汇总, 10大流行Go语言开源项目, golang 开源项目全集(golang/go/wiki/Projects), GitHub上优秀的Go开源项目
Golang优秀开源项目汇总(持续更新...)我把这个汇总放在github上了, 后面更新也会在github上更新. https://github.com/hackstoic/golang-open- ...
- 详解:基于WEB API实现批量文件由一个服务器同步快速传输到其它多个服务器功能
文件同步传输工具比较多,传输的方式也比较多,比如:FTP.共享.HTTP等,我这里要讲的就是基于HTTP协议的WEB API实现批量文件由一个服务器同步快速传输到其它多个服务器这样的一个工具(简称:一 ...
- 袋鼠云研发手记 | 数栈·开源:Github上400+Star的硬核分布式同步工具FlinkX
作为一家创新驱动的科技公司,袋鼠云每年研发投入达数千万,公司80%员工都是技术人员,袋鼠云产品家族包括企业级一站式数据中台PaaS数栈.交互式数据可视化大屏开发平台Easy[V]等产品也在迅速迭代.在 ...
- 一款开源的文件搜索神器,终于不用记 find 命令了
这是 HelloGitHub 推出的<讲解开源项目>系列,用一篇文章带你快速上手有趣的开源项目. 今天给大家推荐一个好用+开源的文件搜索工具--fd 该工具支持大多数主流操作系统,快来更新 ...
随机推荐
- Spring Data JPA应用之常规CRUD操作初体验
基于对于一个陌生的技术框架,先使用后研究其实现的原则(大部分本人如此,就如小朋友学习骑自行车不会先研究自行车是怎么动起来的而是先骑会了),对于Spring JPA先通过案例实践其怎么用吧. 用之前得明 ...
- 入门pwn的练习
都是比较简单的一些pwn的题目,也是团队里面的一个人发着做的,因为是初学,所以就还是先从简单的向难得方向去发展. 第一个 先用checksec或者die检测一下, 然后拖入到IDA,shift+f12 ...
- kali linux 安装lanmp遇到的问题
安装LANMP步骤(需要ROOT权限)2020版本以上的Linux kali需要百度参考修改权限得文章 root@kali:~# wget http://dl.wdlinux.cn/files/lan ...
- 【C#基础概念】命名规范
1. 引言 本文是一套面向C# programmer 和C# developer 进行开发所应遵循的开发规范. 按照此规范来开发C#程序可带来以下益处: · 代码的编写保持一致性, · ...
- CVE-2022-22947 Spring Cloud Gateway SPEL RCE复现
目录 0 环境搭建 1 漏洞触发点 2 构建poc 3 总结 参考 0 环境搭建 影响范围: Spring Cloud Gateway 3.1.x < 3.1.1 Spring Cloud Ga ...
- Scala学习笔记(详细)
第2章 变量 val,var,声明变量必须初始化:变量类型确定后不可更改 数据类型:与java有相同的数据类型,在scala中数据类型都是对象 特殊类型:Unit:表示无值,只有一个实例值写出(),相 ...
- .NET 6 在小并发下如何生成唯一单据号
一.场景介绍 小并发下要解决生成单据号的问题,会碰到哪些问题呢?,接下来让我们一探究竟[这是小并发的解决方案,大家有更好的做好可以一起讨论分享]. 之所以叫小并发:是因为确实是小并发场景的应用模式,一 ...
- k8s全方位监控-prometheus部署
1.k8s 监控资源对象 2. prometheus简单介绍. https://github.com/prometheus •多维数据模型:由度量名称和键值对标识的时间序列数据•PromSQL:一种灵 ...
- Python第二
今日内容概要 基本运算符 流程控制 字符编码 理论特别多.结论特别少 文件处理 今日内容详细 基本运算符 1.算数运算符 x = 1 y = 5 res = x + y #加 res1 = x - y ...
- WPF页面后台代码InitializeComponent()报错
InitializeComponent(); 报错: 查看对应的前台xaml文件中,主标签中是否缺失引用: x:class="命名空间.类名"