Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sevichecc/miniflux-injector
Injects Miniflux search results into search engine pages such as Google, DuckDuckGo, SearXNG and Brave Search.
https://github.com/sevichecc/miniflux-injector
miniflux miniflux-extension miniflux2
Last synced: 12 days ago
JSON representation
Injects Miniflux search results into search engine pages such as Google, DuckDuckGo, SearXNG and Brave Search.
- Host: GitHub
- URL: https://github.com/sevichecc/miniflux-injector
- Owner: Sevichecc
- License: mit
- Created: 2023-06-02T15:00:37.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-26T14:01:49.000Z (9 months ago)
- Last Synced: 2024-10-08T11:05:57.441Z (about 1 month ago)
- Topics: miniflux, miniflux-extension, miniflux2
- Language: CSS
- Homepage:
- Size: 3.46 MB
- Stars: 16
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Community browser extension for the self-hosted [miniflux](https://miniflux.app/) bookmark service.
Fork from [linkding-injector](https://github.com/Fivefold/linkding-injector)
**Features**
- When searching on a search engine the search term is also sent to your Miniflux instance and results are added in a new box in the sidebar right to the search engine results.
- Supports the following search engines:
- [google](https://www.google.com/)
- [duckduckgo](https://duckduckgo.com/)
- [SearX/SearXNG](https://github.com/searx/searx)*
- [Brave Search](https://search.brave.com/)
- [Kagi](https://kagi.com/)
- Automatic light or dark theme detection
- Open search result in Miniflux
Works with: Firefox, Chrome
- Omnibox support (type keyword 'mj' in searchbar to search in Miniflux)
_\* experimental, please read [this](docs/searx.md) if you have problems_
## Usage
### 1. Create a Miniflux API Key
After installation the extension needs to be configured and connected to your Miniflux instance, create your API key in `http://your-miniflux-domain/keys`, then copy that API keys
### 2. Setting the extension setting
Either open the extension options in the browser extension manager or follow the link in the new Miniflux injector box on the search page of google or duckduckgo.
Then paste the API keys you copy before, and fill in the Base URL with your Miniflux server's URL
Once the extension is properly configured, miniflux search results will show in the right sidebar. If there are no search results nothing will appear.
**Screenshots**
## Installation
- FireFox: [Mozilla Addon Store](https://addons.mozilla.org/zh-CN/firefox/addon/miniflux-injector/)
- Chrome : [Chrome Store](https://chromewebstore.google.com/detail/miniflux-injector/olnngmhgopdgnfenhimlmnmemadhofdd)
## Build
**Requirements**
- Latest LTS Node version (v14+ )
- Latest LTS NPM version (v6+)
- bash (on Linux) or powershell (on Windows)
- npx (included with npm v5.2+)
Internally, we use `web-ext` to bundle a distribution package for the extension for Firefox. You do not need to install `web-ext`. Note that `web-ext` will generate a zip file which can also be used for the Chrome Web Store.
Then run the following script to generate a build (might need to make the file executable on Linux using `chmod +x build.sh`):
```bash
./build.sh # Linux
```
```powershell
./build.ps1 # Windows
```
The script does:
- Install all dependencies using NPM
- Runs rollup to transpile and minify source files, with output written to the `build` directory
- Run web-ext to package the extension for uploading to the Mozilla addon store
After the build the root directory contains the complete, unpackaged extension. Use the `manifest.json` file to load it manually into the browser.
The packaged extension can be found in the `web-ext-artifacts` folder.
## Acknowledgements
- This extension reuses and adapts code from the [official linkding extension](https://github.com/sissbruecker/linkding-extension)
Logo:
- [Miniflux logo](https://github.com/miniflux/logo) - [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/)
- [Ysabeau](https://github.com/CatharsisFonts/Ysabeau) - [OFL-1.1 license](https://github.com/CatharsisFonts/Ysabeau/blob/master/OFL.txt)