blimp/docs/running.md - Issue 1696563002: Blimp: add support for SSL connections.

Side by Side Diff: blimp/docs/running.md

Issue 1696563002: Blimp: add support for SSL connections. (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master

Patch Set: rsleevi feedback #40 Created 4 years, 10 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View unified diff | Download patch

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-ip`,

25 flag. This takes values in the form of scheme:ip:port. The possible valid	25 `--engine-port`, and `--engine-transport` flags. The possible valid

26 schemes are 'tcp', 'quic', and 'ssl'. An example valid endpoint would be	26 values for `--engine-transport` are 'tcp', 'quic', and 'ssl'.

27 `--blimplet-endpoint=tcp:127.0.0.1:500`.	27 An example valid endpoint would be

	28 `--engine-ip=127.0.0.1 --engine-port=1234 --engine-transport=tcp`.

	29

	30 TLS-encrypted connections (QUIC, SSL) take an additional flag

	31 `--engine-cert-path` which specifies a path to a PEM-encoded certificate

	32 file (e.g. `--engine-cert-path=/path/to/file.pem`.)

28	33

29 Run the Blimp APK with:	34 Run the Blimp APK with:

30	35

31 ```bash	36 ```bash

32 adb_run_blimp_client	37 adb_run_blimp_client

33 ```	38 ```

34	39

35 ### Linux Client	40 ### Linux Client

36	41

37 TBD	42 TBD

38	43

39 ## Running the engine	44 ## Running the engine

40	45

41 ### In a container	46 ### In a container

42 For running the engine in a container, see [container](container.md).	47 For running the engine in a container, see [container](container.md).

43	48

44 ### On a workstation	49 ### On a workstation

45 If you are running the engine on your workstation and are connected to the	50 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	51 client device via USB, you'll need remote port forwarding to allow the Blimp

47 client to talk to your computer. Follow the instructions	52 client to talk to your computer. Follow the instructions

48 [here](https://developer.chrome.com/devtools/docs/remote-debugging) to get	53 [here](https://developer.chrome.com/devtools/docs/remote-debugging) to get

49 started. You'll probably want to remap 25467 to "localhost:25467".	54 started. You'll probably want to remap 25467 to "localhost:25467".

50	55

51 ### Required flags	56 ### Required flags

52 * `--blimp-client-token-path=$PATH`: Path to a file containing a nonempty	57 * `--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.	58 token string. If this is not present, the engine will fail to boot.

54	59

OLD	NEW

« blimp/client/session/assignment_source_unittest.cc ('K') | « blimp/client/session/test_selfsigned_cert.pem ('k') | blimp/engine/BUILD.gn » ('j') | no next file with comments »