Infrastructure/fedorapeople.org

From FedoraProject

< Infrastructure(Difference between revisions)
Jump to: navigation, search
(gitweb is gone, cgit.)
(37 intermediate revisions by 19 users not shown)
Line 1: Line 1:
 +
{{autolang|base=yes}}
 +
 
= fedorapeople.org =
 
= fedorapeople.org =
  
Line 5: Line 7:
 
contributors can upload files for sharing out with the world. It is
 
contributors can upload files for sharing out with the world. It is
 
perfect for uploading specfiles, srpms, patches, personal repository etc, etc.
 
perfect for uploading specfiles, srpms, patches, personal repository etc, etc.
 +
 +
== Allowable content ==
 +
 +
* Do not distribute anything on fedorapeople.org that Fedora itself cannot distribute for legal reasons. Nothing on the [http://fedoraproject.org/wiki/ForbiddenItems ForbiddenItems] list or otherwise non distributable by Fedora.
 +
* Do not upload your private .ssh keys. While Fedora IT works hard on keeping the servers secure, break ins will happen and private keys uploaded can be downloaded and brute-forced easily these days. Private .ssh keys if found during an audit will be deleted.
  
 
== Accessing Your fedorapeople.org Space ==
 
== Accessing Your fedorapeople.org Space ==
Line 10: Line 17:
 
# You need an active [https://admin.fedoraproject.org/accounts/ Fedora account]
 
# You need an active [https://admin.fedoraproject.org/accounts/ Fedora account]
 
# You must be sponsored in a group (other than the CLA groups)
 
# You must be sponsored in a group (other than the CLA groups)
# You need to generate a ssh key (ssh-keygen -t rsa) upload that ssh key into your Fedora account. The ssh key gets activated an hour after you upload it.
+
# You need to generate a ssh key (ssh-keygen -t rsa).
# To connect, use the ssh key you uploaded into your Fedora account:
+
# Upload that ssh key into your Fedora account. To upload, [https://admin.fedoraproject.org/accounts/user/edit visit this link] and select your key file using the ''Public RSA SSH key'' field. Normally your key is stored in your home directory under ''.ssh/id_rsa.pub''. The ssh key gets activated an hour after you upload it.
 +
# To connect, use the ssh key you uploaded into your Fedora account:<pre>ssh -i ~/.ssh/id_rsa <your_fedora_id>@fedorapeople.org</pre>
  
<pre>
+
This step can also be done via [https://admin.fedoraproject.org/accounts/ Fedora account.]
ssh your_fedora_username@fedorapeople.org
+
 
</pre>
+
# While logged in, click on "My Account" on the side bar.
 +
# Select "edit" link next to "Account Details."
 +
# Type the following in the "Public RSA SSH Key:" field:<pre>~/.ssh/id_rsa.pub</pre>
 +
# Click the "Save!" button.
 +
# Verify your success. You will see "ssh-rsa" followed by alpha numeric string in "Public SSH Key:" field of your Account Details.
  
 
== Common Answers ==
 
== Common Answers ==
  
* Each Fedora contributor has 150 MiB of quota-controlled space.
+
* Each Fedora contributor has 2000000 KiB (approximately 1954 MiB) of quota-controlled space.
 +
* If you run out of space you should: clean up stuff you don't need. If you cannot clean up anything then you should contact fedora infrastructure to raise your quota.
 
* To make a publicly viewable space, create a <code>public_html</code> directory.
 
* To make a publicly viewable space, create a <code>public_html</code> directory.
 +
* Fedora people is NOT to be used for development or creating repositories on. Repositories will need to be created elsewhere and uploaded via scp or rsync.
 +
* DO NOT try to use sudo to install packages you "need." Unless you are in the Infrastructure group, and have gotten approval from sysadmin-main, extra packages are not to be installed on fedorapeople.
 
* Upload files using scp, sftp, or rsync.
 
* Upload files using scp, sftp, or rsync.
 
{{admon/tip | Using Nautilus | If you use GNOME, visit [[Infrastructure/fedorapeople.org/Connecting_with_Nautilus | this page]] for an easy way to connect to your fedorapeople.org space.}}
 
{{admon/tip | Using Nautilus | If you use GNOME, visit [[Infrastructure/fedorapeople.org/Connecting_with_Nautilus | this page]] for an easy way to connect to your fedorapeople.org space.}}
  
 
{{admon/tip | Using Dolphin or Konqueror | If you use KDE, type <code>sftp://your_username@fedorapeople.org</code> in your file manager address bar for an easy way to connect to your fedorapeople.org space.}}
 
{{admon/tip | Using Dolphin or Konqueror | If you use KDE, type <code>sftp://your_username@fedorapeople.org</code> in your file manager address bar for an easy way to connect to your fedorapeople.org space.}}
 +
 +
{{admon/tip | Using Thunar | If you use XFCE, type <code>ctrl+l</code> to bring up the Open Location Dialogue and then enter <code>sftp://your_username@fedorapeople.org/home/fedora/your_username</code> in Location field for an easy way to connect to your fedorapeople.org space. PCManFM also works}}
  
 
To copy files from the command line, you can use scp
 
To copy files from the command line, you can use scp
Line 38: Line 55:
 
<pre>setfacl -m u:jkeating:rw file</pre>
 
<pre>setfacl -m u:jkeating:rw file</pre>
  
== ''BETA'' git hosting support ==
+
== fedora people git hosting support ==
  
fedorapeople.org now has support for hosting git repositories including accessing them via the git:// protocol for anonymous downloads as well as providing gitweb. ''This should be considered beta.''
+
fedorapeople.org now has support for hosting git repositories including accessing them via the git:// protocol for anonymous downloads as well as providing the cgit web interface.  
  
Here is a quick rundown of how to get started using git on fedorapeople.org.  It assumes that you are already somewhat familiar with git.  You might want to take a look at [[Git Quickref|a quick reference to git]].
+
Here is a quick rundown of how to get started using git on fedorapeople.org.  It assumes that you are already somewhat familiar with git.  You might want to take a look at the [[Git quick reference]].
  
 
=== Create a <code>~/public_git</code> directory on fedorapeople.org ===
 
=== Create a <code>~/public_git</code> directory on fedorapeople.org ===
  
<pre>ssh your_fedora_username@fedorapeople.org "mkdir ~/public_git"</pre>
+
<pre>ssh your_fedora_username@fedorapeople.org "mkdir ~/public_git; /sbin/restorecon -Rv ~/public_git"</pre>
 
+
  
 
=== Creating a new git repository in <code>~/public_git</code> ===
 
=== Creating a new git repository in <code>~/public_git</code> ===
Line 54: Line 70:
  
 
<pre>
 
<pre>
mkdir repo.git
+
git init --bare repo.git
cd repo.git
+
scp -r repo.git/ your_fedora_username@fedorapeople.org:~/public_git/
git init --bare
+
touch git-daemon-export-ok
+
cd ..
+
scp -r repo.git your_fedora_username@fedorapeople.org:public_git/
+
 
</pre>
 
</pre>
  
 
This creates a ''bare'' repository (i.e. a repository that has no working directory).  It contains just the files that are part of the <code>.git</code> directory of a ''non-bare'' git repository (the kind most users are accustomed to seeing).
 
This creates a ''bare'' repository (i.e. a repository that has no working directory).  It contains just the files that are part of the <code>.git</code> directory of a ''non-bare'' git repository (the kind most users are accustomed to seeing).
  
 +
{{admon/important|Repository name must end with .git|cgit will not list repos that do not end in <code>.git</code>.|}}
  
{{admon/important|Repository name must end with .git|Gitweb will not list repos that do not end in <code>.git</code>.|}}
+
Additionally if you wish your repository to show up in the cgit web interface, you must:
  
{{admon/important|Repository access and git-daemon-export-ok|Without the <code>git-daemon-export-ok</code> file, your repository won't be available anonymously via the git:// protocol.}}
+
<pre>
 
+
touch ~/public_git/yourgitrepo.git/git-daemon-export-ok
{{admon/caution|Non-bare repositories|While non-bare repositories ''should'' work, it is [http://git.or.cz/gitwiki/GitFaq#git-push%20non-bare generally discouraged] to push to such repositories.  However, if you do use a non-bare repository, you should place the git-daemon-export-ok file in the top-level git dir, e.g. <code>~/public_git/your_repo.git/git-daemon-export-ok</code>, '''NOT''' <code>~/public_git/your_repo.git/.git/git-daemon-export-ok</code>}}
+
</pre>
  
 +
For any repositories you wish to appear there by default.
  
 
=== Uploading an existing repository to <code>~/public_git</code> ===
 
=== Uploading an existing repository to <code>~/public_git</code> ===
Line 78: Line 92:
 
<pre>
 
<pre>
 
git clone --bare /path/to/local/repo repo.git
 
git clone --bare /path/to/local/repo repo.git
touch repo.git/git-daemon-export-ok
+
scp -r repo.git/ your_fedora_username@fedorapeople.org:public_git/
scp -r repo.git your_fedora_username@fedorapeople.org:public_git/
+
 
</pre>
 
</pre>
  
 
The caveats from the previous section apply here as well.
 
The caveats from the previous section apply here as well.
 
  
 
=== Pushing to your repository ===
 
=== Pushing to your repository ===
Line 115: Line 127:
  
 
<pre>
 
<pre>
ssh ~your_fedora_username@fedorapeople.org
+
ssh your_fedora_username@fedorapeople.org
 
cd ~/public_git/repo.git/hooks
 
cd ~/public_git/repo.git/hooks
ln -svbf /usr/bin/git-update-server-info post-update
+
ln -svbf $(git --exec-path)/git-update-server-info post-update
 +
git update-server-info
 
</pre>
 
</pre>
  
Line 135: Line 148:
  
 
{{admon/tip|git:// versus http://|Only clone via http:// if you are behind a firewall that prevents git:// from working.  The git:// protocol is faster and more efficient than the http:// protocol for git usage.}}
 
{{admon/tip|git:// versus http://|Only clone via http:// if you are behind a firewall that prevents git:// from working.  The git:// protocol is faster and more efficient than the http:// protocol for git usage.}}
 +
 +
=== Browsing your project via cgit ===
 +
 +
You can see your project listed in [http://fedorapeople.org/cgit cgit] once the project list updates.  This happens hourly. 
  
  
=== Browsing your project via gitweb ===
+
{{admon/tip|Repository description|You can set the description for the repository that is displayed in cgit by editing the <code>description</code> file in your repository.}}
  
You can see your project listed in [http://fedorapeople.org/gitweb gitweb] once the project list updates.  This happens hourly.  ''Note that the gitweb URL may change.''
+
=== Shared repository ===
  
 +
If you want to give access to your repository to other users you can do this with ACLs.
  
{{admon/tip|Repository description|You can set the description for the repository that is displayed in gitweb by editing the description file in your repository.}}
+
  setfacl -R -m u:<user>:rwX <repo.git>
 +
  find <repo.git> -type d | xargs setfacl -R -m d:u:<user>:rwX
  
 
[[Category:Infrastructure]]
 
[[Category:Infrastructure]]

Revision as of 22:35, 1 August 2012

Contents

fedorapeople.org

This page covers the details on how to obtain and use your personal space on fedorapeople.org , which is a site where Fedora contributors can upload files for sharing out with the world. It is perfect for uploading specfiles, srpms, patches, personal repository etc, etc.

Allowable content

  • Do not distribute anything on fedorapeople.org that Fedora itself cannot distribute for legal reasons. Nothing on the ForbiddenItems list or otherwise non distributable by Fedora.
  • Do not upload your private .ssh keys. While Fedora IT works hard on keeping the servers secure, break ins will happen and private keys uploaded can be downloaded and brute-forced easily these days. Private .ssh keys if found during an audit will be deleted.

Accessing Your fedorapeople.org Space

  1. You need an active Fedora account
  2. You must be sponsored in a group (other than the CLA groups)
  3. You need to generate a ssh key (ssh-keygen -t rsa).
  4. Upload that ssh key into your Fedora account. To upload, visit this link and select your key file using the Public RSA SSH key field. Normally your key is stored in your home directory under .ssh/id_rsa.pub. The ssh key gets activated an hour after you upload it.
  5. To connect, use the ssh key you uploaded into your Fedora account:
    ssh -i ~/.ssh/id_rsa <your_fedora_id>@fedorapeople.org

This step can also be done via Fedora account.

  1. While logged in, click on "My Account" on the side bar.
  2. Select "edit" link next to "Account Details."
  3. Type the following in the "Public RSA SSH Key:" field:
    ~/.ssh/id_rsa.pub
  4. Click the "Save!" button.
  5. Verify your success. You will see "ssh-rsa" followed by alpha numeric string in "Public SSH Key:" field of your Account Details.

Common Answers

  • Each Fedora contributor has 2000000 KiB (approximately 1954 MiB) of quota-controlled space.
  • If you run out of space you should: clean up stuff you don't need. If you cannot clean up anything then you should contact fedora infrastructure to raise your quota.
  • To make a publicly viewable space, create a public_html directory.
  • Fedora people is NOT to be used for development or creating repositories on. Repositories will need to be created elsewhere and uploaded via scp or rsync.
  • DO NOT try to use sudo to install packages you "need." Unless you are in the Infrastructure group, and have gotten approval from sysadmin-main, extra packages are not to be installed on fedorapeople.
  • Upload files using scp, sftp, or rsync.
Idea.png
Using Nautilus
If you use GNOME, visit this page for an easy way to connect to your fedorapeople.org space.
Idea.png
Using Dolphin or Konqueror
If you use KDE, type sftp://your_username@fedorapeople.org in your file manager address bar for an easy way to connect to your fedorapeople.org space.
Idea.png
Using Thunar
If you use XFCE, type ctrl+l to bring up the Open Location Dialogue and then enter sftp://your_username@fedorapeople.org/home/fedora/your_username in Location field for an easy way to connect to your fedorapeople.org space. PCManFM also works

To copy files from the command line, you can use scp

scp /path/to/file your_fedora_username@fedorapeople.org:/home/fedora/your_fedora_username/public_html


  • Once uploaded into the users public_html directory the files are available via http at: http://your_username.fedorapeople.org/.
  • Give other users access to read/write/etc files by using extended acls. Read man pages for setfacl and getfacl for adding them to your dirs/files. This gives the user jkeating read and write access to file:
setfacl -m u:jkeating:rw file

fedora people git hosting support

fedorapeople.org now has support for hosting git repositories including accessing them via the git:// protocol for anonymous downloads as well as providing the cgit web interface.

Here is a quick rundown of how to get started using git on fedorapeople.org. It assumes that you are already somewhat familiar with git. You might want to take a look at the Git quick reference.

Create a ~/public_git directory on fedorapeople.org

ssh your_fedora_username@fedorapeople.org "mkdir ~/public_git; /sbin/restorecon -Rv ~/public_git"

Creating a new git repository in ~/public_git

As an example, here is one method to create an empty repository on your local system and upload it:

git init --bare repo.git
scp -r repo.git/ your_fedora_username@fedorapeople.org:~/public_git/

This creates a bare repository (i.e. a repository that has no working directory). It contains just the files that are part of the .git directory of a non-bare git repository (the kind most users are accustomed to seeing).

Important.png
Repository name must end with .git
cgit will not list repos that do not end in .git.

Additionally if you wish your repository to show up in the cgit web interface, you must:

touch ~/public_git/yourgitrepo.git/git-daemon-export-ok

For any repositories you wish to appear there by default.

Uploading an existing repository to ~/public_git

If you have an existing repository you want to use on fedorapeople, you can do so easily:

git clone --bare /path/to/local/repo repo.git
scp -r repo.git/ your_fedora_username@fedorapeople.org:public_git/

The caveats from the previous section apply here as well.

Pushing to your repository

To push changes from a local repository:

cd /path/to/local/repo
git remote add fedorapeople your_fedora_username@fedorapeople.org:public_git/repo.git
git push --mirror fedorapeople

This creates a mirror of your local repository. All of the branches and tags in the local repository will be pushed to the fedorapeople repository.

If you only want to push selected branches, amend the git push example. For example, to push only your local master branch:

git push fedorapeople master


Idea.png
Allowing others to push
You can allow other fedorapeople.org users to push to your repository using extended acls (see setfacl(1) for details). However, if you have many others working on your project, using Fedora Hosted is strongly preferred.


Cloning your repository

To clone your repository, use a command similar to:

git clone git://fedorapeople.org/~your_fedora_username/repo.git


It is also possible to clone your project via the http:// protocol. In order for this to work, you must arrange to have git-update-server-info run whenever you update your repository. Typically, this is done with a post-update hook script. However, the user home directories on fedorapeople.org are mounted with the noexec option, which prevents the script from running. Instead, you may create a symbolic link to git-update-server-info in the hooks directory of your repository:

ssh your_fedora_username@fedorapeople.org
cd ~/public_git/repo.git/hooks
ln -svbf $(git --exec-path)/git-update-server-info post-update
git update-server-info


You also need to create a link from ~/public_html/git to ~/public_git:

cd ~/public_html
ln -svbf ../public_git git


You can clone your repository over http:// with a command similar to:

git clone http://your_fedora_username.fedorapeople.org/git/repo.git/


Idea.png
git:// versus http://
Only clone via http:// if you are behind a firewall that prevents git:// from working. The git:// protocol is faster and more efficient than the http:// protocol for git usage.

Browsing your project via cgit

You can see your project listed in cgit once the project list updates. This happens hourly.


Idea.png
Repository description
You can set the description for the repository that is displayed in cgit by editing the description file in your repository.

Shared repository

If you want to give access to your repository to other users you can do this with ACLs.

 setfacl -R -m u:<user>:rwX <repo.git>
 find <repo.git> -type d | xargs setfacl -R -m d:u:<user>:rwX