Skip to content

Latest commit

 

History

History
50 lines (31 loc) · 1.06 KB

getting-started.md

File metadata and controls

50 lines (31 loc) · 1.06 KB

Getting started

Installation

From source

Requirements

  • rust (^1.62)
  • cargo (^1.62)
  • git

  1. Clone repository

    git clone https://github.com/Hulxv/vnstat-server.git vns

  2. Build project

    cd vns
cargo build --release -p vns -p vnsd

  3. Setup

    cd target/release
mv vns vnsd /bin

Usage

Before using vnStat-server, you should know that there are two programs, one is used as a daemon and another is used as a utility to do some operations like controlling the HTTP server (see for more).

  • vnsd (vnStat Server Daemon)

    It's a daemon that is used to run an HTTP server (RESTful API) that is used to control in vnStat and get its data by HTTP requests.

  • vns (vnStat Server cli utility)

    a Utility used by the end-user to control in HTTP server efficiently and easily by connecting with vnsd by unix-socket.

More