GitHub Enterprise at QMUL¶
What is GitHub?¶
According to Wikipedia:
GitHub is a Web-based Git repository hosting service, which offers all of the distributed revision control and source code management (SCM) functionality of Git as well as adding its own features. Unlike Git, which is strictly a command-line tool, GitHub provides a Web-based graphical interface and desktop as well as mobile integration. It also provides access control and several collaboration features such as bug tracking, feature requests, task management, and wikis for every project.
How is GitHub Enterprise different from GitHub.com?¶
From GitHub Enterprise FAQ's:
GitHub Enterprise includes the same great set of features as GitHub.com but packaged for running on your organisation's local network. All repository data is stored on machines that you control, and access is integrated with your organisation's authentication system (LDAP, SAML, or CAS). Use GitHub Enterprise when you need complete control over repository and project information.
In summary, GitHub Enterprise offers the same functionality as the public GitHub offering but it's hosted within QMUL. This gives us full control over the management and security of the users and the data.
Who can use it?¶
All Queen Mary University of London currently enrolled students, student-facing faculty, and anyone performing academic non-profit research can use it free of charge.
If you do not fall into any of the above categories, you still might be able to use it, but will have to pay for an additional seat. Please contact us regarding pricing.
How do I access it?¶
You can access it through https://github.research.its.qmul.ac.uk. You have to use ITS Research credentials and not the your college credentials. If you do not have such account please request it here.
Please email us providing your college username if you experience any issues logging into Github at firstname.lastname@example.org.
Once you have logged in, we strongly recommend that you enable two-factor authentication. Please see here for the instructions.
GitHub support pages are very good, and they should be your first port of call.
If they can't answer your question, drop us an email at email@example.com.
We kindly ask you not to contact GitHub for support directly. We will first look at your issue and when required submit relevant support request on your behalf (this is the requirement of our T&C's)
I'm trying to make my project accessible to other people. How can I do it?¶
In order to allow other people to access your project you have to make it public. Please see this for instructions.
Please note, that
public inside of GitHub Enterprise is public
to the institution, not to the whole world.
Please contact us if you require any migration assistance.
I'm trying to create an organisation but that option is not available?¶
We have disabled the ability to create organisations by normal users. If you do think you need the organisation for you project please contact us.
What should I store on it?¶
Git has been designed with versioning of the text-based files in mind. Although it can store binary files (zip files, executables, word documents, pdf's, etc) it is generally not advisable to use it purely for that purpose.
You should not however use it to store passwords, sensitive data (including patient identifiable data) and large binary files.
Where will my data live?¶
Your data will be stored on internal QMUL servers.
I have not used git or GitHub before¶
There is a large number of resources available on the net.
For git we recommend Git Pro book which is a wonderful (and free) resource.
GitHub has tons of training material especially on GitHub usage.
Can you recommend a GUI client that I can use?¶
We tend to use command line tools - however there are many GUI clients that you could use. To name a couple:
For more complete list please see https://git.wiki.kernel.org/index.php/InterfacesFrontendsAndTools