Skip to content

Commit a500b6b

Browse files
committed
Add --host advice to docc preview instructions
Because `localhost` only allows connections on the loopback interface, anybody who’s trying to run `docc preview` on a remote server and connect to it with their local browser will need to use `--host 0.0.0.0` or similar.
1 parent e2fadb1 commit a500b6b

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

CONTRIBUTING.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,10 @@ Monitoring ~/Developer/swift-docc/Sources/SwiftDocC/SwiftDocC.docc for changes..
288288
```
289289
290290
And if you navigate to <http://localhost:8080/documentation/swiftdocc> you'll see
291-
the rendered documentation for `SwiftDocC`.
291+
the rendered documentation for `SwiftDocC`. If your browser isn't running on
292+
the same computer as Swift-DocC, you may need to provide the server's public
293+
host name or IP address (or just `0.0.0.0`) with the `--host` option to allow
294+
the browser to connect.
292295

293296
### Using Docker to Test Swift-DocC for Linux
294297

0 commit comments

Comments
 (0)