# github-mirror
**Repository Path**: mirrors_blackducksoftware/github-mirror
## Basic Information
- **Project Name**: github-mirror
- **Description**: Scripts to mirror Github in a cloudy fashion
- **Primary Language**: Unknown
- **License**: BSD-2-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-10-29
- **Last Updated**: 2025-12-07
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# ghtorrent: Mirror and index data from the Github API
A library and a collection of scripts used to retrieve data from the Github API
and extract metadata in an SQL database, in a modular and scalable manner. The
scripts are distributed as a Gem (`ghtorrent`), but they can also be run by
checking out this repository.
GHTorrent can be used for a variety of purposes, such as:
* Mirror the Github API event stream and follow links from events to actual data
to gradually build a [Github index](http://ghtorrent.org/)
* Create a queriable metadata database for a specific repository
* Construct a data source for [extracting process analytics](http://www.gousios.gr/blog/ghtorrent-project-statistics/) (see for example [those](http://ghtorrent.org/pullreq-perf/)) for one or more repositories
## Components
GHTorrents components (which can be used individually) are:
* [APIClient](https://github.com/gousiosg/github-mirror/blob/master/lib/ghtorrent/api_client.rb): Knows how to query the Github API (both single entities and
pages) and respect the API request limit. Can be configured to override the
default IP address, in case of multihomed hosts.
* [Retriever](https://github.com/gousiosg/github-mirror/blob/master/lib/ghtorrent/retriever.rb): Knows how to retrieve specific Github entities (users, repositories, watchers) by name. Uses an optional persister to avoid
retrieving data that have not changed.
* [Persister](https://github.com/gousiosg/github-mirror/blob/master/lib/ghtorrent/persister.rb): A key/value store, which can be backed by a real key/value store,
to store Github JSON replies and query them on request. The backing key/value
store must support arbitrary queries to the stored JSON objects.
* [GHTorrent](https://github.com/gousiosg/github-mirror/blob/master/lib/ghtorrent/ghtorrent.rb): Knows how to extract information from the data retrieved by
the retriever in order to update an SQL database (see [schema](http://ghtorrent.org/relational.html)) with metadata.
### Component Configuration
The Persister and GHTorrent components have configurable back ends:
* **Persister:** Either uses MongoDB > 3.0 (`mongo` driver) or no persister (`noop` driver)
* **GHTorrent:** GHTorrent is tested mainly with MySQL and SQLite, but can theoretically be used with any SQL database compatible with [Sequel](http://sequel.rubyforge.org/rdoc/files/doc/opening_databases_rdoc.html). Your milaege may vary.
For distributed mirroring you also need RabbitMQ >= 3.3
## Installation
### 1. Install GHTorrent
GHTorrent is written in Ruby (tested with Ruby > 2.0). To install it as a Gem do:
sudo gem install ghtorrent
### 2. Install Your Preferred Database
Depending on which SQL database you want to use, install the appropriate
dependency gem.
sudo gem install mysql2 # or sqlite3
## Configuration
Copy [config.yaml.tmpl](https://github.com/gousiosg/github-mirror/blob/master/config.yaml.tmpl)
to a file in your home directory.
All provided scripts accept the `-c` option, which accepts the location of the configuration file as
a parameter.
You can find more information of how you can setup a mirroring cluster of machines
to retrieve data in parallel on the [Wiki](https://github.com/gousiosg/github-mirror/wiki/Setting-up-a-mirroring-cluster).
## Using GHTorrent
To mirror the event stream and capture all data:
* `ght-mirror-events.rb` periodically polls Github's event
queue (`https://api.github.com/events`), stores all new events in the
configured pestister, and posts them to the `github` exchange in
RabbitMQ.
* `ght-data_retrieval.rb` creates queues that route posted events to processor
functions. The functions use the appropriate Github API call to retrieve the
linked contents, extract metadata (for database storage), and store the
retrieved data in the appropriate collection in the persister, to avoid
duplicate API calls.
Data in the SQL database contain pointers (the `ext_ref_id` field) to the
"raw" data in the persister.
To retrieve data for a repository or user:
* `ght-retrieve-repo` retrieves all data for a specific repository
* `ght-retrieve-user` retrieves all data for a specific user
To perform maintenance:
* `ght-load` loads selected events from the persister to the queue in order for
the `ght-data-retrieval` script to reprocess them
### Data
The code in this repository is used to power the data collection process of
the [GHTorrent.org](http://ghtorrent.org/) project.
You can find all data collected by in the project in the
[Downloads](https://ghtorrent.org/downloads.html) page.
There are two sets of data:
* **Raw events:** Github's [event stream](https://api.github.com/events). These
are the roots for mirroring operations. The `ght-data-retrieval` crawler starts
from an event and goes deep into the rabbit hole.
* **SQL dumps + Linked data:** Data dumps from the SQL database and the corresponding MongoDB entities.
## Bugs & Feature Requests
Please tell us about features you'd like or bugs you've discovered on our
[Issue Tracker](https://github.com/gousiosg/github-mirror/issues).
Patches, bug fixes, etc are welcome. Please fork the repository and create
a pull request when done fixing/implementing the new feature.
## Citing GHTorrent in your Research
If you find GHTorrent and the accompanying datasets useful in your research,
please consider citing the following paper:
> Georgios Gousios and Diomidis Spinellis, "GHTorrent: GitHub’s data from a firehose," in _MSR '12: Proceedings of the 9th Working Conference on Mining Software Repositories_, June 2-–3, 2012. Zurich, Switzerland.
## Authors
* [Georgios Gousios](http://istlab.dmst.aueb.gr/~george)
* [Diomidis Spinellis](http://www.dmst.aueb.gr/dds)
## License
[2-clause BSD](http://www.opensource.org/licenses/bsd-license.php)