OLD | NEW |
1 # Running Blimp | 1 # Running Blimp |
2 | 2 |
3 See [build](build.md) for instructions on how to build Blimp. | 3 See [build](build.md) for instructions on how to build Blimp. |
4 | 4 |
5 ## Running the client | 5 ## Running the client |
6 | 6 |
7 There are both Android and Linux clients. The Android client is the shipping | 7 There are both Android and Linux clients. The Android client is the shipping |
8 client while the Linux client is used for development purposes. | 8 client while the Linux client is used for development purposes. |
9 | 9 |
10 ### Android Client | 10 ### Android Client |
11 | 11 |
12 Install the Blimp APK with the following: | 12 Install the Blimp APK with the following: |
13 | 13 |
14 ```bash | 14 ```bash |
15 ./build/android/adb_install_apk.py $(PRODUCT_DIR)/apks/Blimp.apk | 15 ./build/android/adb_install_apk.py $(PRODUCT_DIR)/apks/Blimp.apk |
16 ``` | 16 ``` |
17 | 17 |
18 Set up any command line flags with: | 18 Set up any command line flags with: |
19 | 19 |
20 ```bash | 20 ```bash |
21 ./build/android/adb_blimp_command_line --enable-webgl | 21 ./build/android/adb_blimp_command_line --enable-webgl |
22 ``` | 22 ``` |
23 | 23 |
24 To have the client connect to a custom engine use the `--blimplet-endpoint` | 24 To have the client connect to a custom engine use the `--engine-endpoint` |
25 flag. This takes values in the form of scheme:ip:port. The possible valid | 25 flag. This takes values in the form of scheme:ip:port. The possible valid |
26 schemes are 'tcp', 'quic', and 'ssl'. An example valid endpoint would be | 26 schemes are 'tcp', 'quic', and 'ssl'. An example valid endpoint would be |
27 `--blimplet-endpoint=tcp:127.0.0.1:500`. | 27 `--engine-endpoint=tcp://127.0.0.1:500`. |
| 28 |
| 29 TLS-encrypted connections (QUIC, SSL) take an additional flag |
| 30 `--engine-cert-path` which specifies a path to a PEM-encoded certificate |
| 31 file (e.g. `--engine-cert-path=/path/to/file.pem`.) |
28 | 32 |
29 Run the Blimp APK with: | 33 Run the Blimp APK with: |
30 | 34 |
31 ```bash | 35 ```bash |
32 adb_run_blimp_client | 36 adb_run_blimp_client |
33 ``` | 37 ``` |
34 | 38 |
35 ### Linux Client | 39 ### Linux Client |
36 | 40 |
37 TBD | 41 TBD |
38 | 42 |
39 ## Running the engine | 43 ## Running the engine |
40 | 44 |
41 ### In a container | 45 ### In a container |
42 For running the engine in a container, see [container](container.md). | 46 For running the engine in a container, see [container](container.md). |
43 | 47 |
44 ### On a workstation | 48 ### On a workstation |
45 If you are running the engine on your workstation and are connected to the | 49 If you are running the engine on your workstation and are connected to the |
46 client device via USB, you'll need remote port forwarding to allow the Blimp | 50 client device via USB, you'll need remote port forwarding to allow the Blimp |
47 client to talk to your computer. Follow the instructions | 51 client to talk to your computer. Follow the instructions |
48 [here](https://developer.chrome.com/devtools/docs/remote-debugging) to get | 52 [here](https://developer.chrome.com/devtools/docs/remote-debugging) to get |
49 started. You'll probably want to remap 25467 to "localhost:25467". | 53 started. You'll probably want to remap 25467 to "localhost:25467". |
50 | 54 |
51 ### Required flags | 55 ### Required flags |
52 * `--blimp-client-token-path=$PATH`: Path to a file containing a nonempty | 56 * `--blimp-client-token-path=$PATH`: Path to a file containing a nonempty |
53 token string. If this is not present, the engine will fail to boot. | 57 token string. If this is not present, the engine will fail to boot. |
54 | 58 |
OLD | NEW |