https://github.com/tulibraries/cob_web_index
https://github.com/tulibraries/cob_web_index
dataops librarysearch
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/tulibraries/cob_web_index
- Owner: tulibraries
- Created: 2019-07-18T20:20:21.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2026-01-28T18:28:03.000Z (about 1 month ago)
- Last Synced: 2026-01-29T08:56:00.534Z (about 1 month ago)
- Topics: dataops, librarysearch
- Language: Ruby
- Homepage:
- Size: 9.71 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# CobWebIndex
[](https://travis-ci.org/tulibraries/cob_web_index)
[](https://coveralls.io/github/tulibraries/cob_web_index?branch=main)
Cob Web Index is a repository to hold the traject configuration files and scripts associated with indexing of the library website entities.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'cob_web_index'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install cob_web_index
## Usage
`cob_web_index` is an executable. You can use it to ingest files into SOLR_WEB_URL with
```
cob_web_index ingest $path_to_file
```
`$path_to_file` can also be a URL.
Note also that `$path_to_file` is an optional argument. If not provided then by default ingest will attempt to download the latest website dataset from location base set at WEB_CONTENT_BASE_URL and import that.
### Basic Auth Usage
If endpoint url has basic auth enabled, set the following environment variables:
* WEB_CONTENT_BASIC_AUTH_USER
* WEB_CONTENT_BASIC_AUTH_PASSWORD
## Development
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.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
### Ingest Fixture Files
`cob_web_index ingest --use-fixtures`
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/tulibraries/cob_web_index. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the CobWebIndex project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/tulibraries/cob_web_index/blob/main/CODE_OF_CONDUCT.md).