deepjyoti30 / startpage

A minimal starpage for Chrome and Firefox
MIT License
625 stars 85 forks source link

Wiki page for Firefox building & signing #9

Closed reesericci closed 4 years ago

reesericci commented 4 years ago

Could you enable the wiki so I could submit a page for building and signing the extension for Firefox so the extension is not loaded temporarily?

deepjyoti30 commented 4 years ago

Hey @reesericci I enabled the Wiki yesterday itself. Anyway, I added a settings menu on the extension and I'm thinking of pushing it to the respective add on stores.

If you want, try it out and raise an issue if you find any bugs.

reesericci commented 4 years ago

I just finished writing up the wiki page but GH doesn't support pull requests on wiki pages so here's the page for you to create:

Firefox Building & Signing

To make the startpage extension permanent and not have to re-add the extension every time you restart Firefox, you must build the extension/your config and get it signed by Mozilla.

Building the extension

Install node.js/npm from nodejs.org so we can install the web-ext tools.

To install the web-ext tools so we can build the extension, run this command in a terminal after installing npm:

npm install -g web-extension

Then change directory into the same directory as the startpage extension files. Example: cd startpage Then use web-ext to build the extension:

web-ext builds

This will create a directory called web-ext-artifacts and in which there will be a zip file. This file is your built extension.

Signing the built extension

To get the extension signed by Mozilla you have to go to the Mozilla Developer Hub and sign in with a Firefox Account.

Select "Distribute on my own"

Then click "Upload File" and select the startpage directory, then web-ext-artifacts, then the zip file that was just created.

Then select compatibility with Firefox and Firefox for Android

Then hit "Sign add-on", Click "No" for source-code distribution and then wait 5-10 minutes.

Downloading the signed extension

Once you've waited 5-10 minutes your extension should have been signed.

To download the extension go to the Developer Hub and click the button that says "View All Submissions"

Then click "minimal-startpage"

Then on the left sidebar click "Manage Status & Versions"

Tip: To update the extension change the extension's version number in manifest.json, build the extension, and then click "Upload a new version" on this page, then follow the steps below.

Then in the top version number's section check the "Status" if it says "Approved" then you are good to go!

Then click the top version number

Then under files, click the .xpi file and install it!

You're done!

reesericci commented 4 years ago

Also, settings menu works great although the UI color scheme could be improved if possible, as well as making it --settings instead of --setting. Otherwise, works great!

deepjyoti30 commented 4 years ago

@reesericci Can you directly gimme the markdown for the wiki page. It'd be easier for me to just copy paste.

reesericci commented 4 years ago

Here you go: https://hastebin.com/raw/wekunaxecu

deepjyoti30 commented 4 years ago

@reesericci Thank's for that.

I updated the Wiki and the Readme and also added at the end of the Wiki that it was written by you. Thanks again.

reesericci commented 4 years ago

No problem. Closing Issue