rust-client-0.2.1

Rust client only. See previous release for main Golang client.

Follow-up patch release to #64.

Build yourself via:

cd rust-client
cargo build --release # Find binary in ./target/release/rust-client

Or download pre-build binary below.

Then run via:

export API_KEY=<YOUR_API_KEY>
rust-client

Logging is controlled via the RUST_LOG environment variable. To view relevant logs set RUST_LOG=info.

rust-client-0.2.0

Rust client only. See previous release for main Golang client.

Build yourself via:

cd rust-client
cargo build --release # Find binary in ./target/release/rust-client

Or download pre-build binary below.

Then run via:

export API_KEY=<YOUR_API_KEY>
rust-client

Logging is controlled via the RUST_LOG environment variable. To view relevant logs set RUST_LOG=info.

Hole Punch December Release

We will be running a NAT Hole Punching month during December to measure the success rate of libp2p’s new feature. Download the clients here (direct download links):

• ⭐️ MacOS: M1/M2 Intel (if prompted, please allow incoming connections) 🚀
• ⭐️ Linux: amd64 386 | tar -xf punchr-gui-linux-amd64.tar.xz && make user-install 🚀

You do not need a running IPFS node. Just start the app and follow the instructions

Optionally, register here and request a personal API-Key. This allows us to reach out to and inform about news as well as incorporate information you give during registration for the data analysis. We also plan to provide a custom analysis of the data that you contributed. Please check further information here.

Disclaimer: none of the collected data will be linked to email addresses, or other information that can identify any of the participants personally. This is a purely experimental study with no marketing purposes.

---

For the More Tech-Savvy People

There are also CLI versions of the client available for all major OS's and architectures. An example systemd service could look like this:

# E.g. file at: /etc/systemd/system/punchr-client.service
[Unit]
Description=Punchr Client
After=network.target

[Service]
User=ubuntu # your user
WorkingDirectory=/home/ubuntu 
ExecStart=/home/ubuntu/punchr_cli_linux_amd64
Restart=always

[Install]
WantedBy=multiuser.target

There's also a docker compose file and/or an Ansible Galaxy role that you could use.

Release v0.8.0

System Tray Application

MacOS

Download the punchr-gui-darwin-amd64.dmg or punchr-gui-darwin-arm64.dmg.

Linux

Depending on your platform download punchr-gui-linux-{amd64,386}.tar.xz. In the case of amd64 run the following command to install the application:

tar -xf punchr-gui-linux-amd64.tar.xz && make user-install

CLI Application

The system tray app is just a wrapper around the CLI application. You can find all the download links below and install it manually. Consider configuring a systemd service to have it running continuously and to allow autostarting. Like this:

# E.g. file at: /etc/systemd/system/punchr-client.service
[Unit]
Description=Punchr Client
After=network.target

[Service]
User=ubuntu # your user
WorkingDirectory=/home/ubuntu 
ExecStart=/home/ubuntu/punchr_cli_linux_amd64
Restart=always

[Install]
WantedBy=multiuser.target

Changelog

• Now the client reports NAT port mappings - 0.7.0
• Drop API Key requirement - 0.8.0

Release 0.7.0

System Tray Application

MacOS

Download the punchr-gui-darwin-amd64.dmg or punchr-gui-darwin-arm64.dmg.

Linux

Depending on your platform download punchr-gui-linux-{amd64,386}.tar.xz. In the case of amd64 run the following command to install the application:

tar -xf punchr-gui-linux-amd64.tar.xz && make user-install

CLI Application

The system tray app is just a wrapper around the CLI application. You can find all the download links below and install it manually. Consider configuring a systemd service to have it running continuously and to allow autostarting. Like this:

# E.g. file at: /etc/systemd/system/punchr-client.service
[Unit]
Description=Punchr Client
After=network.target

[Service]
User=ubuntu # your user
WorkingDirectory=/home/ubuntu 
ExecStart=/home/ubuntu/punchr_cli_linux_amd64 --api-key <API_KEY> 
Restart=always

[Install]
WantedBy=multiuser.target

Changelog

• Now the client reports NAT port mappings

Release v0.6.0

System Tray Application

MacOS

Download the punchr-gui-darwin-amd64.dmg or punchr-gui-darwin-arm64.dmg.

Linux

Depending on your platform download punchr-gui-linux-{amd64,386}.tar.xz. In the case of amd64 run the following command to install the application:

tar -xf punchr-gui-linux-amd64.tar.xz && make user-install

CLI Application

The system tray app is just a wrapper around the CLI application. You can find all the download links below and install it manually. Consider configuring a systemd service to have it running continuously and to allow autostarting. Like this:

# E.g. file at: /etc/systemd/system/punchr-client.service
[Unit]
Description=Punchr Client
After=network.target

[Service]
User=ubuntu # your user
WorkingDirectory=/home/ubuntu 
ExecStart=/home/ubuntu/punchr_cli_linux_amd64 --api-key <API_KEY> 
Restart=always

[Install]
WantedBy=multiuser.target

Release v0.6.0-rc1

System Tray Application Release

This release contains the Punchr client packaged as system tray application.

So far, only the macos-arm64 version is tested.

Release v0.5.0

Changelog

• ca3dd64 chore: hard code version
• 3c15e45 Update dataSources.xml
• 4184b7c Remove error output when connection error
• 06ff7f9 fix: error return value
• 673603e chore: remove log message
• 5a20a39 feat: embed icons into executable
• d30c107 Add autostart functionality
• 453123a Add GUI punchr
• e1e0de1 update: README
• 2f72ab5 Track router login page
• 14a74d7 update: .gitignore
• 1af8b2c fix: only associate advertised maddrs
• 8357ce7 fix: inifite resource manager
• 2c7a54f fix: only track relay-only incoming peers
• cc0f996 chore: add non DNS bootstrap addresses
• 748f9f4 chore: fix deprecated imports
• b9ae814 schema: add unique constraint to clients table
• 4f82f49 feat: embed migrations
• 602cf0d update: dependencies
• ea08a36 Add dark background architecture diagram
• 0ced289 Improve analysis notebook
• 6802b7e feat: add rudimentary analysis scripts
• dbad93c Add rust-client resource requirements to readme
• 33c1246 Fix saving hole punch attempts
• 3a36c40 Increase errCount in for loop
• e4882da Wording tweak
• f099c86 Wording tweak
• e68b11c Bump headings up a level and refresh ToC
• 477c1a9 Update README with Nix info
• 147f663 Add Nix setup
• 425ada5 rust-client: simplify loop condition
• 593eb42 rust-client: use random seed if none was provided
• ceed2e2 rust-client: remove unused dependencies
• e7fc2b6 rust-client: fix CLI, add README section
• e38d695 rust-client: add HolePunchAttempt::multi_addresses
• 52b2036 rust-client: verify server against CA certificate
• 64f8ecd rust-client: patch libp2pv0.46.1, remove relay-v1
• 41c6483 rust-client: filter quic addresses in dial
• c01349f rust-client: rm temp macro expansion
• ca9a86d rust-client: add tls support with dummy verifier

Release v0.4.0

Main Changes

• The client and server track the multi addresses that were used to hole punch

Changelog

• c476515 Change error message
• e5796b2 Track Hole Punch Multi Addresses
• de7fa8b Merge pull request #23 from elenaf9/rust-client/patch-1
• 3b6dae2 Merge branch 'main' of github.com:dennis-tra/punchr into rust-client/patch-1
• fa50278 rust-client: make rounds configurable
• 50253b0 rust-client: read API_KEY from env variable
• f286ddf Remove .goreleaser archive replacement
• 1ea1d34 .github/workflows: enable ci again
• 9352c9c rust-client: add api-key & listen_multi_addresses

Release v0.2.0

Add go-client release workflow