Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexandre-abrioux/webextension-helper
Speed up the distribution of self-hosted webextensions in Firefox.
https://github.com/alexandre-abrioux/webextension-helper
firefox firefox-webextension web-ext webextension webextension-helper
Last synced: 7 days ago
JSON representation
Speed up the distribution of self-hosted webextensions in Firefox.
- Host: GitHub
- URL: https://github.com/alexandre-abrioux/webextension-helper
- Owner: alexandre-abrioux
- Created: 2018-08-14T10:18:12.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-24T11:18:23.000Z (22 days ago)
- Last Synced: 2024-10-25T10:23:55.600Z (21 days ago)
- Topics: firefox, firefox-webextension, web-ext, webextension, webextension-helper
- Language: PHP
- Homepage:
- Size: 25.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# webextension helper
Speed up the distribution of self-hosted Firefox webextensions
- provides a lightweight web service to serve your JSON update manifest ;
- ease the usage of [`web-ext`](https://github.com/mozilla/web-ext) via a simple docker image
to sign your webextension on [AMO](https://addons.mozilla.org/)
## Dependencies
This tool relies on `docker` and `docker-compose`.
See https://docs.docker.com/compose/install/
Some shortcuts are provided by a `Makefile`.
You will need `make` to use them, but the tool is not mandatory.
## Installation
- navigate to your webextension's project directory
```
cd /home//dev/webextension
```
- move all sources to a new subdirectory `src`.
If you already used the `web-ext` npm package in this directory before you should also move your add-on id file.
```
mkdir src
mv !(src) src
[ -f .web-extension-id ] && mv .web-extension-id src
```
- clone this repository as a submodule of the webextension
```
git submodule add [email protected]:alexandre-abrioux/webextension-helper.git helper
```
- copy `helper/.env.dist` to `helper/.env` and fill in
your [Mozilla API credentials](https://addons.mozilla.org/en-US/developers/addon/api/key/).
You can find all the available options on
the [web-ext reference page](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/web-ext_command_reference).
```
cp helper/.env.dist helper/.env
vim helper/.env
```
## Signing your Web-Extension
Simply run `make sign`.
## Updating Mozilla's `web-ext` Tool
To rebuild the `web-ext` docker image you can run `make update`.
## Enabling Auto-Updates
- configure your webextension's manifest file to target the `update.php` script
```
"applications": {
"gecko": {
"update_url": "https://webextension-helper.example.com/updates.php"
}
}
```
- use the `docker-compose.yml` file to start the web service on your server
```
make up
```
## Makefile
Some shortcuts are configured in a `Makefile`. Use `make help` for more information.
- `make help`
- `make build`
- `make up`
- `make stop`
- `make down`
- `make restart`
- `make sign`
- `make update`