filebin2

Filebin2是一个便捷的网络文件共享Web应用。它是驱动https://filebin.net的软件。目前仍处于开发状态，可能会有重大变更。

目录

• 为什么选择filebin2?
• 开发环境
• 使用方法
• 集成

为什么选择filebin2?

filebin的前一版本中一些（事后看来）不当的架构决策促成了filebin2的诞生。Filebin2使用PostgreSQL数据库处理元数据，使用S3存储文件。由于与filebin前一版本存在重大变更，我决定将其移至新的代码库。

开发环境

开发环境包含一个PostgreSQL实例、一个MinIO对象存储实例和一个filebin2实例。最简单的搭建方法是克隆此代码库并执行：

docker-compose up --build

这将使：

• Filebin2可在http://localhost:8080/访问。
• Filebin2管理界面可在http://admin:changeme@localhost:8080/admin访问。
• MinIO可在http://localhost:9000/访问。
• PostgreSQL可在localhost:5432访问。

使用方法

Filebin可在大多数Linux发行版上运行，很可能也能在MacOS等其他操作系统上运行。它可以在Docker中运行良好，但不必在Docker中运行。

Filebin需要对S3存储桶有读写权限以进行文件存储，并需要一个PostgreSQL数据库来存储元数据。

Filebin程序本身用Go编写，编译后生成一个单独的二进制文件，通过命令行参数进行配置。

测试和构建

运行测试套件最简单的方法是在docker compose中运行。如果测试成功，Docker将成功退出（返回代码0），如果测试失败，则会以非0的错误代码退出。

docker-compose -f ci.yml up --abort-on-container-exit

可以使用以下命令构建程序：

make linux

输出将是artifacts/文件夹中名为filebin2-linux-amd64的单个二进制文件。该二进制文件接受下面列出的命令行参数。

命令行参数

--access-log string（默认值："/var/log/filebin/access.log"）

访问日志输出的文件路径。

--admin-password string（默认值：未设置）

访问/admin端点所需的密码。如果未设置密码，则管理端点将不可用。请确保将此密码保密。

--admin-username string（默认值：未设置）

访问/admin端点所需的用户名。如果未设置密码，则管理端点将不可用。

--allow-robots（默认值：未设置）

如果设置此参数，则X-Robots-Tag响应头将允许搜索引擎索引并在搜索结果中显示Filebin。否则，将指示机器人不在搜索结果中显示文件和存储桶。

--baseurl string（默认值："https://filebin.net"）

要使用的基本URL，影响向用户显示的文件和存储桶的URL，需要指向filebin实例的主机名。

--db-host string（默认值：无）

要连接的PostgreSQL主机。可以是IP地址或主机名。

--db-name string（默认值：无）

要使用的PostgreSQL数据库名称。

--db-password string（默认值：无）

验证PostgreSQL数据库时使用的密码。

--db-port string（默认值：无）

连接PostgreSQL数据库时使用的端口。

--db-username string（默认值：无）

验证PostgreSQL数据库时使用的用户名。

--expiration int（默认值：604800）

存储桶过期时间，以自上次存储桶更新以来的秒数计。存储桶在此时间后将无法访问，文件将被lurker删除（参见--lurker-interval）。

--limit-file-downloads uint（默认值：禁用）

此参数可用于限制每个文件的下载次数。0（默认值）表示无限制。如果值为100，则每个文件可以下载100次，之后将拒绝进一步下载。

--limit-storage string（默认值：禁用）

此参数可用于限制filebin将使用的存储容量。0（默认值）表示无限制。如果设置为"200GB"，则filebin将允许文件上传，直到上传到filebin的文件使用的总存储容量超过200 GB。在存储消耗再次低于200 GB之前，新的文件上传将被拒绝（参见--lurker-interval）。

--listen-host string（默认值："127.0.0.1"）

Filebin将绑定的IP地址。默认值127.0.0.1是一个安全的默认值，不会在主机外部暴露Filebin。

--listen-port int（默认值：8080）

Filebin将侦听的端口。默认值8080不需要特权访问。

--log-retention uint（默认值：7）

在lurker（参见--lurker-interval）删除事务日志条目之前，在PostgreSQL数据库中保留事务日志条目的天数。

--lurker-interval int（默认值：300）

lurker是一个自动在后台运行的批处理作业，用于删除过期的存储桶和从数据库中删除旧的日志条目。此参数用于指定lurker在每次执行之间休眠的时间。值以秒为单位指定。

--manual-approval（默认值：未设置）

如果设置此参数，则管理员需要手动批准新的存储桶，然后才能下载文件和存档。除下载外的存储桶和文件操作在存储桶待批准时仍被接受。这是一种限制滥用的机制。

用于批准存储桶的API请求是经过身份验证的PUT /admin/approve/{bin}

--metrics-username（默认值：未设置）

用于 Prometheus 指标 /metrics 端点认证的用户名。如果未设置用户名，该端点将被禁用。

--metrics-password（默认：未设置）

用于 Prometheus 指标 /metrics 端点认证的密码。如果未设置用户名，该端点将被禁用。

--metrics（默认：false）

启用 /metrics 端点。如果未设置，该端点将不会返回任何指标。

--metrics-auth（默认：未设置）

启用身份验证。目前仅支持基本认证。如果将 --metrics-auth 或（环境变量）METRICS_AUTH 设置为 basic，将启用基本认证。否则，该端点对外界开放。

--metrics-id（默认：主机名）

在 Prometheus 指标中用作 filebin 实例标识的字符串。默认为 $HOSTNAME 环境变量。

--metrics-proxy-url（默认：未设置）

设置此参数后，Filebin 将从指定的 URL 获取内容并将其与 /metrics 端点的自身输出合并。当在同一操作系统实例中运行另一个 Prometheus 导出器时，这可能很有用，例如捕获系统指标。

--mmdb string（默认：未设置）

mmdb 格式的 geoip 数据库路径，如 GeoLite2-City.mmdb。这是可选的。

--proxy-headers（默认：未设置）

如果设置此参数，则客户端 IP 将从传入 HTTP 请求中提供的代理头中读取。仅当 Filebin 前面有 HTTP 代理运行，并使用代理头告知 Filebin 原始客户端 IP 地址时，才应设置此参数。

--reject-file-extensions string（默认：未设置）

将被拒绝的文件扩展名列表，以空格分隔。例如："exe bat dll"。

--s3-access-key string（默认：未设置）

连接存储文件的 S3 存储桶时使用的访问密钥。

--s3-bucket string（默认：未设置）

S3 中存储文件的存储桶名称。

--s3-endpoint string（默认：未设置）

要连接的 S3 端点。可以是主机名或 IP 地址。在非标准端口上自托管 S3 时，可以使用 主机名:端口 指定端口。

--s3-region string（默认：未设置）

存储桶所在的 S3 区域。

-s3-secret-key string（默认：未设置）

连接存储文件的 S3 存储桶时使用的密钥。

--s3-secure（默认：true）

Filebin 是否要求与 S3 的连接使用 https 进行 TLS 加密。如果此参数设置为 false，Filebin 将尝试使用普通 http 连接到 S3。

--s3-trace（默认：未设置）

启用 S3 HTTP 跟踪以进行调试。这将为文件上传提供详细日志。

--s3-url-ttl string（默认："1m"）

当 Filebin 用户下载文件时，将使用包含有限生存时间令牌的预签名 URL 进行。默认允许预签名 URL 在过期前使用 1 分钟。该值使用时间单位指定，例如 30s、5m 和 2h。

--slack-channel string（默认：无）

如果 Filebin 设置为需要手动批准新存储桶（参见 --manual-approval），则可以通过用户界面、直接使用 http api 或通过 Slack（使用 http api）进行批准。

可以使用来自 Slack 的 webhook 访问 http 端点 /integration/slack。

此参数限制允许访问 http api 的 Slack 频道。来自其他频道的请求将被拒绝。

--slack-domain string（默认：未设置）

此参数限制允许访问 http api 的 Slack 域。其他域将被拒绝。

--slack-secret string（默认：未设置）

此参数指定 Slack 连接到 http api 时需要使用的密钥。如果未设置此密钥，Slack 集成将被禁用。

--tmpdir string

上传和下载的临时文件目录（默认为 "/tmp"）。

集成

Grafana 和 Prometheus

Filebin2 提供了与 Prometheus 兼容的 /metrics 端点。有一个示例仪表板可以可视化这些数据。

Slack

如果需要手动批准（参见 --manual-approval），此集成可能很有用。该集成允许 Slack 频道成员列出最近更新的存储桶，并使用斜杠命令直接在 Slack 频道中批准特定存储桶。可用的斜杠命令有：

斜杠命令	描述
/filebin approve bin_id	批准存储桶 bin_id
/filebin lastupdated	列出最近更新的 10 个存储桶
/filebin lastupdated n	列出最近更新的 n 个存储桶

目前尚无关于如何配置 Slack 以使用此集成的文档。