Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jacksteamdev/example-linux-hosted-crx
https://github.com/jacksteamdev/example-linux-hosted-crx
Last synced: 22 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/jacksteamdev/example-linux-hosted-crx
- Owner: jacksteamdev
- Created: 2022-01-20T18:00:22.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-09-02T22:12:45.000Z (over 2 years ago)
- Last Synced: 2024-10-24T22:44:26.462Z (2 months ago)
- Language: JavaScript
- Size: 2.55 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Linux Extension Update Server
This project contains a naive implementation of a Chrome extension update server
and utilities to create a CRX file and extract the id and key from the private
key.
> While the server will run on any OS, only Linux supports installing Chrome
> extensions distributed from an origin other than the Chrome Web Store. See
> [Google documentation](https://developer.chrome.com/docs/extensions/mv3/external_extensions/#preferences).
## Usage
```sh
# install dependencies
pnpm install
# run the server and open chromium w/ local data dir
pnpm start
# restart server+chromium on file changes
pnpm dev
# pack /crx and print id+key
pnpm pack-crx
```
The sample extension will open a tab with update info when an update occurs.
The extension action will request an update check and display the results as a
badge and title.
## Notes
An extension must be packed into a CRX file before distribution. Chrome supports
packing an extension from the command line. `./src/packCrx.mjs` outlines this
process.
OpenSSL can extract the extension id and key from a PEM file.
`./src/getCrxId.mjs` and `./src/getCrxKey.mjs` contain the relevant shell
commands.
Chrome supports forced Linux installations by way of a preferences JSON file
placed in the app extensions folder. The module `./src/installCrx.mjs` outlines
how to do this.
The server has two endpoints: an update endpoint and a download endpoint. The
update endpoint must end in `.xml`; Chrome will append `.xml` to any update URL
that does not end with that extension.
If the user manually uninstalls the extension, Chrome places it on a blocklist
and will ignore the preferences file. During development we can remove an
extension id from the blocklist by manually installing the CRX file and removing
it.
## References
- [Alternative extension installation methods - Chrome Developers](https://developer.chrome.com/docs/extensions/mv3/external_extensions/#preferences)
- [Obtaining Chrome Extension ID for development - Stack Overflow](https://stackoverflow.com/questions/23873623/obtaining-chrome-extension-id-for-development)