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

Side by Side Diff: docs/chromoting_build_instructions.md

Issue 1309473002: WIP: Migrate Wiki content over to src/docs (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: Created 5 years, 4 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
« no previous file with comments | « docs/chromoting_android_hacking.md ('k') | docs/clang.md » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(Empty)
1 # Introduction
2
3 Chromoting, also known as [Chrome Remote Desktop](https://support.google.com/chr ome/answer/1649523), allows one to remotely control a distant machine, all from within the Chromium browser. Its source code is located in the `remoting/` fold er in the Chromium codebase. For the sake of brevity, we'll assume that you alr eady have a pre-built copy of Chromium (or Chrome) installed on your development computer.
4
5 # Obtain API keys
6
7 Before you can compile the code, you must obtain an API key to allow it to acces s the federated Chromoting API.
8
9 1. Join the chromium-dev list, which can be found at https://groups.google.com /a/chromium.org/forum/#!forum/chromium-dev. (This step is required in order to gain access to the Chromoting API.)
10 1. Visit the Google APIs console at https://code.google.com/apis/console.
11 1. Use the `API Project` dropdown to create a new project with a name of you r choice.
12 1. On the `Services` page, click the button to activate the `Chrome Remote D esktop API`, and accept the license agreements that appear.
13 1. On the `API Access` page, select the option to create an `OAuth2 client I D`, and supply a product name of your choice.
14 1. Choose the `Web application` type, then click more options.
15 1. Replace the contents of `Authorized Redirect URLs` with: `https://chromot ing-oauth.talkgadget.google.com/talkgadget/oauth/chrome-remote-desktop/dev`
16 1. Clear the `Authorized JavaScript Origins` field and click the button to f inish creating the client ID.
17 1. Create a file `~/.gyp/include.gypi` according to the following format:
18
19 ```
20 {
21 'variables': {
22 'google_api_key': '<API key, listed under Simple API Access in the console>' ,
23 'google_default_client_id': '<Client ID, listed under Client ID for web appl ications>',
24 'google_default_client_secret': '<Client secret, listed under Client ID for web applications>',
25 },
26 }
27 ```
28
29 (NB: Replace the text in angled braces according the the instructions between th em.)
30
31 # Obtain Chromium code
32
33 If you've already checked out a copy of the browser's codebase, you can skip thi s section, although you'll still need to run `gclient runhooks` to ensure you bu ild using the API keys you just generated.
34
35 1. Install the build dependencies, which are listed at http://code.google.com/ p/chromium/wiki/LinuxBuildInstructionsPrerequisites.
36 1. Install the depot\_tools utilities, a process that is documented at http:// dev.chromium.org/developers/how-tos/install-depot-tools.
37 1. Download the Chromium source code by running: `$ fetch chromium --nosvn=Tru e`
38
39 # Build and install the Linux host service
40
41 If you want to remote into a (Debian-based) GNU/Linux host, follow these steps t o compile and install the host service on that system. As of the time of writin g, you must compile from source because no official binary package is being dist ributed.
42
43 1. Start in the `src/` directory that contains your checkout of the Chromium c ode.
44 1. Build the Chromoting host binaries: `$ ninja -C out/Release remoting_me2me_ host remoting_start_host remoting_native_messaging_host remoting_native_messagin g_manifests`
45 1. When the build finishes, move into the installer directory: `$ cd remoting/ host/installer/`
46 1. Generate a DEB package for your system's package manager: `$ linux/build-de b.sh`
47 1. Install the package on your system: `$ sudo dpkg -i *.deb`
48 1. The next time you use the Chromoting extension from your browser, it should detect the presence of the host service and offer you the option to `Enable rem ote connections`.
49 1. If the Web app doesn't properly detect the host process, you may need to create a symlink to help the plugin find the native messaging host: `$ sudo ln - s /etc/opt/chrome /etc/chromium`
50
51 (NB: If you compile the host service from source and expect to configure it usin g the browser extension, you must also compile the latter from source. Otherwis e, the package signing keys will not match and the Web app's OAuth2 token will n ot be valid within the host process.)
52
53 # Build and install the browser extension
54
55 The Web app is the Chromoting system's main user interface, and allows you to co nnect to existing hosts as well as set up the host process on the machine you're currently sitting at. Once built, it must be installed into your browser as an extension.
56
57 1. Start in the `src/` directory that contains your checkout of the Chromium c ode.
58 1. Build the browser extension: `$ GOOGLE_API_KEY=<API key> GOOGLE_CLIENT_ID_R EMOTING=<client ID> GOOGLE_CLIENT_SECRET_REMOTING=<client secret> ninja -C out/R elease remoting_webapp` (Be sure to replace the substitutions denoted by angled braces.)
59 1. Install the extension into your Chromium (or Chrome) browser:
60 1. Visit the settings page [chrome://extensions].
61 1. If it is unchecked, tick the `Developer mode` box.
62 1. Click `Load unpacked extension...`, then navigate to `out/Release/remotin g/remoting.webapp/` within your code checkout.
63 1. Confirm the installation, open a new tab, and click the new app's Chromot ing icon.
64 1. Complete the account authorization step, signing into your Google account if you weren't already.
65
66 # Build and install the Android client
67
68 If you want to use your Android device to connect to your Chromoting hosts, foll ow these steps to install the client app on it. Note that this is in the very e arly stages of development. At the time of writing, you must compile from sourc e because no official version is being distributed.
69
70 1. Follow all the instructions under the `Getting the code` and `Install prere quisites` sections of: http://code.google.com/p/chromium/wiki/AndroidBuildInstru ctions
71 1. Move into the `src/` directory that contains your checkout of the Chromium code.
72 1. Build the Android app: `$ ninja -C out/Release remoting_apk`
73 1. Connect your device and set up USB debugging:
74 1. Plug your device in via USB.
75 1. Open the Settings app and look for the `Developer options` choice.
76 1. If there is no such entry, open `About phone`, tap `Build number` 7 tim es, and look again.
77 1. Under `Developer options`, toggle the main switch to `ON` and enable `USB debugging`.
78 1. On your machine and still in the `src/` directory, run: `$ build/android/ad b_install_apk.py --apk=out/Release/apks/Chromoting.apk`
79 1. If your Android device prompts you to accept the host's key, do so.
80 1. The app should now be listed as Chromoting in your app drawer.
81
82 See the ChromotingAndroidHacking guide for instructions on viewing the Android a pp's log and attaching a debugger.
OLDNEW
« no previous file with comments | « docs/chromoting_android_hacking.md ('k') | docs/clang.md » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698