Important: You are required to change your passwords used for Gentoo services and set an email address for your Wiki account if you haven't done so. See the full announcement and Wiki email policy change for more information.

Project:Infrastructure/Developer Webspace

From Gentoo Wiki
< Project:Infrastructure
Revision as of 14:57, 2 November 2013 by A3li (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

This guide documents how a Gentoo developer can configure their personal webspace on our dev cluster.

Developer Web Space

Use and Policy

Within your devspace on woodpecker (dev.gentoo.org) you may create a public_html directory accessible at: http://dev.gentoo.org/~username . You may store any Gentoo related files in this space such as project documentation, ebuilds/packages you are testing, etc... Please note that you should not store distfiles for public distribution in this space only for distribution to other developers/testers. Packages for public distribution should be put on the distfiles mirror.

Your dev space is for Gentoo related files. You may not host files for your company/home business, pornography or any file that is considered illegal in the United States (woodpecker is located in the USA). Pages in your public_html folder are viewable by the world and their contents should follow the same rules. You may not use your dev space to make money in any way. This includes banner swapping, auctions (or hosting images for your auctions) or google ads. As usual, common sense should apply.

If any files in your space are found to be harmful towards other developers or users on the box or pose a risk to the Gentoo project (such as illegal torrents, pornography, etc...), Gentoo Infrastructure will suspend your account which will only be unlocked after investigation from Gentoo Developer Relations. In most cases, your developership will be suspended if such files are found. If you are unsure of the impact a file may have on another developer or Gentoo in general please ask your Mentor or someone else appropriate to review it for you.

Uploading Files

If your recruiter didn't set up the public_html directory for you go ahead and do it yourself like this:

CodeCreate public_html

username@homebox ~$ ssh $USERNAME@dev.gentoo.org
Enter passphrase for key '/home/username/.ssh/id_rsa':(Enter your passphrase)

username@woodpecker home$ cd ~/$USERNAME
username@woodpecker ~$ mkdir public_html
username@woodpecker ~$ chmod -R 755 public_html
username@woodpecker ~$ echo "Options Indexes" > public_html/.htaccess(to enable dir indexing if desired)

The Infrastructure Project does not make backups of developer files. You are responsible for making backups of any and all files contained in your developer space. I suggest creating a mirror on your local box: ~/devspace.

Now copy your files using scp or rsync.

CodeSecure Copy with scp

username@homebox devspace$ scp index.htm $USERNAME@dev.gentoo.org:~/public_html
Enter passphrase for key '/home/$USERNAME/.ssh/id_rsa': (Enter yoru passphrase)
CodeSecure Copy with rsync

$ rsync -ruav -e ssh ~/devspace $USER@dev.gentoo.org:~/
Enter passphrase for key '/home/$USERNAME/.ssh/id_rsa': (Enter your passphrase)

Supported Languages

dev.gentoo.org has HTML, SHTML, XML and PHP available for you to write your web pages.

XML uses the same XSL and gorg from www.gentoo.org. This allows you to write your documentation in the official guideXML specification for inclusion on the www.gentoo.org website. All documents on the official website are in this format.

Note
To remove gorg as the .xml handler add the following to your .htaccess file in your public_html directory: RemoveHandler .xml

Resources

Acknowledgements

We would like to thank the following authors and editors for their contributions to this guide:

  • Jeffrey Forman
  • Curtis Napier