Jump to content

Git repository on this server: Difference between revisions

From HW wiki
 
(27 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Repository Types ==
Repositories on rtime server are managed by [http://github.com/sitaramc/gitolite Gitolite tool], which allows to conveniently manage repository permissions.  World readable repositories can be [http://rtime.felk.cvut.cz/gitweb browsed online].


This server can host two types of Git repositories.
In addition to gitolite repositories, users with shell account can create [[Git repositories in home directories|Git repositories in their home directory]]. This does not require any coordination with the administrator.
;Central repositories: These repositories are managed by [http://github.com/sitaramc/gitolite Gitolite tool], which allows to conveniently manage repository permissions.  World readable repositories can be [http://rtime.felk.cvut.cz/gitweb browsed online].
;Personal repositories: Any user with shell access to this server can create his/her own git repository under his/her home directory and make it public using git protocol.


== Central Repositories ==
== Getting write access to repositories ==


=== Getting write access to repositories ===
Write access to the repositories can only be given to users who send the following information to the [http://rtime.felk.cvut.cz/~sojka/ administrator]:


Write access to central repositories can only be given to users who sent their Open SSH public key to the [http://rtime.felk.cvut.cz/~sojka/ administrator] together with their university assigned login name (if any). The SSH key can be created in Linux/Unix (or in [http://code.google.com/p/msysgit/ MSysGit] shell in Windows) by:
# OpenSSH public key
# Login name (for ČVUT people) or email address (for others).  


  ssh-keygen
=== SSH key creation ===
 
The SSH key can be created with one of the following ways. Note that under Windows, methods 1 and 2 only work if [[Media:git-plink.jpg|OpenSSH]] has been selected during Git installation.
 
# Under Linux/Unix (or in Git Bash under Windows) run: <pre>ssh-keygen</pre>
# In Git Gui (under Linux or Windows) choose [[Media:Git-gui-key.jpg|Help -> Show SSH key -> Generate key]].
# Under Windows use PuTTYgen. Use this if you have chosen to [[Media:git-plink.jpg|use Plink]] during Git installation.


It is stored by default at <tt>~/.ssh/id_rsa.pub</tt>.
It is stored by default at <tt>~/.ssh/id_rsa.pub</tt>.


During the key creation you will be asked for a passphrase. If you do not specify any passphrase, anybody with access to your <tt>~/.ssh</tt> directory could access your repositories. If you specify the key, the passphrase will need to be entered whenever to use the key. By using <tt>ssh-add</tt> command you can specify the passphrase only once and the decrypted key will be remembered in the memory.
=== Password-protected keys ===
 
During the key creation you will be asked for a passphrase. If you do not specify any passphrase, anybody with access to your <tt>~/.ssh</tt> directory could access your repositories. If you specify the passphrase, it will need to be entered whenever you want to push to or pull from the server. By using <tt>ssh-add</tt> command (or Pageant program under Windows) you can specify the passphrase only once and the decrypted key will be remembered in the memory.


=== Creating central repositories ===
== Creating repositories ==


There are to ways how a repository can be created:
There are two ways how a repository can be created:


# Send an email to the [http://rtime.felk.cvut.cz/~sojka/ administrator] with the name of the repository, a short description and a list of people (SSH public keys) who should have access to the repository.
# Send an email to the [http://rtime.felk.cvut.cz/~sojka/ administrator] with the name of the repository, a short description and a list of people (login or email) who should have access to the repository. The administrator creates the repository for you and notifies you when it's done.
# Our group staff members can create their repositories without asking the administrator. See below.
# Our group staff members can create their repositories without asking the administrator. See below.


==== Automatic creation of repositories (staff members only) ====
=== Automatic creation of repositories (staff members only) ===


It is simply a matter of pushing the repository to a special URL containing the login, like this:
It is simply a matter of pushing the repository to a special URL containing the login, like this:
Line 32: Line 39:
This will create a new repository called «whatever» (if it does not exist yet) and push the current HEAD to it. It also makes this repository the default for pushing and pulling (this is what --set-upstream does).
This will create a new repository called «whatever» (if it does not exist yet) and push the current HEAD to it. It also makes this repository the default for pushing and pulling (this is what --set-upstream does).


If you want to set a [https://rtime.felk.cvut.cz/gitweb/orte.git Gitweb description] for repositories created this way, use gitolite's getdesc/setdesc commands. I.e. you can set the description by:
Such repository is by default accessible only to the creator. If you want this repository to be public, run
  echo "Description" | ssh git@rtime.felk.cvut.cz setdesc «login»/«whatever»
  ssh git@rtime.felk.cvut.cz perms «login»/«whatever» + READERS @all


=== Accessing the repository ===
If you want to set a [https://rtime.felk.cvut.cz/gitweb/orte.git Gitweb description] for public repositories created this way, use gitolite's desc commands. I.e. you can set the description by:
ssh git@rtime.felk.cvut.cz desc «login»/«whatever» "Description"
 
== Accessing the repository ==


After [[Git#Install_Git|installing Git]] on your local computer, you
After [[Git#Install_Git|installing Git]] on your local computer, you
can access the repository as follows.
can access the repository as follows.


==== Cloning the repository ====
=== Cloning the repository ===


Read/Write access (for users with registered SSH key):
Read/Write access (for users with registered SSH key):
Line 47: Line 57:
Read-only access (for public repositories only):
Read-only access (for public repositories only):
  git clone git://rtime.felk.cvut.cz/''repo-name''.git
  git clone git://rtime.felk.cvut.cz/''repo-name''.git
git clone http://rtime.felk.cvut.cz/git/''repo-name''.git


==== First push ====
=== First push to admin-created repositories ===


After an empty repository is created either by admin or by you (automatic), you can push (i.e. upload) the data to it:
After an empty repository is created by the admin, you can push (i.e. upload) the data to it:


* [[#Cloning the repository|Clone]] the empty repository.
* [[#Cloning the repository|Clone]] the empty repository.
Line 59: Line 70:
  git push
  git push


==== Pushing to non-master branches ====
=== Pushing to non-master branches ===


If you are not allowed to push to the master branch but to a different one, you have to push like this:
If you are not allowed to push to the master branch but to a different one, you have to push like this:
  git push origin master:your-branch
  git push origin master:your-branch
which pushes your local master branch to the remote your-branch
which pushes your local master branch to the remote branch ''your-branch''.


To make this behavior default run
To make this behavior default run
Line 71: Line 82:
  git push
  git push


=== Managing central repositories ===
== Managing repositories ==


==== Finding available repositories ====
=== Finding available repositories ===


You can find the list of repositories you have access to by running:
You can find the list of repositories you have access to by running:
Line 81: Line 92:
where filter is optional string used to filter the list.
where filter is optional string used to filter the list.


It there are wildcard (automatic) repositories, as in the example below, you will only see the wildcard pattern and not the created repositories.
=== Permissions to automatic repositories ===
 
  C  R  W      fpga/[a-zA-Z0-9].*
 
To expand the wildcards, use the command <tt>expand</tt> instead of info. This command is a way slower than info command!
 
ssh git@rtime.felk.cvut.cz expand
ssh git@rtime.felk.cvut.cz expand fpga
 
==== Permissions to automatic repositories ====
 
The owners of automatically created repositories can manage the access permissions by themselves:
cat > perms
READERS pepa franta
WRITERS kerel lojza
(hit ctrl-d here)
ssh git@rtime.felk.cvut.cz setperms «login»/«whatever» < myperms
 
The current permissions can be viewed by
 
ssh git@rtime.felk.cvut.cz getperms «login»/«whatever»
 
More information can be found in [https://github.com/sitaramc/gitolite/blob/master/doc/wildcard-repositories.mkd#_handing_out_rights_to_wildcard_matched_repos Gitolite manual].
 
To allow public access and listing on [http://rtime.felk.cvut.cz/gitweb/ gitweb] page use the following command sequence:


  ssh git@rtime.felk.cvut.cz getperms ''repo-name'' > perms
The owners of automatically created repositories can manage the access permissions by themselves.
  echo "READERS @all" >> perms
  ssh git@rtime.felk.cvut.cz setperms ''repo-name'' < perms


[https://rtime.felk.cvut.cz/gitweb/sojka/gl-perm.git/blob/refs/heads/master:/gl-perm This script] can be used to make permission management easier.
The current permissions can be listed by:


== Contributing to other projects ==
ssh git@rtime.felk.cvut.cz perms -l «repo»


=== Using personal repository to contribute to other projects ===
You can add permissions for either reading of writing the repo with:
ssh git@rtime.felk.cvut.cz perms «repo» + READERS «login»
ssh git@rtime.felk.cvut.cz perms «repo» + WRITERS «login»


If you do not have write access to the repository of some project (not necessarily a central repository on this server), you can work in your personal repository then ask somebody with write access to merge your changes.
The permissions can be removed by replacing '''+''' with '''-'''.


# Clone a central repository <pre>git clone git://rtime.felk.cvut.cz/project.git</pre>
To make your repository visible on [https://rtime.felk.cvut.cz/gitweb/ gitweb], run:
# Add your rtime personal repository as remote (using SSH access) <pre>git remote add personal yourlogin@rtime.felk.cvut.cz:myproject.git</pre>
ssh git@rtime.felk.cvut.cz perms «repo» + READERS @all
# Edit files in project...
# Commit your changes <pre>git commit ...</pre>
# Push your changes to your personal repository <pre>git push personal</pre>
# Write email to somebody with write access to merge changes in <tt>git://rtime.felk.cvut.cz/~''yourlogin''/''myproject''.git</tt>


== Links to git related documents ==
== Links to git related documents ==

Latest revision as of 13:54, 12 April 2019

Repositories on rtime server are managed by Gitolite tool, which allows to conveniently manage repository permissions. World readable repositories can be browsed online.

In addition to gitolite repositories, users with shell account can create Git repositories in their home directory. This does not require any coordination with the administrator.

Getting write access to repositories

Write access to the repositories can only be given to users who send the following information to the administrator:

  1. OpenSSH public key
  2. Login name (for ČVUT people) or email address (for others).

SSH key creation

The SSH key can be created with one of the following ways. Note that under Windows, methods 1 and 2 only work if OpenSSH has been selected during Git installation.

  1. Under Linux/Unix (or in Git Bash under Windows) run:
    ssh-keygen
  2. In Git Gui (under Linux or Windows) choose Help -> Show SSH key -> Generate key.
  3. Under Windows use PuTTYgen. Use this if you have chosen to use Plink during Git installation.

It is stored by default at ~/.ssh/id_rsa.pub.

Password-protected keys

During the key creation you will be asked for a passphrase. If you do not specify any passphrase, anybody with access to your ~/.ssh directory could access your repositories. If you specify the passphrase, it will need to be entered whenever you want to push to or pull from the server. By using ssh-add command (or Pageant program under Windows) you can specify the passphrase only once and the decrypted key will be remembered in the memory.

Creating repositories

There are two ways how a repository can be created:

  1. Send an email to the administrator with the name of the repository, a short description and a list of people (login or email) who should have access to the repository. The administrator creates the repository for you and notifies you when it's done.
  2. Our group staff members can create their repositories without asking the administrator. See below.

Automatic creation of repositories (staff members only)

It is simply a matter of pushing the repository to a special URL containing the login, like this:

git push --set-upstream ssh://git@rtime.felk.cvut.cz/«login»/«whatever» HEAD

This will create a new repository called «whatever» (if it does not exist yet) and push the current HEAD to it. It also makes this repository the default for pushing and pulling (this is what --set-upstream does).

Such repository is by default accessible only to the creator. If you want this repository to be public, run

ssh git@rtime.felk.cvut.cz perms «login»/«whatever» + READERS @all

If you want to set a Gitweb description for public repositories created this way, use gitolite's desc commands. I.e. you can set the description by:

ssh git@rtime.felk.cvut.cz desc «login»/«whatever» "Description"

Accessing the repository

After installing Git on your local computer, you can access the repository as follows.

Cloning the repository

Read/Write access (for users with registered SSH key):

git clone ssh://git@rtime.felk.cvut.cz/repo-name

Read-only access (for public repositories only):

git clone git://rtime.felk.cvut.cz/repo-name.git
git clone http://rtime.felk.cvut.cz/git/repo-name.git

First push to admin-created repositories

After an empty repository is created by the admin, you can push (i.e. upload) the data to it:

  • Clone the empty repository.
  • Put your sources into your cloned repository
git add .             # tells git to track all files in your project
git commit            # commits the added files to the repository
  • Push your sources to the server
git push

Pushing to non-master branches

If you are not allowed to push to the master branch but to a different one, you have to push like this:

git push origin master:your-branch

which pushes your local master branch to the remote branch your-branch.

To make this behavior default run

git config remote.origin.push master:your-branch

And from now on, it is sufficient to run only

git push

Managing repositories

Finding available repositories

You can find the list of repositories you have access to by running:

ssh git@rtime.felk.cvut.cz info [filter]

where filter is optional string used to filter the list.

Permissions to automatic repositories

The owners of automatically created repositories can manage the access permissions by themselves.

The current permissions can be listed by:

ssh git@rtime.felk.cvut.cz perms -l «repo»

You can add permissions for either reading of writing the repo with:

ssh git@rtime.felk.cvut.cz perms «repo» + READERS «login»
ssh git@rtime.felk.cvut.cz perms «repo» + WRITERS «login»

The permissions can be removed by replacing + with -.

To make your repository visible on gitweb, run:

ssh git@rtime.felk.cvut.cz perms «repo» + READERS @all

Links to git related documents