nexy/README.md

Nexy - Multi-network server for the Nex protocol

Features

• Run IPv4/IPv6 server accessible to Internet, Yggdrasil, Mycelium, and other networks simultaneously, as many as desired;
• Optimized for streaming large files (in chunks) without memory overload on buffering the data;
• Supports the CLF access log, which is compatible with analytics tools such as GoAccess, GoatCounter or just htcount;
• See the Options section for a complete list of other features.

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

-a, --access-log <ACCESS_LOG>
        Absolute path to the access log file

-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]

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

--template-access-denied <TEMPLATE_ACCESS_DENIED>
        Absolute path to the `Access denied` template file

        * this template file can be in binary format (e.g. image)

--template-internal-server-error <TEMPLATE_INTERNAL_SERVER_ERROR>
        Absolute path to the `Internal server error` template file

        * this template file can be in binary format (e.g. image)

--template-not-found <TEMPLATE_NOT_FOUND>
        Absolute path to the `Not found` template file

        * this template file can be in binary format (e.g. image)

--template-welcome <TEMPLATE_WELCOME>
        Absolute path to the `Welcome` template file. Unlike `template-index`, this applies only to the `public` location

        * this template file expects pattern and cannot be in binary format

        **Patterns** * `{list}` - entries list for the `public` directory

--template-index <TEMPLATE_INDEX>
        Absolute path to the `Index` template file for each directory

        * this template file expects pattern and cannot be in binary format

        **Patterns** * `{list}` - entries list for the current 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