luxferre/gs-warp
1
0
Fork 0
Code Actions Activity

updated everything to not require gs-secret manually

Browse Source
This commit is contained in:
Luxferre
2026-07-26 09:50:04 +03:00
parent f7e67801a5
commit 7b0d1582d7
5 changed files with 23 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+14 -11
View File
@@ -31,32 +31,35 @@ Client-side dependencies:
Assumes having Docker and Make. From the repo root:
1. Enter and save the GSocket secret: `make server-secret`
2. Build (if necessary) and start the server: `make server`
3. Export the `client.ovpn` file to the current directory: `make ovpn`
4. Stop the server (without removing the data): `make stop-server`
5. Stop the server and remove all data: `make clean`
1. Build (if necessary) and start the server: `make server`
2. Export the `client.ovpn` file to the current directory: `make ovpn`
3. Stop the server (without removing the data): `make stop-server`
4. Stop the server and remove all data: `make clean`
Note: the `client.ovpn` file is the sole access key to the entire tunnel. Treat is as confidential data.
### On the client ("simple" approach, Make-based)
1. Get the `client.ovpn` file from the server and put it into the `client` directory.
2. Run `make start`, enter your GSocket server secret and then your sudo password (if necessary).
2. Run `make start` and then enter your sudo password (if necessary).
3. To stop the client, run `make stop.`
### On the client (manual approach, POSIX)
1. Get the `client.ovpn` file from the server.
2. Run these commands directly: `gs-netcat -D -s your_gsocket_secret -p 1194 && sudo openvpn --daemon gs-warp --config client.ovpn`
3. To stop, first stop the OpenVPN process and then gs-netcat.
2. Get the GS secret as the MD5 hash of the `client.ovpn` file: `export GS_SECRET=$(md5sum client.ovpn | cut -d ' ' -f 1)`
3. Run these commands directly: `gs-netcat -D -s $GS_SECRET -p 1194 && sudo openvpn --daemon gs-warp --config client.ovpn`
4. To stop, first stop the OpenVPN process and then gs-netcat.
### On the client (manual approach, non-POSIX)
This is suitable for non-POSIX environments. You'll need any OpenVPN client and `gs-netcat` binary for your platform.
1. Get the `client.ovpn` file from the server and put it into your OpenVPN client's profile. Do not start the client yet.
2. In a separate terminal window, run `gs-netcat -D -s your_gsocket_secret -p 1194`.
3. Start the OpenVPN connection in the client.
4. To stop, first stop the OpenVPN connection and then terminate the gs-netcat process.
2. Get the GS secret as the MD5 hash of the `client.ovpn` file using whatever means available.
3. In a separate terminal window, run `gs-netcat -D -s $GS_SECRET -p 1194`.
4. Start the OpenVPN connection in the client.
5. To stop, first stop the OpenVPN connection and then terminate the gs-netcat process.
More client options coming soon!