updated README for extension
This commit is contained in:
parent
9d92db8aa0
commit
d9a0b2a75f
42
README.md
42
README.md
@ -1,33 +1,19 @@
|
||||
[![Build Status](https://drone.srv.kapelle.org/api/badges/niklas/startpage/status.svg?ref=refs/heads/master)](https://drone.srv.kapelle.org/niklas/startpage)
|
||||
# How to install
|
||||
|
||||
# How to set the new Tab
|
||||
## Firefox
|
||||
1. Download the extension
|
||||
2. Goto `about:addons`
|
||||
3. Click on the top right button
|
||||
4. Click `Install Add-on From File`
|
||||
5. Select the Add-on
|
||||
|
||||
[Reddit thread](https://www.reddit.com/r/startpages/comments/g3qndt/psa_how_to_set_a_custom_new_tab_page_in_firefox/)
|
||||
# How to build
|
||||
|
||||
Create 2 files inside of the firefox install directory.
|
||||
1. Build the bundle with `npm run buildProd`
|
||||
2. Provide the secrets required for signing the addon
|
||||
3. Sign the Add-on by Mozilla with `npm run ext:sign`
|
||||
|
||||
`${installDir}/defaults/pref/autoconfig.js`
|
||||
```js
|
||||
pref("general.config.filename", "autoconfig.cfg");
|
||||
pref("general.config.obscure_value", 0);
|
||||
pref("general.config.sandbox_enabled", false);
|
||||
```
|
||||
# Usefull links
|
||||
|
||||
`${installDir}/autoconfig.cfg`
|
||||
```
|
||||
// first line is a comment
|
||||
var {classes:Cc,interfaces:Ci,utils:Cu} = Components;
|
||||
var newTabURL = "http://localhost:8080";
|
||||
aboutNewTabService = Cc["@mozilla.org/browser/aboutnewtab-service;1"].getService(Ci.nsIAboutNewTabService);
|
||||
aboutNewTabService.newTabURL = newTabURL;
|
||||
```
|
||||
|
||||
Replace the "localhost" line in `autoconfig.cfg` with your URL.
|
||||
Also you can set the homepage via your normal settings.
|
||||
|
||||
Alternatively you can use a extentions called [New Tab override](https://addons.mozilla.org/en-US/firefox/addon/new-tab-override/).
|
||||
|
||||
## Chrome
|
||||
|
||||
Maybe [this](https://chrome.google.com/webstore/detail/custom-new-tab-url/mmjbdbjnoablegbkcklggeknkfcjkjia) extention. Not tested yet.
|
||||
- [Mozilla Developer hub](https://addons.mozilla.org/en-US/developers/)
|
||||
- [Mozilla Extension documentation](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions)
|
||||
- [Web ext documentation](https://extensionworkshop.com/documentation/develop/web-ext-command-reference/)
|
Loading…
Reference in New Issue
Block a user