Installing Stork

There are two parts to Stork: the command line tool, and the Javascript module. Here, you'll learn how to install both.

!

Note:

If you're downloading a file from files.stork-search.net, make sure to read through Changes to Build Artifacts on the Stork CDN, a Github discussion describing how files are organized on the Stork fileserver.

The command line tool

macOS
Ubuntu
Cross-platform

Option 1: Install with Homebrew:

$ brew install stork-search/stork-tap/stork

Option 2: Download a pre-compiled binary (Intel only):

$ wget https://files.stork-search.net/releases/v1.2.1/stork-macos-10-15
$ chmod +x stork-macos-10-15

Option 3: If you have the Rust toolchain installed, use Cargo:

$ cargo install stork-search

Option 1: Download a pre-compiled binary:

$ wget https://files.stork-search.net/releases/v1.2.1/
stork-ubuntu-20-04
$ chmod +x stork-ubuntu-20-04

Option 2: If you have the Rust toolchain installed, use Cargo:

$ cargo install stork-search

Install the Rust toolchain and install Stork with Cargo:

$ cargo install stork-search

If these options don't work for you, please file a Github issue describing the installation process you hope to see!

The Javascript library

You can either load the Javascript library from the Stork CDN (backed by Cloudfront) or by self-hosting it.

From the Stork CDN:

Include the following script tag on your site, before your closing </body> tag:

<script src="https://files.stork-search.net/stork.js"></script>

This will load the most recent Stork module along with the matching WASM binary. It will make a stork global variable available in the browser.

To load a specific version of the Stork Javascript library, you can reference a specific version:

<script src="https://files.stork-search.net/releases/v1.2.1/stork.js"></script>

Self-hosting:

Download stork.js and stork.wasm from the latest Github release and publish those files on your web server. Be sure to serve stork.wasm with the correct MIME type, and be sure to call stork.initialize() with the URL where you're hosting the stork.wasm.

Visit the self-hosting guide for more information.

Updates

Stork updates contain bug fixes, indexing enhancements, UI enhancements, and additional configuration options.

The project aims to keep all Stork artifacts evergreen; in other words, an index configuration file you write will generate a valid index in all future versions of Stork, and an index itself will be useable on all future versions of the Stork Javascript library. However, some new features will only work with an updated Stork setup, and some new features will require that you rebuild your search index.

To track updates, follow the Stork Releases RSS feed.

© 2019–2021

Stork is built and shepherded by James Little, who's really excited that you're checking it out. If you have any questions or comments, feel free to tweet at him or open an issue on Github.

This site is open source. Please file a bug or open a PR if you see something confusing or incorrect. PRs are always welcome!

Logo by Bruno Monts. Please contact James Little before using the Stork logo. Thanks to Bruno and the fission.codes team for making this logo happen.