Skip to content

Commit 976b210

Browse files
committed
added setup section to README
1 parent af1db06 commit 976b210

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,33 @@ Distribute connections across multiple /64 subnets within a /48 IPv6 allocation:
9797

9898
This will randomly select from different /64 networks within your /48, providing both IP and subnet-level distribution.
9999

100+
## Routing Setup
101+
102+
Before Stargate can use IP addresses from your subnet, you need to configure your network to route that subnet to the host running Stargate.
103+
104+
**Step 1: Configure subnet routing**
105+
First, ensure your network infrastructure routes the entire subnet to your host machine. This is typically done at your router or network provider level.
106+
107+
**Step 2: Add local route**
108+
Once the subnet is routed to your host, tell your operating system that it can bind to any IP in that range by adding a local route:
109+
110+
```shell
111+
# Example: if 192.0.2.0/24 is routed to interface eth0
112+
ip -4 route add local 192.0.2.0/24 dev eth0
113+
```
114+
115+
**Important:** Don't assign individual IPs from the subnet directly to your network interface. This prevents the kernel from reserving addresses as broadcast addresses and keeps them available for Stargate.
116+
117+
**Step 3: Enable non-local binding (if needed)**
118+
Some systems require enabling non-local binding to allow applications to bind to IPs that aren't directly assigned to interfaces:
119+
120+
```shell
121+
# For IPv4
122+
sysctl net.ipv4.ip_nonlocal_bind=1
123+
# For IPv6
124+
sysctl net.ipv6.ip_nonlocal_bind=1
125+
```
126+
100127
## Download
101128

102129
### [Precompiled Binaries](https://github.com/lanrat/stargate/releases)

0 commit comments

Comments
 (0)