#browser #image-viewer #web #media

bin+lib rattice

A media viewer for web browsers

18 releases

0.5.0 Dec 9, 2023
0.4.1 Aug 27, 2023
0.3.2 Feb 16, 2023
0.3.0 Sep 25, 2022
0.0.3 Dec 31, 2021

#392 in Video

Download history 95/week @ 2024-07-05 12/week @ 2024-07-12

63 downloads per month

MIT/Apache

435KB
910 lines

Rattice

crates.io crates.io

A media viewer for web browsers written in Rust.
Images and videos are supported.

screencap

Screenshot of Rattice running with MIT-67 Indoor Scene Recognition Dataset images.

Installation

cargo install rattice

or download prebuilt binary from Releases.

Usage

Quick start

  1. Run rattice in arbitrary directory.
  2. Access http://localhost:3000/

More options

$ rattice --help
Rattice 0.5.0

USAGE:
    rattice [OPTIONS] [PORT]

ARGS:
    <PORT>    Listen port [env: RATTICE_PORT=] [default: 3000]

OPTIONS:
    -b, --bind-address <ADDRESS>
            Bind address [env: RATTICE_BIND_ADDR=] [default: ::]

    -d, --docroot <DOCROOT>
            Specify document root directory [env: RATTICE_DOCROOT=]

    -s, --sort-by <SORT_BY>
            Sort order [env: RATTICE_SORT_BY=] [default: name] [possible values: name, created,
            modified]

    -D, --depth <DEPTH>
            Max display depth of the directory tree [env: RATTICE_DEPTH=] [default: 1]

    -F, --filter-dir <FILTER_DIR>
            Regex for filter directories [env: RATTICE_FILTER_DIR=]

    -f, --filter-file <FILTER_FILE>
            Regex for filter files [env: RATTICE_FILTER_FILE=]

    -u, --username <USERNAME>
            Username for Basic Authentication [env: RATTICE_USER]

    -p, --password <PASSWORD>
            Password for Basic Authentication [env: RATTICE_PASS]

    -R, --random-credencial <LENGTH>
            Generate random username and/or password with given length [env:
            RATTICE_RANDOM_CREDENCIAL=]

    -c, --server-cert <SERVER_CERT>
            Server certificate for HTTPS [env: RATTICE_SERVER_CERT=]

    -k, --server-key <SERVER_KEY>
            Server key for HTTPS [env: RATTICE_SERVER_KEY=]

    -t, --title-prefix <TITLE_PREFIX>
            Prefix for HTML title tag [env: RATTICE_TITLE_PREFIX=] [default: Rattice]

    -x, --real-ip-header <REAL_IP_HEADER>
            Request header field to show as client address in logs (e.g. X-Real-IP) [env:
            RATTICE_REAL_IP_HEADER=]

FLAGS:
    -r, --reverse                Reverse sort order [env: RATTICE_REVERSE=]
    -e, --eager                  Disable lazy image loading [env: RATTICE_EAGER=]
    -i, --ignore-query-params    Ignore query parameters [env: RATTICE_IGNORE_QUERY_PARAMS=]
    -v, --verbose                Increase log level (-v, -vv, -vvv, -vvvv)
    -h, --help                   Print help information
    -V, --version                Print version information

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~24–35MB
~653K SLoC