文章目录

  • 1.所有可用参数
  • 2.filebrowser [command]
  • 2.1 config 配置文件相关
  • 2.1.1 查看配置
  • 2.1.3 导入配置文件
  • 2.1.4 更新配置 `filebrowser config set 参数`
  • 2.2 用户相关命令
  • 2.2.1 添加新用户
  • 2.2.2 导出导入用户
  • 2.2.4 查找所有用户
  • 2.2.5 更新用户信息
  • 2.2.6 删除指定用户
  • 3 总结


1.所有可用参数

-a, --address string                     要侦听的地址(默认值为 "127.0.0.1"")
  -b, --baseurl string                     基础url
      --cache-dir string                   文件缓存目录(如果为空则禁用)
  -t, --cert string                        tls证书
  -c, --config string                      配置文件路径
  -d, --database string                    数据库路径(默认值 "./filebrowser.db")
      --disable-exec                       禁用命令运行器功能
      --disable-preview-resize             禁用调整图像预览的大小
      --disable-thumbnails                 禁用图像缩略图
      --disable-type-detection-by-header   通过读取文件头禁用类型检测
  -h, --help                               帮助
      --img-processors int                 图像处理器计数(默认值4)
  -k, --key string                         tls密钥
  -l, --log string                         日志输出(默认 "stdout") 
      --noauth                             使用快速设置时使用noauth auther
      --password string                    使用快速配置时第一个用户的Hash密码(默认为 "admin")
  -p, --port string                        监听端口(默认为 "8080")
  -r, --root string                        根以前置到相对路径(默认 ".")
      --socket string                      要侦听的套接字(不能与地址、端口、证书或密钥参数一起使用)
      --socket-perm uint32                 unix套接字文件权限(默认438) 
      --username string                    使用快速配置时第一个用户的用户名(默认为 "admin")

2.filebrowser [command]

cmds        命令运行程序管理实用程序
  config      配置管理实用程序
  hash        hash密码
  help        关于任何命令的帮助
  rules       规则管理实用程序
  upgrade     升级旧配置
  users       用户管理实用程序
  version     获取版本号

2.1 config 配置文件相关

用法: filebrowser config [命令]

可用命令:
        cat         查看配置信息
        export      将配置导出到文件
        import      导入配置文件
        init        初始化新数据库
        set         更新配置

      Flags:
        -h, --help   获取config帮助

2.1.1 查看配置

filebrowser config cat

Sign up:          false               // 关闭注册工程
Create User Dir:  false				  // 关闭自动创建用户目录
Auth method:      json				  // 登录验证方式
Shell:								  // Shell 相关

Branding:                             // 个性化配置
  Name:
  Files override:
  Disable external links:  false

Server: // 服务器配置                            
  Log:           stdout              // 日志输出名称
  Port:          8080				 // 端口
  Base URL:                          // 访问文件基本路径
  Root:          .					 // 根路径 
  Socket:							 // Socket通信相关
  Address:       127.0.0.1           // 访问地址
  TLS Cert:                          // TLS证书
  TLS Key:							 // TLS 密钥
  Exec Enabled:  false

Defaults: // 初始默认值
  Scope:         .
  Locale:        en                  // 语言
  View mode:     mosaic				 // 文件列表视图样式
  Single Click:  false				 // 关闭单击打开文件及文件夹
  Commands:
  Sorting:
    By:
    Asc:  false
  Permissions:  // 默认权限配置
    Admin:     false                // 管理员
    Execute:   true                 // 执行权限
    Create:    true                 // 创建文件及文件夹
    Rename:    true                 // 重命名
    Modify:    true                 // 修改
    Delete:    true                 // 删除
    Share:     true                 // 可共享
    Download:  true                 // 下载

Auther configuration (raw):   // 身份验证方式,默认空

{
  "recaptcha": null
}

####2.1.2 导出配置文件
用法:filebrowser config export 文件名 实例:filebrowser config export config.json

{
    "settings": {
        "key": "你的KEY",
        "signup": false,
        "createUserDir": false,
        "defaults": {
            "scope": ".",
            "locale": "en",
            "viewMode": "mosaic",
            "singleClick": false,
            "sorting": {
                "by": "",
                "asc": false
            },
            "perm": {
                "admin": false,
                "execute": true,
                "create": true,
                "rename": true,
                "modify": true,
                "delete": true,
                "share": true,
                "download": true
            },
            "commands": [],
            "hideDotfiles": false
        },
        "authMethod": "json",
        "branding": {
            "name": "",
            "disableExternal": false,
            "files": "",
            "theme": ""
        },
        "commands": {
            "after_copy": [],
            "after_delete": [],
            "after_rename": [],
            "after_save": [],
            "after_upload": [],
            "before_copy": [],
            "before_delete": [],
            "before_rename": [],
            "before_save": [],
            "before_upload": [],
            "e": [
                "dir"
            ]
        },
        "shell": [],
        "rules": []
    },
    "server": {
        "root": ".",
        "baseURL": "",
        "socket": "",
        "tlsKey": "",
        "tlsCert": "",
        "port": "8080",
        "address": "127.0.0.1",
        "log": "stdout",
        "enableThumbnails": false,
        "resizePreview": false,
        "enableExec": false,
        "typeDetectionByHeader": false
    },
    "auther": {
        "recaptcha": null
    }
}

2.1.3 导入配置文件

用法:filebrowser config import 文件名 实例:filebrowser config import config.json

2.1.4 更新配置 filebrowser config set 参数

可选参数

-a, --address string                     设置访问IP地址(默认 "127.0.0.1")
      --auth.header string                 设置HTTP代理
      --auth.method string                 身份验证类型(默认 "json")
  -b, --baseurl string                     基础URL
      --branding.disableExternal           禁用外部链接,如GitHub链接
      --branding.files string              带有图像和自定义样式的目录路径
      --branding.name string               将“File Browser”替换为此名称
      --cache-dir string                   文件缓存目录(如果为空则禁用)
  -t, --cert string                        tls证书
      --commands strings                   用户可以执行的命令列表
      --disable-exec                       禁用命令运行程序功能
      --disable-preview-resize             禁用调整图像预览的大小
      --disable-thumbnails                 禁用图像缩略图
      --disable-type-detection-by-header   通过读取文件头禁用类型检测
  -h, --help                               获取帮助
      --img-processors int                 图像处理器计数(默认值4) 
  -k, --key string                         tls密钥
      --locale string                      用户区域设置(默认为“en”)
      --lockPassword                       锁定密码
  -l, --log string                         日志输出(默认“stdout”)
      --perm.admin                         用户管理员权限
      --perm.create                        创建权限 (默认 true)
      --perm.delete                        删除权限 (默认 true)
      --perm.download                      下载权限 (默认 true)
      --perm.execute                       执行权限 (默认 true)
      --perm.modify                        修改权限 (默认 true)
      --perm.rename                        重命名权限 (默认 true)
      --perm.share                         分享权限 (默认 true)
  -p, --port string                        端口 (默认 "8080")
      --recaptcha.host string              use another host for ReCAPTCHA. recaptcha.net might be useful in China (default "https://www.google.com")
      --recaptcha.key string               ReCaptcha site key
      --recaptcha.secret string            ReCaptcha secret
  -r, --root string                        根相对路径 (default ".")
      --scope string                       用户范围(默认“.”)
      --shell string                       附加其他命令的shell命令
  -s, --signup                             允许用户注册
      --singleClick                        仅使用单击文件或文件夹
      --socket string                      要侦听的套接字(不能与地址、端口、证书或密钥标志一起使用) 
      --socket-perm uint32                 unix套接字文件权限(默认438)
      --sorting.asc                        按升序排序
      --sorting.by string                  排序模式(名称name、大小size或已修改modified) (默认 "name")
      --viewMode string                    用户的查看模式(默认 "list")

更新端口:filebrowser config set -p 8002 更新根目录:filebrowser config set -r e:// 登录系统可以看到E盘所有文件
初始化数据库: filebrowser config init

2.2 用户相关命令

用法:filebrowser users [命令]

add         创建新用户
        export      将所有用户导出到一个文件
        find        根据用户名或id查找用户
        import      从文件导入用户
        ls          列出所有用户
        rm          根据用户名或id删除用户 
        update      更新现有用户
2.2.1 添加新用户

用法:filebrowser users add <用户名> <密码> [参数] 所有参数

--commands strings    用户可以执行的命令列表
  -h, --help                帮助信息
      --locale string       用户的语言设置(默认为“en”)
      --lockPassword        锁定密码
      --perm.admin          用户管理员权限
      --perm.create         创建权限 (默认 true)
      --perm.delete         删除权限 (默认 true)
      --perm.download       下载权限 (默认 true)
      --perm.execute        执行权限 (默认 true)
      --perm.modify         修改权限 (默认 true)
      --perm.rename         重命名权限 (默认 true)
      --perm.share          分享权限 (默认 true)
      --scope string        访问范围(默认 ".")
      --singleClick         仅使用单击文件或文件夹
      --sorting.asc         按升序排序
      --sorting.by string   排序模式(名称name、大小size或已修改modified) (默认 "name")
      --viewMode string     用户的查看模式(默认 "list")

添加账号和密码为123456的用户
实例:filebrowser users add 123456 123456 结果返回:

ID  Username  Scope  Locale  V. Mode  S.Click  Admin  Execute  Create  Rename  Modify  Delete  Share  Download  Pwd Lock
2   123456    .      en      mosaic   false    false  true     true    true    true    true    true   true      false

2.2.2 导出导入用户

导出
用法:filebrowser users export 文件名 实例:filebrowser users export users.json

导入
用法:filebrowser users import文件名 实例:filebrowser users import users.json

#####2.2.3 根据用户名或ID查找用户
用法:filebrowser users find 用户名或ID 查找ID为1的用户
实例:filebrowser users find 1

ID  Username  Scope  Locale  V. Mode  S.Click  Admin  Execute  Create  Rename  Modify  Delete  Share  Download  Pwd Lock
1   admin     .      zh-cn   mosaic   false    true   true     true    true    true    true    true   true      false

查找用户名为admin的用户
实例:filebrowser users find admin

ID  Username  Scope  Locale  V. Mode  S.Click  Admin  Execute  Create  Rename  Modify  Delete  Share  Download  Pwd Lock
1   admin     .      zh-cn   mosaic   false    true   true     true    true    true    true    true   true      false

2.2.4 查找所有用户

filebrowser users ls

ID  Username  Scope  Locale  V. Mode  S.Click  Admin  Execute  Create  Rename  Modify  Delete  Share  Download  Pwd Lock
1   admin     .      zh-cn   mosaic   false    true   true     true    true    true    true    true   true      false
2   123456    .      en      mosaic   false    false  true     true    true    true    true    true   true      false
3   demo      .      zh-cn   mosaic   false    false  true     true    true    true    true    true   true      false
4   demo1     .      en      mosaic   false    false  true     true    true    true    false   true   true      false

2.2.5 更新用户信息

用法:filebrowser users update 用户名或ID 实例:更新用户名为demo的用户密码为demo
命令:filebrowser users update demo -p demo 参数

--locale string       设置语言 (默认"en")
-p, --password string     新密码
-u, --username string     新账号

2.2.6 删除指定用户

用法:filebrowser users rm 用户名或ID 删除ID为4的用户
实例:filebrowser users rm 4

user deleted successfully

删除用户名为demo的用户
实例:filebrowser users rm demo

3 总结

3、总结
这些命令对普通用户而言比较复杂,但系统在浏览器上大部分还是可以设置的。下面就汇总一些比较常用的命令用法

1.设置地址和端口:filebrowser -a 192.168.200.1 -p 8000 浏览器访问:http://192.168.200.1:8000
2.设置文件地址:filebrowser -a 192.168.200.1 -p 8000 -r e:// 登录系统可以访问E盘下所有的文件
3.每次运行filebrowser不想输入参数,那么可以用config 下的set
如:filebrowser config set -a 192.168.200.1 -p 8000 后面每次启动就不用再次输入-a 192.168.200.1 -p 8000了
4.建议首次运行用filebrowser config export config.json导出配置到文件备份