/simple-gource-launch

Simple launching of a dockerized Gource git repo activity movie creator

Primary LanguageShellMIT LicenseMIT

PURPOSE

Generate movies of git repo activity by running a simple shell script requiring only one argument.

REQUIREMENTS

You must have already installed Docker. The movies are generated by a combination of cool open-source tools running in a docker container.

USAGE

Clone this repo and run the provided launch.sh script from your linux console. To view and download your movie, open the user interface at http://localhost:8080/ in your browser.

./launch.sh GIT_REPO_URL PROJECT_TITLE LOGO_URL
  • GIT_REPO_PATH = (REQUIRED) A local directory containing repo logs or a URL to a git repo.
  • PROJECT_TITLE = (OPTIONAL) text to appear as the title; defaults to git url.
  • LOGO_URL = (OPTIONAL) fully qualified url to logo; defaults to no logo.

EXAMPLE

  1. Launch script in console with the URL to the git repo you want to "film".

launch with params

  1. Verify the values when prompted; press ENTER key to kick off the show!

verification screen

  1. Wait for the gource application to finish making your mp4 movie. The browser at localhost:8080 will show a temporary message until the movie is ready.

browser movie not ready

  1. The console will show you when the film is ready.

console movie created message

  1. Watch the movie in the browser when ready.

watch in browser

  1. Download your mp4 movie by clicking the menu link in the lower right hand part of the browser page.

download the file from browser

SOURCE

Copy of entire source project copied from original author is in the Envisaged folder. Copy is from https://github.com/utensils/Envisaged