From c1dc8a775bc2cde8186155fd5a786f471b3c7763 Mon Sep 17 00:00:00 2001 From: Amna <amna.snene@savoirfairelinux.com> Date: Mon, 23 Sep 2024 14:23:57 -0400 Subject: [PATCH] tools: update readme Change-Id: Ifb27b9a147d83c144adc996fcae83b123e08fbbc --- tools/dsh/README.md | 3 +-- tools/dvpn/README.md | 6 +++--- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/tools/dsh/README.md b/tools/dsh/README.md index 3302f95..b2cbeb6 100644 --- a/tools/dsh/README.md +++ b/tools/dsh/README.md @@ -6,8 +6,7 @@ **dsh** allows you to: -- Execute commands on remote peers in a DHT network. -- Establish connections with peers and execute binaries on their side. +- Establish connections with peers and execute binaries on their side. Default binary: **bash** ### Options diff --git a/tools/dvpn/README.md b/tools/dvpn/README.md index 15aea4f..0d4b97b 100644 --- a/tools/dvpn/README.md +++ b/tools/dvpn/README.md @@ -10,7 +10,7 @@ - **Client-Server Model**: Supports both server and client modes for flexible deployment. - **TUN Interface**: Implements a TUN interface for network communication. - **VPN Security**: Ensures secure communication channels using cryptography and identity verification. -- **Configuration Flexibility** : Modify configuration settings and the setup script independently, avoiding the need to rebuild the entire project.. +- **Configuration Flexibility** : Modify configuration settings and the setup script independently, avoiding the need to rebuild the entire project. ## Configuration @@ -39,12 +39,12 @@ Before using **dvpn**, follow these steps to update your configuration: To run a dvpn server, you can use the following command: ```shell -sudo ./dvpn -l +sudo ./dvpn -d <YAML_FILE> -l ``` To connect to a dvpn server, you can use the following command: ```shell -sudo ./dvpn <server_identifier> +sudo ./dvpn -d <YAML_FILE> <server_identifier> ``` **Note**: **dvpn** requires sudo privileges to create and configure TUN interfaces on both the client and server sides. -- GitLab