Skip to content

Commit 3cd08c3

Browse files
jarildarkwing
authored andcommitted
Added Firefox Nightly CLI launch instructions (firefox-devtools#8038)
1 parent e5ff182 commit 3cd08c3

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

README.md

+3
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ yarn start
3535
# Go to http://localhost:8000
3636
```
3737

38+
If you are having problems with setting breakpoints in the debugger, launch [Firefox Nightly][firefox-nightly] instead of clicking on `Launch Firefox`.
39+
3840
#### Next Steps
3941

4042
- [`/claim`][cl] an [available] issue. If you get stuck, we'd be happy to [help].
@@ -129,3 +131,4 @@ Say hello in [Slack][slack] or in the [#devtools-html][irc-devtools-html] channe
129131
[linting]: ./docs/local-development.md#linting
130132
[google-docs]: https://docs.google.com/document/d/146p7Y8Ues_AKjj4ReWCk6InOPWe3C3Koy6EQ1qnYKNM/edit
131133
[cl]: ./docs/issues.md#claiming-issues
134+
[firefox-nightly]: ./docs/getting-setup.md#starting-firefox-nightly

docs/getting-setup.md

+27
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,33 @@ If you are not seeing any tabs when you connect, it is possible that switching f
119119
> NOTE: if you are curious about how the debugger server starts listening on a port
120120
> this function is useful: [devtools-startup.js](https://searchfox.org/mozilla-central/source/devtools/startup/devtools-startup.js#789-854)
121121
122+
### Starting Firefox Nightly
123+
124+
You can open and debug a Firefox Nightly tab with the command-line interface (CLI).
125+
126+
>Steps 4-6 is for the Firefox Nightly configuration and **only need to be done once**:
127+
128+
1) Update/rebase your local Debugger repository, and download [Firefox Nightly](https://www.mozilla.org/en-CA/firefox/channel/desktop/)
129+
2) Run `yarn start` and open `localhost:8000` on your browser
130+
3) In a separate terminal tab, open Nightly with:
131+
```shell
132+
# For Mac Users
133+
/Applications/Firefox\ Nightly.app/Contents/MacOS/firefox --start-debugger-server 6080
134+
135+
# For Windows Users
136+
C:\Program Files\Firefox Nightly\firefox.exe -start-debugger-server 6080
137+
```
138+
4) Go to `about:config` in the URL bar
139+
5) Toggle the following preferences to their corresponding values:
140+
141+
|Preference Name|Value|
142+
|--|--|
143+
|`devtools.debugger.remote-enabled`|`true`|
144+
|`devtools.chrome.enabled`|`true`|
145+
|`devtools.debugger.prompt-connection`|`false`|
146+
6) Close, and then open Firefox Nightly (like in step 3)
147+
7) Give it a few seconds for the Nightly tab to show up in launchpad
148+
122149
### Starting Chrome
123150

124151
There are two ways to run Chrome for the purposes of remote debugging with the debugger:

0 commit comments

Comments
 (0)