https://github.com/solr-cool/solr-cool.github.io
The Solr Package Directory and Sanctuary
https://github.com/solr-cool/solr-cool.github.io
jekyll search search-engine solr
Last synced: 5 months ago
JSON representation
The Solr Package Directory and Sanctuary
- Host: GitHub
- URL: https://github.com/solr-cool/solr-cool.github.io
- Owner: solr-cool
- License: apache-2.0
- Created: 2015-06-02T08:28:29.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2025-07-15T22:05:53.000Z (11 months ago)
- Last Synced: 2025-07-16T21:03:39.787Z (11 months ago)
- Topics: jekyll, search, search-engine, solr
- Language: Shell
- Homepage: https://solr.cool
- Size: 7.82 MB
- Stars: 13
- Watchers: 6
- Forks: 9
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://travis-ci.org/github/solr-cool/solr-cool.github.io)
This repo holds the content for the [solr.cool](https://solr.cool) website
and Solr Package repository.
## Building
The website is built using [Jekyll](https://jekyllrb.com/) and
hosted on Github Pages. Use the official Docker image to fire
up a local Jekyll instance and point your browser to [localhost:4000](http://localhost:4000/).
```
docker run --rm \
--volume="$PWD:/srv/jekyll" \
-p "4000:4000" \
-it jekyll/jekyll:3.8 \
jekyll serve --watch
```
### Structure of package meta data
Solr package information and scraped meta data is checked in into
the [Jekyll `_data` folder](https://jekyllrb.com/docs/datafiles/)
in this repo:
* `_data/packages` – basic package information (manually curated)
* `_data/details` (_generated_) – scraped repository information of each package
* `_data/releases` (_generated_) – scraped release version information of each package
### Updating scraped package meta data
> ☝️ The update process is triggered by Travis CI on a daily basis.
To update package repository, release and version information, run
the `build.sh` script. For each package it will:
1. collect repository meta data from Github
1. collect release information from Github
1. collect build status information from Github (if applicable)
1. compile a Solr package manager inventory file
1. download and sign the release JARs
1. test installation and deinstallation of the package in a vanilla Solr installation
To run the `build.sh` locally, you need a [personal Github access token](https://github.com/settings/tokens)
and a public/private key pair:
```bash
export GH_USER=
export GH_ACCESS_TOKEN=
openssl genrsa -out solr.cool.pem 4096
openssl rsa -in solr.cool.pem -pubout -outform DER -out publickey.der
```
## Adding content
> 💡 You are very welcome to add your Solr package to solr.cool. We
> are open to both FOSS and commercially licensed packages.
[Please read the contributing guidelines how to add your package to the repository](CONTRIBUTING.md).
It's pretty easy, I swear!
## Deployment
Push to `master` on Github. Done.
## License
This project is licensed under the [Apache License, Version 2](http://www.apache.org/licenses/LICENSE-2.0.html).