chore: add GUI quickstart docs and update README for 0.1.0-beta.0
This commit is contained in:
61
docs/gui-quickstart-linux.md
Normal file
61
docs/gui-quickstart-linux.md
Normal file
@@ -0,0 +1,61 @@
|
||||
# Konduit GUI — Linux Quickstart
|
||||
|
||||
## 1. Download
|
||||
|
||||
Download the `Konduit-*-x86_64.AppImage` from the [Releases](../../releases) page.
|
||||
|
||||
## 2. Make it executable
|
||||
|
||||
```bash
|
||||
chmod +x Konduit-*-x86_64.AppImage
|
||||
```
|
||||
|
||||
## 3. Run
|
||||
|
||||
Double-click the AppImage in your file manager, or launch it from the terminal:
|
||||
|
||||
```bash
|
||||
./Konduit-*-x86_64.AppImage
|
||||
```
|
||||
|
||||
No installation required. The AppImage is self-contained.
|
||||
|
||||
## 4. Load your config
|
||||
|
||||
Your server administrator will provide a `client.toml` config file. On first launch, tap **Open config** and select the file.
|
||||
|
||||
## 5. Privileges
|
||||
|
||||
Konduit creates a TUN network device, which requires elevated network capability. The AppImage requests this automatically via a `pkexec` prompt on first run. If you see a password prompt, enter your user password to grant the capability.
|
||||
|
||||
If `pkexec` is not available on your system (some minimal desktop environments), grant the capability manually once:
|
||||
|
||||
```bash
|
||||
sudo setcap cap_net_admin=+ep ~/.local/share/konduit/konduit-helper
|
||||
```
|
||||
|
||||
## 6. Autostart on login (optional)
|
||||
|
||||
To start Konduit automatically when you log in, enable autostart in the app: **Settings → Start on login**.
|
||||
|
||||
Alternatively, copy the provided desktop entry to your autostart directory:
|
||||
|
||||
```bash
|
||||
cp ~/.local/share/applications/konduit.desktop ~/.config/autostart/
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**AppImage won't launch** — your system may be missing FUSE. Install it:
|
||||
|
||||
```bash
|
||||
# Debian / Ubuntu
|
||||
sudo apt install libfuse2
|
||||
|
||||
# Fedora / RHEL
|
||||
sudo dnf install fuse
|
||||
```
|
||||
|
||||
**"Failed to create TUN device"** — the capability was not granted. Run the `setcap` command from step 5 and relaunch.
|
||||
|
||||
**Config not found on relaunch** — the app remembers the last config path. If you move the file, use **Open config** again to reselect it.
|
||||
62
docs/gui-quickstart-windows.md
Normal file
62
docs/gui-quickstart-windows.md
Normal file
@@ -0,0 +1,62 @@
|
||||
# Konduit GUI — Windows Quickstart
|
||||
|
||||
## Requirements
|
||||
|
||||
- Windows 10 or later (64-bit)
|
||||
- Administrator account (required for VPN driver installation)
|
||||
|
||||
## 1. Download
|
||||
|
||||
Download `konduit-gui-*-windows-x86_64.zip` from the [Releases](../../releases) page.
|
||||
|
||||
## 2. Extract
|
||||
|
||||
Right-click the zip file and choose **Extract All**. Extract to a folder of your choice, for example `C:\Konduit`.
|
||||
|
||||
Keep all files together — `Konduit.exe` and `wintun.dll` must be in the same folder.
|
||||
|
||||
## 3. Run
|
||||
|
||||
Double-click `Konduit.exe`.
|
||||
|
||||
Windows will show a **UAC prompt** asking for administrator permission. This is required because Konduit uses the [WinTun](https://www.wintun.net/) driver to create a virtual network adapter. Click **Yes** to continue.
|
||||
|
||||
> If you dismiss the UAC prompt, Konduit will not be able to establish a VPN connection.
|
||||
|
||||
## 4. Load your config
|
||||
|
||||
Your server administrator will provide a `client.toml` config file. On first launch, tap **Open config** and select the file.
|
||||
|
||||
## 5. Connect
|
||||
|
||||
Press **Connect**. A system tray icon will appear while the VPN is active. Right-click the tray icon to disconnect.
|
||||
|
||||
## 6. Windows Defender / antivirus warning
|
||||
|
||||
Some antivirus tools flag `wintun.dll` or new unsigned executables. If Windows Defender blocks the launch:
|
||||
|
||||
1. Open **Windows Security → Virus & threat protection**
|
||||
2. Click **Protection history**
|
||||
3. Find the Konduit entry and choose **Allow**
|
||||
|
||||
Alternatively, add the Konduit folder to your antivirus exclusion list.
|
||||
|
||||
## 7. Autostart on login (optional)
|
||||
|
||||
To start Konduit automatically when Windows starts, enable it in the app: **Settings → Start on login**.
|
||||
|
||||
Alternatively, create a shortcut to `Konduit.exe` and place it in your Startup folder:
|
||||
|
||||
```
|
||||
Win + R → shell:startup → paste shortcut here
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**UAC prompt does not appear / app closes immediately** — make sure you are running as a user with administrator privileges. Standard (non-admin) accounts cannot install the WinTun driver.
|
||||
|
||||
**"wintun.dll not found"** — `Konduit.exe` and `wintun.dll` must be in the same folder. Do not move them separately.
|
||||
|
||||
**Connection fails immediately** — check that your `client.toml` points to the correct server address and port. Contact your server administrator if you are unsure.
|
||||
|
||||
**Tray icon disappears unexpectedly** — the app may have crashed. Check Windows Event Viewer or relaunch `Konduit.exe`.
|
||||
Reference in New Issue
Block a user