GitHub Enterprise Overview

Overview

What is GitHub

GitHub is a web based interface to the version control software GIT. Version control software manages and tracks changes to files over time. It is a critical tool in software development. A great intro to using Git and GitHub can be found at GitHub Hello World Guide.

Details

How do I access GitHub @RPI

RPI's GitHub service is available to all RPI Faculty, Staff, and Students.

You may access the service at https://github.rpi.edu/ with a valid RCS username and password.

Can non-RPI people get accounts

Yes, as long as the project is RPI led and for academic or not-for-profit research then the external user will be permitted access. Guest accounts can be requested at https://webforms.rpi.edu/guest-account-form

Github Copilot

GitHub Copilot is an AI pair programmer. You can use GitHub Copilot to get suggestions for whole lines or entire functions right inside your editor.

GitHub Copilot is free to use for verified students, teachers, and maintainers of popular open source projects.

Faculty can apply to Github Global Campus to get free access to Copilot by following the instructions at https://docs.github.com/en/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-teachers/apply-to-github-global-campus-as-a-teacher

Students can apply to Github Global Campus to get free access to Copilot by following the instructions at https://docs.github.com/en/education/explore-the-benefits-of-teaching-and-learning-with-github-education/github-global-campus-for-students/apply-to-github-global-campus-as-a-student

Staff can submit a Support Request to request a license. Licenses for staff have a cost associated with it so request requires a FOAPAL and approval from individual with budgetary authority.

What documentation is available

This page will cover some common topics, particularly related to RPI's GitHub Enterprise service.

For topics not specific to RPI, general GitHub documentation is available at:

What are the restrictions for organization names

GitHub allows the use of groups called Organizations where multiple people can collaborate across many projects at once. Organization names fall into the same namespace as user accounts, which means that someone with an RCS ID that is the same as an existing organization will be denied access to GitHub @RPI. For this reason we currently require all organization requests to be submitted through https://webforms2.rpi.edu/request-github-enterprise-organization

How do I request an Organization

All requests for a new GitHub Organization should be made by filling out a GitHub Organization Request Form.

What is the address or URL of my repositories

GitHub uses HTTPS or SSH. The repository address for HTTPS will use the pattern:

If you use HTTPS, be aware that the system does not know (or use) your RCS password. You need to create an GitHub access token and use it as your password. See Creating an access token but be aware that you need to create the access token in your RPI GitHub account on github.rpi.edu (and not on github.com).

The repository address for SSH will use the pattern:

If you use SSH, you need to generate SSH keys and add them to your account. See Generating SSH keys, but be aware that some steps connect to the public GitHub.com site. You will want to adapt those steps, to connect to RPI's github.rpi.edu site.

Can I store large files in GitHub

Git is for storing lots of small files that change often, it is not suitable for large files.

How much storage am I allowed

RPI's GitHub enterprise is intended for use with text files such as source code. Binary files are allowed, but attention should be taken with regard to their size. There are no hard limits on file or repository size. However DotCIO does review usage for abnormal situations, and reserves the right to limit excessive use. Contact Us if you have questions about your planned use case.

Security & Privacy

As a user of GitHub @RPI, you understand and agree to abide by RPI’s Policy on Electronic Citizenship and acknowledge that you have reviewed this security information.

  • Staff - Activities in support of job responsibilities. Personal use acceptable as long as incidental in nature.
  • Faculty - Academic and not-for-profit research activities. Personal use acceptable as long as incidental in nature.
  • Students - Academic and personal use. Commercial use or any use for the benefit of an unaffiliated third party is prohibited.

You should not use your GitHub account to store most institutional data classified as Confidential.

Do not store private information such as usernames, passwords or security tokens in your GitHub repositories.

Two-Factor Authentication (2FA)

Two-factor authentication is required for all user accounts. All users should configure a TOTP app by following the instructions at https://docs.github.com/en/enterprise-server@3.13/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication

Any two-factor application that supports time-based one-time password (TOTP) is supported. If you do not already have a preferred two-factor app then the DUO Mobile app is recommended. Detailed instructions for iPhone and Android can be found below.

iPhone: https://guide.duo.com/iphone#add-account

Android: https://guide.duo.com/android#add-account

Command-line access

With 2FA enabled, you will not use your password to access GitHub Enterprise Server on the command line. Instead, use Git Credential Manager, a personal access token, or an SSH key. Detailed instructions can be found at https://docs.github.com/en/enterprise-server@3.13/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication#using-two-factor-authentication-with-the-command-line

What are the RPI GitHub Enterprise host key fingerprints

RPI GitHub's (github.rpi.edu) public key fingerprints:

2048 e9:b0:13:9e:d0:cf:09:a5:0e:cb:eb:3b:c2:85:f5:13 (RSA)
        2048 SHA256:DPjGmbN5c6wOPTRAPNmu/sVCglz4uq4gszYWuXZ4ZQU github.rpi.edu (RSA)
        
        256 fd:14:12:93:29:ee:a0:1a:50:61:1b:33:f5:07:6c:b8 (ECDSA)
        256 SHA256:4a8KbcUgosZPmi7ycux4aOwvqFnc3LPv5HIm3Ls37nA github.rpi.edu (ECDSA)

You should be able to use the following command to view which fingerprint is being used when you establish a ssh connection to github.rpi.edu.

ssh -o VisualHostKey=yes git@github.rpi.edu

Deleting & Restoring Files and Folders in your GitHub account

  • GitHub is a version control system, most deleted files are end user recoverable inside your repository.
  • Deleting an Organization or Repository is permanent and unrecoverable.
  • Git typically keeps a local copy of the repository on your machine during normal use.
  • DotCIO maintains backups of the servers providing this service for disaster recovery scenarios only.

Schedule Maintenance

Weekly preventive maintenance is scheduled on Wednesdays 8:30am to 9:30am Eastern Time. During this period GitHub @RPI may be down.

 

Last Reviewed: 18-Feb-2021