Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mikeatlas/weft-gitrob

A wrapper around the gitrob opsec tool in docker
https://github.com/mikeatlas/weft-gitrob

Last synced: about 2 months ago
JSON representation

A wrapper around the gitrob opsec tool in docker

Awesome Lists containing this project

README

        

# weft-gitrob

weft-gitrob is a collection of scripts to make it possible to run the [gitrob](https://github.com/michenriksen/gitrob) tool locally, using only docker containers.

### Configuration

% git clone [email protected]:weftio/weft-gitrob.git
cd weft-gitrob
touch .env

Create your own `.env` file in the root of `weft-gitrob` directory. It needs the following values:

DB_USER=gitrob
DB_PASS=your_choice
GITHUB_ORG_NAME=your_org
GH_TOKEN1=generate_your_token1
GH_TOKEN2=generate_your_token1
GH_TOKEN3=generate_your_token1

Where `generate_your_token` should be replaced with a few GitHub [personal access tokens](https://github.com/settings/tokens), since I run this with "3000" threads in `start.sh`. I have no conclusive proof that this is any faster than 30 threads or that 3 tokens are needed versus one token at this many threads.

### Pre-requirements

Install and learn about [Docker](https://docs.docker.com/installation/mac/). As a result, you can skip learning about installing or running Ruby on Rails, which `gitrob` is built with and just run these dockerized container images. Neat.

### Builing

% docker-compose build

### Running weft-gitrob

You can start weft-gitrob locally, and have it launch the web results, by running:

% docker-compose up && \
open -a "Google Chrome" http://$(boot2docker ip):9393