GRIN/nym

Files

T

Drazen Urch 25053e5e8a Promethus is our friend (#4408 )

* Generic prom wrapper idea

* Extend packet_statistics control with prom metrics

* Replace counters with Counters

* Add legacy mixnode api route

* fmt

* Sanitize metric names

* Format metrics

* Script to make prom targets

* More metrics

* Update script

* Make sure we dont panic in the future

* Remove fragile test

* Add metrics endpoint auth

* Remove per IP metrics

* Update target script, node_exporter setup

* Remove prom from client

* Simplify node stat

* Centralize metrice, break cpucycles temporarily

* Remove prometheus from mixnode

* Add cpu-cycles to Prom

* Further centralize Registry

* Cleanup old tracing

* Remove spurious assignment

* Move cpu-cycles to metrics

* Add features

* setup_logging before logging

* Remove cpucycle measurement in favour of time

* Cleanup, hygine

2024-03-15 14:59:52 +01:00

debian

remove extra line

2024-02-20 09:29:26 +01:00

src

Promethus is our friend (#4408 )

2024-03-15 14:59:52 +01:00

Cargo.toml

Promethus is our friend (#4408 )

2024-03-15 14:59:52 +01:00

README.md

Clean up git

2024-01-26 09:50:18 +01:00

README.md

Nym Mixnode

A Rust mixnode implementation.

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Usage

nym-mixnode prints a help message showing usage options
nym-mixnode run --help prints a help message showing usage options for the run command
nym-mixnode run --layer 1 --host x.x.x.x will start the mixnode in layer 1 and bind to the specified host IP address. Coordinate with other people in your network to find out which layer needs coverage.

By default, the Nym Mixnode will start on port 1789. If desired, you can change the port using the --port option.

Install debian

sudo curl -s --compressed "http://apt.nymtech.net.s3-website.eu-central-1.amazonaws.com/nymtech.gpg" | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/nymtech.gpg > /dev/null
sudo echo "deb [signed-by=/etc/apt/trusted.gpg.d/nymtech.gpg] http://apt.nymtech.net.s3-website.eu-central-1.amazonaws.com/ squeeze main" > /etc/apt/sources.list.d/nymtech.list

sudo apt-get update
sudo apt-get install nym-mixnode

# See below for starting and managing the node

Systemd support

sudo systemctl enable nym-mixnode

# Run 
sudo systemctl start nym-mixnode

# Check status
sudo systemctl status nym-mixnode

# Logs
journalctl -f -u nym-mixnode

Build debian package

# cargo install cargo-deb

# Build package
cargo deb -p nym-mixnode

# Install

# This will init the mixnode to `/etc/nym` as `nym` user, and create a systemd service
sudo dpkg -i target/debian/<PACKAGE>