This repository is a fork of https://github.com/omc/searchyll used for indexing the developers.italia.it website. All the changes were contributed upstream, so when all our pull requests are merged we can get rid of this fork.
Search for Jekyll apps. A plugin for indexing your pages into a search engine.
Currently supports Elasticsearch, we're also considering modular support for Apache Solr in a future release.
Add this line to your application's Gemfile:
gem 'searchyll'
In your Jekyll Gemfile:
gems:
- searchyll
elasticsearch:
url: "http://localhost:9200/" # Required. Supports auth and SSL: https://user:[email protected]
# Can also read URLs stored in environment variable named
# BONSAI_URL and ELASTICSEARCH_URL.
number_of_shards: 1 # Optional. Default is 1 primary shard.
number_of_replicas: 1 # Optional. Default is 1 replica.
index_name: "jekyll" # Optional. Default is "jekyll".
default_type: "post" # Optional. Default type is "post".
custom_settings: _es_settings.yml # Optional. No default. Relative to your src folder
custom_mappings: _es_mappings.yml # Optional. No default. Relative to your src folder
ignore: # Optional. No default.
- /news/*
Elasticsearch authentication can be provided both by passing user and password as URI parameter:
url: https://user:[email protected]
Or by easily setting those ENV variables:
ELASTICSEARCH_URL=http://localhost:9200/
ELASTICSEARCH_USER=elastic
ELASTICSEARCH_PASS=changeme
It should be written to be plugged into the settings
slot of a create index call
analysis:
analyzer:
stop_analyzer:
type: stop
stopwords: _english_
index:
number_of_shards: 1
number_of_replicas: 0
It should be written to be plugged into the mappings.[type]
slot of a create index call
properties:
field1:
type: text
After checking out the repo, run bin/setup
to install dependencies. Then, run
rake spec
to run the tests. You can also run bin/console
for an interactive
prompt that will allow you to experiment.
Bug reports and pull requests are welcome on GitHub at https://github.com/omc/searchyll