mirror of https://github.com/ospab/ostp.git
Page:
Share Links
3
Share Links
ospab edited this page 2026-06-19 15:02:57 +03:00
Table of Contents
Share Links
OSTP supports sharing configuration profiles via standard URI links. These links can be easily imported into the CLI or GUI clients.
Format
ostp://ACCESS_KEY@HOST:PORT/?query_parameters#LABEL
Base Components
| Component | Required | Description |
|---|---|---|
ACCESS_KEY |
Yes | URL-encoded access key |
HOST |
Yes | Server hostname or IP |
PORT |
Yes | Server port |
LABEL |
No | URL-encoded server label |
Query Parameters
You can customize the imported configuration using URL query parameters (?key=value&...).
| Parameter | Type | Default | Description |
|---|---|---|---|
type |
string | udp |
Transport mode. Values: udp, uot, dns |
tun |
bool | false |
Enable TUN interface routing (true / false) |
domain |
string | null |
Required if type=dns. The tunneling domain |
pubkey |
string | null |
Required if type=dns. The dnstt public key |
Examples
1. Basic UDP connection
ostp://abc123456789@example.com:50000#My%20Server
2. UDP over TCP (UoT) with TUN enabled
ostp://abc123456789@example.com:50000/?type=uot&tun=true#Gaming%20VPN
3. DNS Tunneling
ostp://abc123456789@1.1.1.1:53/?type=dns&domain=t.yourdomain.com&pubkey=f1...4a#DNS%20Bypass
(Note: For DNS, the HOST is usually a public resolver like 1.1.1.1 rather than your actual server IP).
Client Import
The OSTP GUI and CLI support importing share links:
- GUI: Paste into the import field on the Settings screen.
- CLI:
ostp --import "ostp://key@host:port/..." - Instant Launch:
ostp --url "ostp://key@host:port/..."(Creates a temporary config and runs it).