You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.en.md
+20-11Lines changed: 20 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -179,31 +179,40 @@ ii version
179
179
180
180
You do not need to understand relay hosting to send ordinary files. This section is only for running your own relay service or using a fixed relay entrypoint in a company network.
181
181
182
-
Start a relay:
182
+
Start a self-signed HTTPS relay:
183
183
184
184
```powershell
185
-
ii relay
185
+
ii relay --public https://SERVER_PUBLIC_IP:8443
186
186
```
187
187
188
-
The default is an HTTP-only relay:
188
+
You can use a domain too:
189
189
190
-
- It listens on `0.0.0.0:3340`; only allow `3340/tcp`.
191
-
- Use the server's public IP directly. No domain, DNS, or certificate is required.
192
-
- HTTPS, QUIC, and metrics do not start.
190
+
```powershell
191
+
ii relay --public https://relay.example.com
192
+
```
193
193
194
-
Clients use it with:
194
+
`--public` is the public HTTPS address used by clients and must be `https://host[:port]`. On first start, `ii` generates and persists a self-signed certificate and key in the relay state directory. It listens on the public URL port, or on `443` when the URL has no port. Use `-H` for a different local backend port behind NAT or a reverse proxy:
195
195
196
196
```powershell
197
-
ii send .\video.mp4 --relay http://SERVER_PUBLIC_IP:3340
197
+
ii relay --public https://relay.example.com:8443 -H 9443
198
198
```
199
199
200
-
For HTTPS and a domain, explicitly provide an existing certificate and private key:
200
+
Send through the relay:
201
+
202
+
```powershell
203
+
ii send .\video.mp4 --relay https://SERVER_PUBLIC_IP:8443 -k
204
+
```
205
+
206
+
`-k` accepts the self-signed certificate and puts that policy in the ticket; the receiver needs no certificate installation or relay configuration. A first connection can still be replaced by a man-in-the-middle.
207
+
208
+
With a domain and PEM certificate files, use manual TLS:
201
209
202
210
```powershell
203
211
ii relay --tls relay.example.com -H 8443 --cert D:\certs\fullchain.pem --key D:\certs\privkey.pem
212
+
ii send .\video.mp4 --relay https://relay.example.com:8443
204
213
```
205
214
206
-
Clients use `https://relay.example.com:8443`. `ii` does not issue or renew certificates; the operator owns those files. See [ii.md](ii.md) for the full configuration. Plain HTTP is not suitable for a long-lived public deployment.
215
+
Manual TLS does not use `-k`; clients use normal system TLS verification. Both `--relay` modes force HTTPS relay-only transport and skip UDP and direct paths. See [ii.md](ii.md) for ports, state paths, and the security boundary.
207
216
208
217
## Full Manual
209
218
@@ -215,7 +224,7 @@ Release changes are documented in [CHANGELOG.en.md](CHANGELOG.en.md). The defaul
215
224
216
225
## Version
217
226
218
-
The current version is managed by Git tags. This repository currently uses `v0.1.10`.
227
+
The current version is managed by Git tags. This repository currently uses `v0.1.11`.
0 commit comments