nexy/README.md

Nexy - Multi-network server for the Nex protocol

Run server accessible to Internet IPv4/IPv6, Yggdrasil, Mycelium, and other networks simultaneously, as many as desired. Optimized for streaming large files (in chunks) without memory overload on reading.

Install

1. git clone https://github.com/yggverse/nexy.git && cd nexy
2. cargo build --release
3. sudo install target/release/nexy /usr/local/bin/nexy

Usage

nexy -p /path/to/public_dir

• by default, server starts on localhost; change it with the --bind option(s)

Options

-b, --bind <BIND>
        Bind server(s) `host:port` to listen incoming connections

        * use `[host]:port` notation for IPv6

        [default: 127.0.0.1:1900 [::1]:1900]

-d, --debug <DEBUG>
        Debug level

        * `e` - error * `i` - info

        [default: ei]

-t, --template <TEMPLATE>
        Absolute path to the template files directory

-p, --public <PUBLIC>
        Absolute path to the public files directory

-r, --read-chunk <READ_CHUNK>
        Optimize memory usage on reading large files or stream

        [default: 1024]

-h, --help
        Print help (see a summary with '-h')

-V, --version
        Print version