welcome: please sign in

Diff for "MemberManual"

Differences between revisions 3 and 16 (spanning 13 versions)
Revision 3 as of 2007-10-20 19:08:03
Size: 2643
Editor: MichaelOlson
Comment: Flesh out
Revision 16 as of 2007-11-01 19:53:15
Size: 1746
Editor: MichaelOlson
Comment: Update Email link
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
#pragma section-numbers off
Line 3: Line 5:
It is a work in progress, so don't expect complete content yet. ''This a work in progress, so don't expect complete content yet.''
Line 5: Line 7:
[[TableOfContents]] ||<25%>'''~+[:/MigrationGuide:Migration Guide]+~''' ||<1%> ||<74%> Steps for migrating from the old HCoop server to the new setup. New members may skip this. ||
||<25%>'''~+[:/GettingStarted:Getting Started]+~''' ||<1%> ||<74%> Things that new and current members must know about HCoop's setup. It is considered '''required reading''' before contacting HCoop administrators or filing support requests. ||
|| ~+[:/UsingDomtool:Using Domtool]+~ || || The bare minimum that you need to know concerning our use of DomTool. ||
|| ~+[:/TransferringFiles:Transferring Files]+~ || || How to transfer files to your home directory, which is kept in AFS. ||
|| ~+[:/Email:Email]+~ || || How to receive and manage your email. ||
|| ~+[:/ServingWebsites:Serving Websites]+~ || || How to serve your website(s). ||
|| ~+[:/Databases:Databases]+~ || || Using PostgreSQL and MySQL databases. ||
|| ~+[:/RunningUnattendedCommands:Running Unattended Commands]+~ || || In general, how to run unattended commands (such as custom daemons or commands called from cron scripts) from your AFS home directory. ||
|| ~+[:/UsingCron:Using cron]+~ || || How to use cron to run command periodically. ||
|| ~+[:/VersionControl:Version Control]+~ || || How to use version control software to host code on HCoop servers. ||
Line 7: Line 18:
'''All sections should be in their own subpage. Example: ["MemberManual/GettingStarted"].''' === Pages that should be in the manual ===
Line 9: Line 20:
= Getting started =

This entire section is required reading for both old and new members.

 * How to indicate that you would like to join HCoop.
 * We use AFS.
   * It's a bit different than standard UNIX file permissions. Allows for granular control of access, and ability to access your files from any machine that has an AFS/Kerberos client.
 * We use DomTool.
   * It is a fairly unique approach to sharing access to a machine. It facilitates DNS, email, and web serving, provided that you have a domain.
 * Reporting problems.
   * Report issues with Bugzilla.
   * Request domains with the portal.
 * Logging in.
   * Explain that normal ssh will work fine.
   * Explain that access to files can expire, and how to renew access with kinit and aklog. Explain "ticket".
   * How to install AFS/Kerberos clients on your home computer, for easier access. How to make tickets last longer. How to make tickets automatically renew.
 * Security goals.
   * Control public access to your files. Your publicly readable files are accessible outside HCoop via AFS (maybe ... need to look into more)
   * Mention denyhosts.

= Using DomTool =

 * Write to ~/.domtool. Explain how to make public or private.
 * Explain how to add a domain. In particular, an example, with content then annotated below. Point to relevant DomTool subpage for more.
 * Explain how to remove a domain.

= Copying files =

 * Using rsync.
 * Using scp.
 * Mounting AFS on your local system.

= Email delivery =

 * Domtool part.
 * {{{~/.public/.forward}}}.
 * {{{~/.procmail.d/procmailrc}}}.
 * Virtual mailboxes.
 * Filtering spam.

= Serving Web pages =

 * Static sites on deleuze. (Note to self: ask Adam C. if people can point domain names at deleuze, and subdomains at mire. I'd like to do that, myself.)
 * Serving dynamic content on mire.
 * Accessing read-only site-wide DAV. Also, enabling site-specific DAV so that you can use it for writing. Link to "Using revision control -> DAV and Subversion example",

= Using cron =

= Running custom daemons =

= Using revision control =

 * Example of sitewide git. We'll keep this even if we decide against managing the domtool stuff with it.
 * DAV and subversion for a particular site.
 * Does sitewide Mercurial make sense?
If you know that some pages should be in the manual, but don't know where to place them, please list them here, and MichaelOlson will classify them later on.

This is the HCoop Member Manual. It will tell you all you need to know about using HCoop services and participating in the co-op.

This a work in progress, so don't expect complete content yet.

[:/MigrationGuide:Migration Guide]

Steps for migrating from the old HCoop server to the new setup. New members may skip this.

[:/GettingStarted:Getting Started]

Things that new and current members must know about HCoop's setup. It is considered required reading before contacting HCoop administrators or filing support requests.

[:/UsingDomtool:Using Domtool]

The bare minimum that you need to know concerning our use of DomTool.

[:/TransferringFiles:Transferring Files]

How to transfer files to your home directory, which is kept in AFS.

[:/Email:Email]

How to receive and manage your email.

[:/ServingWebsites:Serving Websites]

How to serve your website(s).

[:/Databases:Databases]

Using PostgreSQL and MySQL databases.

[:/RunningUnattendedCommands:Running Unattended Commands]

In general, how to run unattended commands (such as custom daemons or commands called from cron scripts) from your AFS home directory.

[:/UsingCron:Using cron]

How to use cron to run command periodically.

[:/VersionControl:Version Control]

How to use version control software to host code on HCoop servers.

Pages that should be in the manual

If you know that some pages should be in the manual, but don't know where to place them, please list them here, and MichaelOlson will classify them later on.

MemberManual (last edited 2024-03-05 18:23:46 by 24)