{"user":"ppouliot","name":"ghe-helper","namespace":"ppouliot","repository_type":"image","status":1,"status_description":"active","description":"GHE-Helper: A helper platform for  GitHub.com and Github Enterprise administration","is_private":false,"is_automated":true,"star_count":0,"pull_count":815,"last_updated":"2018-11-06T14:07:28.600609Z","last_modified":"2024-10-16T13:48:34.145251Z","date_registered":"2018-01-31T14:41:10.278538Z","collaborator_count":0,"affiliation":null,"hub_user":"ppouliot","has_starred":false,"full_description":"# dockerfile-ghe-helper\n[![License](https://img.shields.io/github/license/ppouliot/dockerfile-ghe-helper.svg)](./LICENSE)\n[![Source Code](https://img.shields.io/badge/source-GitHub-blue.svg?style=flat)](https://github.com/ppouliot/dockerfile-ghe-helper)\n[![Latest version](https://img.shields.io/github/tag/ppouliot/dockerfile-ghe-helper.svg?label=release\u0026style=flat\u0026maxAge=3600)](https://github.com/ppouliot/dockerfile-ghe-helper/tags)\n[![GitHub issues](https://img.shields.io/github/issues/ppouliot/dockerfile-ghe-helper.svg)](https://github.com/ppouliot/dockerfile-ghe-helper/issues)\n[![GitHub forks](https://img.shields.io/github/forks/ppouliot/dockerfile-ghe-helper.svg)](https://github.com/ppouliot/dockerfile-ghe-helper/network)\n[![Docker Automated build](https://img.shields.io/docker/automated/ppouliot/ghe-helper.svg)](https://hub.docker.com/v2/repositories/ppouliot/ghe-helper/autobuild/)\n[![Docker Build Status](https://img.shields.io/docker/build/ppouliot/ghe-helper.svg)](https://hub.docker.com/v2/repositories/ppouliot/ghe-helper/builds/)\n[![Docker pulls](https://img.shields.io/docker/pulls/ppouliot/ghe-helper.svg?style=plastic)](https://registry.hub.docker.com/v2/repositories/ppouliot/ghe-helper/)\n\n```\n   ___ _ _   _        _      ___     _                    _          _  _     _               \n  / __(_) |_| |_ _  _| |__  | __|_ _| |_ ___ _ _ _ __ _ _(_)______  | || |___| |_ __  ___ _ _ \n | (_ | |  _| ' \\ || | '_ \\ | _|| ' \\  _/ -_) '_| '_ \\ '_| (_-\u003c -_) | __ / -_) | '_ \\/ -_) '_|\n  \\___|_|\\__|_||_\\_,_|_.__/ |___|_||_\\__\\___|_| | .__/_| |_/__|___| |_||_\\___|_| .__/\\___|_|  \n                                                |_|                            |_|            \n```\n\n## Description\n\nThis is the Dockerfile for building Github Enterprise Helper (ghe-helper).\nGithub Enterprise Helper is a container platform built with tooling for\ninteracting with Github Enterprise and Github.com data and functionality.\n\nThe container launches multiple  ``` byobu ``` windows which present different \nGHE tooling or vizualizes logging of the GHE instance.\n\nThe core of this originated around a project to consolidate multiple SCMs into \nGithub Enterprise.  \n\nYou can find published versions of this image on the [Docker Hub.](https://hub.docker.com/u/ppouliot)\n\n* [![](https://images.microbadger.com/badges/image/ppouliot/ghe-helper.svg)](https://microbadger.com/images/ppouliot/ghe-helper) [![](https://images.microbadger.com/badges/version/ppouliot/ghe-helper.svg)](https://microbadger.com/images/ppouliot/ghe-helper) ppouliot/ghe-helper\n \n## Typical Use Cases\n\nThe typical usage of this is GHE Administration however falls into \nthe following 3 sub catagories.\n\n1. Github to Github Enterprise Migrations\n2. Github/Github Enteprise Backups\n3. Creation of markup using tooling specific for use in GH-Pages/GHE-Pages  \n\n\n## Github to Github Enterprise Migrations\n\n   1. **Required Environment Varibles**\n\n      The following Environmental Variables must be set either in the `docker run ` statement\n      by using a file containing the variables and supplying the `--env-file \u003cyour_file\u003e`\n      or using `-e` and pass in each required variable independently.\n      The following variables are needed for successful migrations\n\n      * GHE_HOST: The hostname of your github enterprise server\n      * GHE_TOKEN: A token from your Github Enterprise server which has Site Admin Privileges.\n      * GHE_SSH_USER: The name of your Github Enterprise server administrator account\n      * GHE_SSH_PORT: The administrative ssh port of your Github Enterprise Instancea.\n      * GHE_PASS: The password for the Github Enterprise Admin Site.\n      * GHE_USER: The username of the account used for GHE_TOKEN\n      * GH_TOKEN: The Token of an Owner of the Repository on Github.com\n      * GHE_TOTP: same as GHE_TOKEN\n\n      **Example: Environment Variables**\n\n      Included in this project is a sample [ file ](/environment.example) containing the environment\n      variables needed to bo be configured in order to successfully migrate\n      Organizations from Github to Github Enterprise.  This file can be used as template.\n\n      ```\n      GHE_HOST=github.yourghe.com\n      GHE_TOKEN= 1234567890abcdef1234567890abcdef12345678\n      GHE_SSH_USER=admin\n      GHE_SSH_PORT=122\n      GHE_USER=you@your-email.com\n      GHE_PASS=Y0urGh3P@ss0rd\n      GH_TOKEN=1234567890abcdef1234567890abcdef12345678\n      GHE_TOTP=1234567890abcdef1234567890abcdef12345678\n      ```\n\n   2. **SSH Keys**\n\n      SSH Keys that have admin access to the Github Enterprise Instance are required.  These can be passed\n      into the container at runtime using ``` -v path/to/.ssh:/root/.ssh ```. Additional information on how\n      to generate ssh keys can be found [here.](https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/)\n      \n\n   3. **Running the Container**\n\n      The following docker commands can be used to run the container.\n   \n      ```\n      docker pull ppouliot/ghe-helper:latest\n      docker run -h ghe-helper -it --env-file .env -v $HOME/.ssh:/root/.ssh  -p 4000:4000 -p 4567:4567 ppouliot/ghe-helper\n      ```\n\n      Once properly executed you will be placed into a running instance of the GHE-Helper presented as a multi-window console experience.\n      The console is broken into four different areas.   \n\n## GHE/ghe-migrator.log\n\n      This includes the [GHE](https://github.com/ppouliot/ghe) application.  GHE is a python application wrapping GHE tooling on the GHE Appliance.\n      GHE can be used for basic admin tasks as well as Github to GHE migrations. \n      General usage information can be obtained by running ``` help ``` from within the ``` GHE\u003e ``` command shell or by visitingi\n      the documentation [here.](https://github.com/ppouliot/ghe/wiki)\n      \n      For Github to Github specific information please follow the documentation located at the [fork](https://github.com/ppouliot/ghe) of the\n      [original](https://git.generalassemb.ly/ga-admin-utils/ghe) GHE project that I am currently extending \u0026 maintaining [here.](https://github.com/ppouliot/ghe/wiki/ghe-migrate)\n\n## Github Backup Utilities\n\n   1. **Accessing the Github backup utilities**\n\n      Github provides [tooling](https://github.com/github/backup-utils) for performing backups of Github Enterprise.  The Github Backup Utilities are included within this container\n      image.  Additoinally a ``gh-backup`` user is also added to the container image and configured for access to installed Github Backup Utilities..\n      Currently in order to access the  ``gh-backup`` user existing in this container you must run ``` su - gh-backup ``` as passed in option from the original docker command.\n\n   2. **Example Command**\n\n       ( coming soon. )\n\n\n## Github Pages\n\n( coming soon. )\n\n## References\n\nThe following resources were used in the creation of this platform.\n\n  1. github/backup-utils\n     1. https://github.com/github/backup-utils\n  2. GHE\n     1. https://github.com/ppouliot/ghe (Code used in this container)\n     2. https://git.generalassemb.ly/ga-admin-utils/ghe (Origianl Source of the code used in this container)\n  3. Misc Research\n     1. https://moox.io/blog/keep-in-sync-git-repos-on-github-gitlab-bitbucket/\n","permissions":{"read":true,"write":false,"admin":false},"media_types":["application/vnd.docker.container.image.v1+json"],"content_types":["image"],"categories":[],"immutable_tags_settings":{"enabled":false,"rules":[".*"]},"storage_size":9532295842,"source":null}