{"id":14037144,"url":"https://github.com/archivesunleashed/warclight","last_synced_at":"2025-07-27T05:30:33.649Z","repository":{"id":37952698,"uuid":"99259862","full_name":"archivesunleashed/warclight","owner":"archivesunleashed","description":"A Rails engine supporting the discovery of web archives.","archived":true,"fork":false,"pushed_at":"2023-06-13T14:08:59.000Z","size":13989,"stargazers_count":49,"open_issues_count":8,"forks_count":10,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-11-16T02:39:03.078Z","etag":null,"topics":["blacklight","discovery","rails","rails-engine","ruby","solr","warc","webarchive-discovery","webarchives"],"latest_commit_sha":null,"homepage":"https://archivesunleashed.org/warclight/","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/archivesunleashed.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2017-08-03T17:45:46.000Z","updated_at":"2024-10-16T14:43:06.000Z","dependencies_parsed_at":"2024-01-09T19:13:00.149Z","dependency_job_id":null,"html_url":"https://github.com/archivesunleashed/warclight","commit_stats":{"total_commits":296,"total_committers":8,"mean_commits":37.0,"dds":0.5304054054054055,"last_synced_commit":"26de50f3eb3f9fffde5ca547b5f31b3ef8b81894"},"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/archivesunleashed%2Fwarclight","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/archivesunleashed%2Fwarclight/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/archivesunleashed%2Fwarclight/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/archivesunleashed%2Fwarclight/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/archivesunleashed","download_url":"https://codeload.github.com/archivesunleashed/warclight/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227762536,"owners_count":17816036,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blacklight","discovery","rails","rails-engine","ruby","solr","warc","webarchive-discovery","webarchives"],"created_at":"2024-08-12T03:02:31.246Z","updated_at":"2025-07-27T05:30:33.639Z","avatar_url":"https://github.com/archivesunleashed.png","language":"Ruby","readme":"# NOTE\n\nWarclight is no longer under active development. This repo has been set to public archive.\n\nIf you're interested in web archive collections and Apache Solr, check out [SolrWayback](https://github.com/netarchivesuite/solrwayback). It uses the same underlying library as Warclight to index web archives into Solr, and offers many more features than Warclight.\n\n\u003c3 AU Team\n\n# Warclight\n[![codecov](https://codecov.io/gh/archivesunleashed/warclight/branch/main/graph/badge.svg)](https://codecov.io/gh/archivesunleashed/warclight)\n[![Gem Version](https://badge.fury.io/rb/warclight.svg)](https://badge.fury.io/rb/warclight)\n[![Contribution Guidelines](http://img.shields.io/badge/CONTRIBUTING-Guidelines-blue.svg)](./CONTRIBUTING.md)\n[![LICENSE](https://img.shields.io/badge/license-Apache-blue.svg?style=flat-square)](./LICENSE.txt)\n[![Depfu](https://badges.depfu.com/badges/d201582abe1955866e1b56ac43040541/overview.svg)](https://depfu.com/github/archivesunleashed/warclight?project_id=6476)\n\nA [Project Blacklight](http://projectblacklight.org/) based [Rails engine](http://guides.rubyonrails.org/engines.html) that supports the discovery of web archives held in the WARC and ARC formats. It allows faceted full-text search, record view, and other advanced discovery options.\n\nThe following article provides a nice overview:\n\nRuest, Nick, Milligan, Ian, and Lin, Jimmy. [Warclight: A Rails Engine for Web Archive Discovery](http://hdl.handle.net/10315/36159). Proceedings of the 2019 IEEE/ACM Joint Conference on Digital Libraries (JCDL 2019), June 2019, Urbana-Champaign, Illinois.\n\n## Requirements\n\n* [Ruby](https://www.ruby-lang.org/en/) 2.6 \u003c 3.0\n* [Bundler](https://bundler.io/) \u003c 2.2\n* [Rails](http://rubyonrails.org) 5.1 \u003c 6.2\n* [Solr](https://solr.apache.org/) \u003c 9\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'warclight'\n```\n\nAnd then execute:\n```bash\n$ bundle\n```\n\nOr install it yourself as:\n```bash\n$ gem install warclight\n```\n\nFor further details, see our [Creating, installing, and running your Warclight application](https://github.com/archivesunleashed/warclight/wiki/Creating%2C-installing%2C-and-running-your-Warclight-application) documentation.\n\n## Usage\n\nWarclight is designed to work with web archive data that is indexed via the UK Web Archive's [webarchive-discovery](https://github.com/ukwa/webarchive-discovery) project. A guide on indexing is available [here](https://github.com/archivesunleashed/warclight/wiki/Indexing-WARCs-ARCs-into-Warclight).\n\n## Development\n\nWarclight development uses [`solr_wrapper`](https://rubygems.org/gems/solr_wrapper/versions/0.18.1) and [`engine_cart`](https://rubygems.org/gems/engine_cart) to host development instances of Solr and Rails server on your local machine.\n\n### Run the test suite\n\nEnsure Solr and Rails are _not_ running (ports 8983 and 3000 respectively), then:\n\n```sh\n$ bundle exec rake\n```\n\n### Run a development server\n\n```sh\n$ bundle exec rake warclight:server\n```\n\nThen visit [http://localhost:3000](http://localhost:3000). It will also start a Solr instance on port 8983.\n\n### Run a console\n\nYou can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\n### Run with docker\n\nEnsure Docker is installed and configured.\n\n```sh\n$ docker-compose build\n$ docker-compose up\n```\n\nThen visit [http://localhost:3000](http://localhost:3000). It will also start a Solr instance on port 8983.\n\n### Release a new version of the gem\n\nTo release a new version:\n\n1. Update the version number in `lib/warclight/version.rb`\n2. Run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, build the gem file (e.g., `gem build warclight.gemspec`) and push the `.gem` file to [rubygems.org](https://rubygems.org) (e.g., `gem push warclight-x.y.z.gem`).\n\n## Contributing\n\n[Bug reports](https://github.com/archivesunleashed/warclight/issues) and [pull requests](https://github.com/archivesunleashed/warclight/pulls) are welcome on Warclight -- see [CONTRIBUTING.md](https://github.com/archivesunleashed/warclight/blob/main/CONTRIBUTING.md) for details.\n\n## License\n\nThe gem is available as open source under the terms of the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).\n\n## Acknowledgments\n\nThis work is primarily supported by the [Andrew W. Mellon Foundation](https://mellon.org/). Other financial and in-kind support comes from the [Social Sciences and Humanities Research Council](http://www.sshrc-crsh.gc.ca/), [Compute Canada](https://www.computecanada.ca/), the [Ontario Ministry of Research, Innovation, and Science](https://www.ontario.ca/page/ministry-research-innovation-and-science), [York University Libraries](https://www.library.yorku.ca/web/), [Start Smart Labs](http://www.startsmartlabs.com/), and the [Faculty of Arts](https://uwaterloo.ca/arts/) and [David R. Cheriton School of Computer Science](https://cs.uwaterloo.ca/) at the [University of Waterloo](https://uwaterloo.ca/).\n\nAny opinions, findings, and conclusions or recommendations expressed are those of the researchers and do not necessarily reflect the views of the sponsors.\n\nThis project drew inspiration from the [Arclight](https://github.com/sul-dlss/arclight) and [UKWA's Shine](https://github.com/ukwa/shine/), and would like to thank those creators and contributors.\n","funding_links":[],"categories":["Tools \u0026 Software","Ruby"],"sub_categories":["Search \u0026 Discovery"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farchivesunleashed%2Fwarclight","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farchivesunleashed%2Fwarclight","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farchivesunleashed%2Fwarclight/lists"}