Skip to content

Options

James58899 edited this page Jul 9, 2024 · 7 revisions

The options of hath-rust are similar to the official ones. You can refer to the Official wiki.

Help

Usage: hath-rust [OPTIONS]

Options:
  -p, --port <PORT>                      Overrides the port set in the client's settings
      --cache-dir <CACHE_DIR>            Cache data location [default: cache]
      --data-dir <DATA_DIR>              Login data location [default: data]
      --download-dir <DOWNLOAD_DIR>      Downloader save location [default: download]
      --log-dir <LOG_DIR>                Logs location [default: log]
      --temp-dir <TEMP_DIR>              Temporary location for proxy request [default: tmp]
      --disable-logging                  Disable writing non-error logs to file
      --flush-log                        Flush the logs to disk every line
      --max-connection <MAX_CONNECTION>  Override the max connection soft limit, should only be used in special cases [default: 0]
      --disable-ip-origin-check          Disable server command ip check
      --proxy <PROXY>                    Configure proxy for fetch cache
      --force-background-scan            Force background cache scan, even if verify cache integrity is enabled
  -q...                                  Quiet console output (specify multiple times to be quieter)
  -h, --help                             Print help
  -V, --version                          Print version

Force background scan

Normally the cache scan will run in the background, but if Verify cache integrity is checked on the settings page, a full cache scan will be performed to check the integrity of all files and wait for the scan to complete before starting the client, because corrupt cache files will reduce the quality score.

If --force-background-scan is specified, the full cache scan will run in the background without waiting to complete before starting the client.
This is useful if you are not sure whether the cache file is corrupt and want to perform a full scan but don't want the client to be down for a long time.

Docker example

docker run ... ghcr.io/james58899/hath-rust --port <PORT>
Clone this wiki locally