Skip to content
This repository was archived by the owner on Oct 23, 2024. It is now read-only.

Commit 66e1e01

Browse files
authored
Add a step in QUIC guide to enable WebTransport at server side. (#956)
WebTransport is disabled by default.
1 parent ec0b0d6 commit 66e1e01

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

doc/design/quic-programming-guide.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -126,11 +126,12 @@ Please follow [Conference Server build instructions](https://github.com/open-web
126126
Steps to run Conference Server with pre-built binary:
127127

128128
1. Go to the untarred conference server dir, and run `./bin/init-all.sh --deps`; this would try to install mongodb and rabbitmq-server. Don't set any password for rabbitmq or mongodb.
129-
2. Still in the same dir, run `bin/init-all.sh`.
130-
3. Update quic_agent/agent.toml, set `hostname` to the hostname quic agent is running on.
131-
4. run `bin/start-all.sh`.
132-
5. Open [https://localhost:3004/quic.html](https://localhost:3004/quic.html) on the same host with Chrome browser to visit the web sample page. Due to the test certificate, you may need confirm this unsafe access.
133-
6. Press 'Start Sending' button to start transferring data to conference server. Press 'Stop Sending' button on the web page to stop sending.. If there's no error in the console, that implies server is correctly setup.
129+
1. Still in the same dir, run `bin/init-all.sh`.
130+
1. Update quic_agent/agent.toml, set `hostname` to the hostname quic agent is running on.
131+
1. Update management_api/management_api.toml, set `enableWebTransport` to `true`.
132+
1. run `bin/start-all.sh`.
133+
1. Open [https://localhost:3004/quic.html](https://localhost:3004/quic.html) on the same host with Chrome browser to visit the web sample page. Due to the test certificate, you may need confirm this unsafe access.
134+
1. Press 'Start Sending' button to start transferring data to conference server. Press 'Stop Sending' button on the web page to stop sending.. If there's no error in the console, that implies server is correctly setup.
134135

135136
# OWT QUIC Windows Sample
136137

@@ -152,7 +153,7 @@ OWT Conference Server is using a self-signed certificate during development phas
152153
- Make sure generate-certs.sh is exectuable. If not, run `chmod +x generate-certs.sh`;
153154
- Remove the `out` dir in case it exists.
154155
- Under the downloaded tool dir, run `./generate-certs.sh`. It is expected to generate a series of files under out dir.
155-
- Under the downloaded tool dir, run `openssl pkcs12 -inkey out/leaf_certs.key -in out/leaf_cert.pem -export -out out/certificate.pfx`. This will prompt for password for the pfx. Make sure you always use `abc123` as the password.
156+
- Under the downloaded tool dir, run `openssl pkcs12 -inkey out/leaf_cert.key -in out/leaf_cert.pem -export -out out/certificate.pfx`. This will prompt for password for the pfx. Make sure you always use `abc123` as the password.
156157
- Under the downloaded tool dir, run `openssl x509 -noout -fingerprint -sha256 -inform pem -in out/leaf_cert.pem`. You will get the fingerprint string in the form of "XX:XX:XX....XX:XX".
157158

158159
## Use the Certificate

0 commit comments

Comments
 (0)