Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(4205)

Unified Diff: blimp/docs/running.md

Issue 1718103003: Update blimp documentation and add examples (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: 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 side-by-side diff with in-line comments
Download patch
« no previous file with comments | « blimp/docs/build.md ('k') | no next file » | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: blimp/docs/running.md
diff --git a/blimp/docs/running.md b/blimp/docs/running.md
index f4a1d96e117e1eeea50d0a9736def7f9b9eea5a4..a32b4366a27b2f2dd16c01f05dc01269e5e7d934 100644
--- a/blimp/docs/running.md
+++ b/blimp/docs/running.md
@@ -18,23 +18,45 @@ Install the Blimp APK with the following:
Set up any command line flags with:
```bash
-./build/android/adb_blimp_command_line --enable-webgl
+./build/android/adb_blimp_command_line --your-flag-here
```
To have the client connect to a custom engine use the `--blimplet-endpoint`
flag. This takes values in the form of scheme:ip:port. The possible valid
schemes are 'tcp', 'quic', and 'ssl'. An example valid endpoint would be
-`--blimplet-endpoint=tcp:127.0.0.1:500`.
+`--blimplet-endpoint=tcp:127.0.0.1:25467`.
+
+To see your current command line, run `adb_blimp_command_line` without any
+arguments.
Run the Blimp APK with:
```bash
-adb_run_blimp_client
+./build/android/adb_run_blimp_client
```
### Linux Client
-TBD
+The blimp client is built as part of the `blimp` target. To run it with local
+logging enabled, execute:
+
+```bash
+./out-linux/Debug/blimp_shell \
+ --user-data-dir=/tmp/blimpclient \
+ --enable-logging=stderr \
+ --vmodule="*=1"
+```
+
+### Instructing client to connect to specific host
+If you run the engine on your local host and you want the client to connect to
+it instead of using the assigner, you need to instruct the client to use the
+correct host and port to connect to by giving it the correct command line flag.
+
+Typically this flag would be:
+
+```bash
+--blimplet-endpoint=tcp:127.0.0.1:25467
+```
## Running the engine
@@ -42,13 +64,59 @@ TBD
For running the engine in a container, see [container](container.md).
### On a workstation
+To run the engine on a workstation and make your Android client connect to it,
+you need to forward a port from the Android device to the host, and also
+instruct the client to connect using that port on its localhost address.
+
+#### Port forwarding
If you are running the engine on your workstation and are connected to the
client device via USB, you'll need remote port forwarding to allow the Blimp
-client to talk to your computer. Follow the instructions
-[here](https://developer.chrome.com/devtools/docs/remote-debugging) to get
-started. You'll probably want to remap 25467 to "localhost:25467".
+client to talk to your computer.
+
+##### Option A
+Follow the
+[remote debugging instructions](https://developer.chrome.com/devtools/docs/remote-debugging)
+to get started. You'll probably want to remap 25467 to "localhost:25467".
+*Note* This requires the separate `Chrome` application to be running on the
+device. Otherwise you will not see the green light for the port forwarding.
-### Required flags
-* `--blimp-client-token-path=$PATH`: Path to a file containing a nonempty
-token string. If this is not present, the engine will fail to boot.
+##### Option B
+If you are having issues with using the built-in Chrome port forwarding, you can
+also start a new shell and keep the following command running:
+```bash
+./build/android/adb_reverse_forwarder.py --debug -v 25467 25467
+```
+
+### Required engine binary flags
+* `--blimp-client-token-path=$PATH`: Path to a file containing a nonempty
+ token string. If this is not present, the engine will fail to boot.
+* `--use-remote-compositing`: Ensures that the renderer uses the remote
+ compositor.
+* `--disable-cached-picture-raster`: Ensures that rasterized content is not
+ destroyed before serialization.
+
+#### Typical invocation
+When the client connects to a manually specified engine instead of using the
+assigner, it will use a dummy token. The engine needs to know what this token
+is, so it must be provided using the `--blimp-client-token-path` flag. The token
+is available in the constant `kDummyClientToken` in
+`blimp/client/session/assignment_source.h`. You can easily store that to a file
+by running the following command once:
+
+```bash
+awk '{if ( match($0, /^\s*const char kDummyClientToken.*/) ) { print substr($5, 2, length($5)-3);} }' \
+ ./blimp/client/session/assignment_source.h > /tmp/blimpengine-token
+```
+
+Then start the engine using these flags:
+
+```bash
+out-linux/Debug/blimp_engine_app \
+ --use-remote-compositing \
+ --disable-cached-picture-raster \
+ --blimp-client-token-path=/tmp/blimpengine-token \
+ --user-data-dir=/tmp/blimpengine \
+ --enable-logging=stderr \
+ --vmodule="blimp*=1"
+```
« no previous file with comments | « blimp/docs/build.md ('k') | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698