• 数据库URL：在此处指定您的Postgresql实例的连接URI。示例文件中为postgres://用户:密码@127.0.0.1/mitsuba。请用正确的用户名、密码以及地址、端口和数据库名称替换。如果该用户已经是指定数据库（在此例中称为mitsuba）的所有者，则无需创建；否则，您需要自行创建。

• 数据根：保存图片文件的目录。这是一个可选设置。如果您完全省略，Mitsuba将在当前工作目录中创建一个“data”文件夹，并使用它。

• RUST_LOG：推荐的设置是“mitsuba=info”。这控制了mitsuba的日志输出。目前mitsuba使用env_logger，它只将日志信息打印到标准输出（控制台）。如果没有设置，您将只能看到错误和警告，而没有其他反馈。

唯一必需的设置是DATABASE_URL，但RUST_LOG="info"也是推荐的。只需使用example.env文件内容，并更改数据库URI。

在本指南中，我们将从现在起将可执行文件称为mitsuba，但在Windows®上，它当然称为mitsuba.exe。

运行mitsuba help以获取快速使用指南和可能的命令列表

$ mitsuba help
mitsuba 1.0
High performance board archiver software. Add boards with `add`, then start with `start` command.
See `help add` and `help start`

USAGE:
    mitsuba.exe <SUBCOMMAND>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

SUBCOMMANDS:
    add                Add a board to the archiver, or replace its settings.
    help               Prints this message or the help of the given subcommand(s)
    list               List all boards in the database and their current settings. Includes
                       disabled ('removed') boards
    remove             Stop and disable archiver for a particular board. Does not delete any
                       data. Archiver will only stop after completing the current cycle.
    start              Start the archiver, API, and webserver
    start-read-only    Start in read only mode. Archivers will not run, only API and webserver

您可以使用mitsuba help COMMAND来获取每个命令和可能的选项的更详细信息

$ mitsuba help add
Add a board to the archiver, or replace its settings.

USAGE:
    mitsuba.exe add [OPTIONS] <name>

ARGS:
    <name>    Board name (eg. 'po')

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
        --full-images <full-images>    (Optional) If false, will only download thumbnails for this
                                       board. If true, thumbnails and full images. Default is false.

此命令将为指定的板及其设置添加数据库条目。下次运行Mitsuba时，将为该板以及您使用add添加的任何其他板启动存档器。

如您所见，板特定设置只有一个选项。

• full-images=true将使存档器下载该板的完整图片（和文件）。默认值是false，意味着只下载缩略图。

请注意，每次您在之前已添加的板上使用add时，如果该板已被remove禁用，则启用该板，并用您指定的值或默认值替换该板的配置，或之前的设置将被忽略。所以，如果您之前在/po/上启用了完整图像下载，等待时间为100，然后执行mitsuba add po，设置将重置为默认的无完整图像下载，等待时间为10。

因此，让我们添加我们的第一个板，/po/是一个很好的例子，因为它通常是4chan上最慢的板

mitsuba add po --full-images=true
Added /po/ Enabled: true, Full Images: true
If mitsuba is running, you need to restart it to apply these changes.

我们将获取所有图片，我们将在前一个更新完成后10分钟后寻找新的线程更新。让我们使用list命令确认我们的更改，该命令列出添加到mitsuba的所有板。

$ mitsuba list
/po/ Enabled: true, Full Images: true
1 boards found in database

• Enabled表示该板目前正在积极存档。

最后，我们来看看start命令

$ mitsuba help start
Start the archiver, API, and webserver

USAGE:
    mitsuba.exe start [OPTIONS]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
        --archiver-only <archiver-only>        (Optional) If true, will only run the archiver and
                                               not the web ui or the web API. If false, run
                                               everything. Default is false.
        --burst <burst>                        (Optional) Max burst of requests started at once.
                                               Default is 10.
        --jitter-min <jitter-min>              (Optional) Minimum amount of jitter to add to rate-
                                               limiting to ensure requests don't start at the same
                                               time, in milliseconds. Default is 200ms
        --jitter-variance <jitter-variance>    (Optional) Variance for jitter, in milliseconds.
                                               Default is 800ms. Jitter will be a random value
                                               between min and min+variance.
        --max-time <max-time>                  (Optional) Maximum amount of time to spend retrying a
                                               failed image download, in seconds. Default is 600s
                                               (10m).
        --rpm <rpm>                            (Optional) Max requests per minute. Default is 60.

此命令启动我们添加的板的存档器和用于浏览存档以及JSON API的Web UI。有各种选项，所有这些都与存档器的速率限制相关，除了一个：archiver-only。

--archiver-only=true 将启动 mitsuba 仅作为归档器。将获取帖子，下载图片，但没有 Web UI 或 API 来查看归档内容。此选项不太有用，但将使用 大量 更少的 RAM，降至 ~9-17MB。您可以单独运行 Web UI 和 API，使用 mitsuba start-read-only。如果您想的话，甚至可以同时运行多个 Web UI 实例，因为它像名字暗示的那样是只读的。

--rpm 是主要的速率限制选项。它决定了 mitsuba 对 4chan API 和图片服务器的请求频率，全局范围内。所有速率限制设置都是全局的，适用于所有版块和图片，但请注意，图片和 API 调用（用于获取线程）在速率限制中是 单独 计数的。

这意味着如果您将 RPM 设置为 60，mitsuba 将每分钟执行 60 次请求（最多，平均将少得多，这取决于有多少线程被更新）以获取 4chan API 上的新线程，并且 它将每分钟执行 60 次请求以获取图片，全局总请求量为每分钟最多 120 次。这种分离确保即使有大量的图片要下载，mitsuba 也可以同时继续获取新帖子，而不会相互干扰。

现在我们可以使用 mitsuba start 启动我们的归档器。它将开始归档板 /po/ 的工作。过了一会儿，您可以通过访问 http://127.0.0.1:8080/po/1 浏览您的归档。

您可以使用 mitsuba start-read-only 启动 mitsuba 的只读实例，它将仅提供 Web UI 和 API，但不进行任何归档。

您可以通过单独运行归档器使用 mitsuba start --archiver-only=true，然后单独启动 mitsuba start-read-only。这意味着您可以停止或重启归档器，添加新的要归档的板，而不会对正在浏览归档的用户造成任何明显的干扰。您也可以根据需要运行多个 mitsuba start-read-only 实例，或者使用 mitsuba start 运行完整的归档器和 Web UI，并附带额外的只读实例。

Web UI

Web UI 目前设计得看起来和功能都与 4chan 的 Yotsuba Blue 主题完全相同，只是在每个版块上都是如此（即使是非安全版块）。我们还包含了 4chan 的官方默认“内联扩展”，包括所有功能和选项（内联扩展许可为 MIT）。

JS 代码经过反复试验和错误修改以与 Mitsuba 正确工作。如果您发现问题，请提交错误报告。

在其他方面，Mitsuba 的 UI 看起来和功能（几乎）与 4chan 的 UI 完全相同，因为它们确实是相同的。这只是一个简单易行的短期解决方案，并允许我们利用我们的 API 与 4chan 的 API 相同的事实，从而使内联扩展工作。将来，我们希望使用不同的颜色自定义主题至少，以区分它，并添加适合归档的功能。

Web UI 也支持禁用 JavaScript，就像 4chan 的 UI 一样。

4chan的大多数功能在Web UI中都能正确显示。一个限制是，目前仅支持真实国家的国旗，而“捣蛋国旗”（例如“无政府资本主义”国旗）在UI中根本不显示。然而，这些功能只在其中一个论坛(/pol/)上启用。

此外，所有大写代码帖子（例如Mod、Admin、Manager等）都将与“版主”一样显示，没有角色之间的区别。这些帖子非常罕见（除了正确显示的“版主”），我认为目前没有这样的帖子，而且这种区别似乎并不重要。也许最终会修复。

Flash论坛也有一些我们没有实现的功能，但Flash已经死了。

注意

目前，Web UI在处理URL方面非常不灵活。例如，对于一条线程，你必须访问/[board]/thread/[id]，例如/po/thread/570368/welcome-to-po会因为尾部的welcome-to-po而返回404。

索引页面需要在URL中明确包含索引号，例如/po/1可以工作，但仅/po/本身会返回404。这是WIP。此外，没有任何主页/。

API

Mitsuba提供了一个只读的JSON API，该API旨在与4chan的官方API兼容。因此，我们在这里不会完全记录它，因为这将是多余的。你可以阅读他们的文档，因为URI和数据返回大多是相同的。以下有一些（非破坏性）差异，将在下面进行解释（当然，除了这个API不是从4chan的域名提供，而是从你的服务器提供之外）。

首先，目前，只有Threads和Indexes端点已经实现。除此之外，我们还添加了一个端点来提供单个帖子。

• 线程：/[board]/thread/[op ID].json提供完整的4chan线程，格式与官方API使用相同。
• 索引： /[board]/[1...].json 服务器为板索引页的内容。这是您访问板时看到的默认页面，例如 https://boards.4channel.org/po/ 。在4chan上，通常只有15个索引页，例如从 /po/1.json 到 /po/15.json。在Mitsuba上，由于旧帖子永远不会被删除，所以需要多少页面来列出当前存档中的所有帖子就有多少页面。一旦没有更多帖子，较高的索引号将返回404状态码。这意味着您可以轻松地刮取Mitsuba存档，并逐步增加索引直到404。然而请注意，顺序与4chan相同，因此不一定保持一致。顺序是基于哪个帖子最近有新的帖子，而不是帖子最初存档的时间。此外，页面不包含完整的帖子，而只包含OP和几条帖子。

除了这些端点之外，我们还实现了一个仅针对Mitsuba的端点：/[board]/post/[ID].json，该端点仅提供单个帖子。使用此端点，即使只知道其ID而不知道OP的ID，也可以获取帖子。

还有一个额外的端点完全是针对Mitsuba的：/boards-status.json，它返回与CLI的list命令相同的数据，但格式为JSON。

与4chan API的差异

与4chan API的主要区别是，每个帖子都包含一个board字段，其中包含其所在的板名称。

除此之外，在4chan API不会返回字段的所有情况下，我们返回该字段并使用默认值。

4chan API中仅有的类型是整数和字符串，因此对于整数，其值是0，对于字符串则是一个空字符串。这意味着我们的API返回的所有JSON帖子都保证包含帖子可能包含的所有37个字段，无论板或帖子类型如何。例如，在4chan的一侧，sticky字段仅在OP帖子中设置，如果设置了，其值为1。在我们的端点，如果4chan没有设置它，则它将存在但设置为0。

PROXY_URL_0=socks5://user:[email protected]:1337
PROXY_URL_1=socks5://user:[email protected]:1337

PROXY_WEIGHT_0=3
PROXY_WEIGHT_1=1

PROXY_ONLY=false
PROXY_WEIGHT_SELF=2