Go to file
2019-12-21 15:56:59 -05:00
src graceful bad-config handling 2019-12-21 15:56:59 -05:00
.gitignore 0.1.0 release 2019-12-15 14:57:42 -05:00
bunbun.default.toml update readme 2019-12-15 15:07:26 -05:00
Cargo.lock implement config file watching 2019-12-21 14:04:13 -05:00
Cargo.toml implement config file watching 2019-12-21 14:04:13 -05:00
LICENSE 0.1.0 release 2019-12-15 14:57:42 -05:00
README.md update readme 2019-12-15 15:07:26 -05:00
rustfmt.toml rustfmt 2019-12-21 14:21:20 -05:00

bunbun

Self-hostable, easy-to-configure, fast search/jump multiplexer service.

bunbun is a pure-Rust implementation of bunny1, providing a customizable search engine and quick-jump tool in one.

After adding it to your web-browser and setting it as your default search engine, you'll gain the ability to quick-jump to a specific page or search from a specific engine:

g hello world   // Searches "hello world" in google
r anime         // Goes to reddit.com/r/anime
ls              // Lists all available commands and aliases
foo bar         // If foo is a defined command, do something with bar
                // Alternatively, if a default route is set, use the entire
                // query for the default route

Installation

If you have cargo, you can simply run cargo install bunbun.

Once installed, simply run it. A default config file will be created if one does not exist. You should model your own custom routes after the provided ones.

Configuration

If configuring for development, no further configuration is required. If running this for production, you should edit the public_address field.

Adding bunbun as a search engine

bunbun supports the OpenSearch Description Format.

For Chrome, simply visiting the index page will auto add bunbun as a search engine. You simply need to set it as a default in your preferences.

For Firefox, you need to explicitly add bunbun as a search engine. This can be done by clicking the three dots next to the star button on the url box, and clicking on "Add Search Engine". Then, you can set it as your default search engine.