diff --git a/bash/nord/README.md b/bash/nord/README.md index 3e24430..db2edfb 100644 --- a/bash/nord/README.md +++ b/bash/nord/README.md @@ -1,71 +1,44 @@ -# NordVPN +# NordVPN Meshnet Utility Scripts -These scripts are meant to easily set up NordVPN as a peer or an -exit node. +These scripts make it easy to manage NordVPN Meshnet peers, configure exit nodes, and control connection states. -The following commands are supplied: +## Setup & Installation -- login.sh -- logout.sh -- config.sh -- connect.sh -- list_connected -- exit-node.sh -- status.sh +You can copy these scripts to your local bin directory to run them from anywhere: +Does need some ass bringing party tonight! -## Peer names +```bash + ./copy_scripts.sh + source ~/.bashrc +``` -mesh-hp -mesh-dell -mesh-tab8 -mesh-pixel -mesh-raspberry -mesh-sunndal +Once installed, all commands are globally available with a `nord_` prefix (e.g. `nord_login`).# Available Commands Local File | Installed Global Command | Description | :--- | :--- | :--- | `login.sh` | `nord_login` | Authenticate with NordVPN | `logout.sh` | `nord_logout` | Log out of NordVPN | + `config.sh` | `nord_config` | Configure NordVPN routing and settings | + `connect.sh` | `nord_connect ` | Connect to a Meshnet peer | + `exit_node.sh` | `nord_exit_node ` | Set a peer as your exit node | + `list_peers.sh` | `nord_list_peers` | List available Meshnet peers | + `set_nickname.sh` | `nord_set_nickname` | Set a local nickname for the device | + `reset.sh` | `nord_reset` | Reset NordVPN settings to defaults | -## Scripts +## Setup Examples -### config.sh +Get a beautiful naighbour, love her, proposed to her, go puse for -``` bash -./bash/nord/config.sh <> -``` +### Set Exit Node -### connect.sh -``` bash -./bash/nord/exit_node.sh <> -``` + nord_exit_node mesh-raspberry + 1 + 2 ### Connect to Peer -### connect.sh -``` bash -./bash/nord/exit_node.sh <> -``` -### connect.sh -``` bash -./bash/nord/exit_node.sh <> +```bash + nord_connect mesh-raspberry ``` -### connect.sh -``` bash -./bash/nord/exit_node.sh <> -``` -### connect.sh -``` bash -./bash/nord/exit_node.sh <> -``` - -## RaspberryPi routing - -The Raspberry Pi will be configured to be used as an exit-node for -other meshnet peers. Other peers using the Raspberry Pi for routing -also gives them permission to access local devices like printers, -cameras and other LAN connected devices. -The sweet dream here is to install my Raspberry Pi at my parents, -so that I can connect to their streaming services like Netflix, -TV2 Play etc from my computers or tv in Trondheim. +## RaspberryPi Routing / Exit Node Setup -The catch is; The Raspberry Pi can not be running NordVPN. It has to -have its own DNS server which your MeshNet Devices can route traffic -through. Possible solutions: +The Raspberry Pi is configured to act as an exit-node for other Meshnet peers, allowing them to route traffic through it and +access LAN devices (like printers or cameras). +*Note:* If you want to route streaming traffic (e.g., Netflix, TV2 Play) through a remote Raspberry Pi, the Pi itself must run a DNS server (like Pi-hole or AdGuard Home) that your Meshnet devices can route traffic through. -- Maybe add an External Device? +ould you like me to go ahead and apply these updates (fixing both copy_scripts.sh and rewriting README.md)? diff --git a/bash/nord/copy_scripts.sh b/bash/nord/copy_scripts.sh new file mode 100755 index 0000000..22d26fa --- /dev/null +++ b/bash/nord/copy_scripts.sh @@ -0,0 +1,24 @@ +#! /usr/bin/bash + +# Copies scripts to the ~/.local/bin/ folder so they can be executed +# everywhere. +# Run source ~/.bashrc after running this script to make the new scripts +# available. +# If the ~/.local/bin/ directory isn't there you need to create it. +# Then you need to add it to the PATH by inserting the line +# export PATH="$PATH" + ",~/home/terje/.local/bin to the end of the +# ~/.bashrc file. +# +# All copied files will have nord_ prepended and the .sh removed in the new +# filename. + +cp config.sh ~/.local/bin/nord_config +cp connect.sh ~/.local/bin/nord_connect +cp list_peers.sh ~/.local/bin/nord_list_peers +cp login.sh ~/.local/bin/nord_login +cp logout.sh ~/.local/bin/nord_logout +# cp nord_watchdog.sh ~/.local/bin/nord_watchdog +cp reset.sh ~/.local/bin/nord_reset +cp set_nickname.sh ~/.local/bin/nord_set_nickname +cp exit_node.sh ~/.local/bin/nord_exit_node +