Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/svandragt/fafi
Web content indexing and search tool
https://github.com/svandragt/fafi
bookmarks cli favourites firefox indexer python search-engine tui webui
Last synced: 3 months ago
JSON representation
Web content indexing and search tool
- Host: GitHub
- URL: https://github.com/svandragt/fafi
- Owner: svandragt
- Created: 2020-03-08T12:05:45.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-06-18T15:21:21.000Z (5 months ago)
- Last Synced: 2024-07-19T11:37:44.343Z (4 months ago)
- Topics: bookmarks, cli, favourites, firefox, indexer, python, search-engine, tui, webui
- Language: Go
- Homepage:
- Size: 6.1 MB
- Stars: 9
- Watchers: 3
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# fafi
Web content indexing and search tool
* Aim of the rewrite in GO is to have a single binary that starts a webserver which can be started via systemd and queried via firefox.
* On launch it will index any missing bookmarks (in a background process)
This is how it looks:
## Environment variables
```env
# Defaults are below:
# Port number for the webserver.
FAFI_PORT=8080
# Set to non-empty value to skip populating the database with sample records.
FAFI_SKIP_RECORDS=0
# Set to 0 to disable indexing on startup
FAFI_ENABLE_INDEXING=1
# Default database path:
FAFI_DB_FILEPATH=fafi.sqlite3
# Enable importing bookmarks from Firefox profile db:
FAFI_FIREFOX=/home/san.../32kuswpy.default-release/places.sqlite
```
## Command-line arguments
Each of the environment variables are available as a longform command-line argument by discarding `FAFI_` and lower-casing the result, replacing underscores with dashes. For example `FAFI_ENABLE_INDEXING=0` and `--enable-indexing=0` are equivalent.
## Build and run
```shell
# build with full-text search
$ go build --tags fts5 -o tmp/fafi2 fafi2
# run, eg indexing your Firefox places database
$ tmp/fafi2 --firefox=/path/to/firefox/profile/places.sqlite
```