Skip to content

Commit df33414

Browse files
Update README.md
1 parent 3756bfb commit df33414

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

vpn-client/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ flowchart TD
1717
The above diagram (<sub><sup>See [mermaid.live](https://mermaid.live/)</sub></sup>) is also a small lie: at time of writing only _one_ client is created but peer creation is [very]([url](https://www.youtube.com/watch?v=88GyLoZbDNw)) [simple](https://github.com/KarmaComputing/server-bootstrap/blob/43053816a72d801fbf525c59c0a2eccc149a05d0/vpn-client/playbooks/deploy-vpn-client.yml#L143).
1818

1919

20-
## Configure
20+
## Deploying manually
21+
22+
### Configure
2123
```
2224
python3 -m venv venv
2325
. venv/bin/activate
2426
pip install -r requirements.txt
2527
```
2628

27-
## Running manually
28-
2929
> The VPN client & VPN Server deployment is completely [pipeline driven](https://github.com/KarmaComputing/server-bootstrap/blob/43053816a72d801fbf525c59c0a2eccc149a05d0/.github/workflows/deploy-vpn.yml#L64). But you can also 'break glass' and run the process locally:
3030
3131
1. Update `inventory.ini`
@@ -46,7 +46,8 @@ Where `BECOME` is local admin password (to place client wiregard config file), a
4646
curl -v -k -L --compressed https://10.100.49.2
4747
```
4848

49-
## How do I connect as a client? (cli and gui methods both supported- including mobile 📱)
49+
## How do I connect as a client?
50+
> Both cli and gui methods are supported- including mobile 📱
5051
5152
- Linux / Ubuntu / Debian: Use `wg-quick` (easiest)
5253
- (ubuntu desktop) use the [network-manager-gui](https://www.xmodulo.com/wireguard-vpn-network-manager-gui.html#:~:text=NetworkManager%27s%20Connection%20Editor-,GUI,-Next%2C%20run%20nm

0 commit comments

Comments
 (0)