
		   How to Set Up Your First Archive

Let's suppose you want to set up your own archive, with all the bells
and whistles enabled.

You should read over the user's guide on the topics of archive names,
archives, libraries, notifiers, and web browsers (some of that
documentation is more complete than others -- this README aims to fill
in some of the gaps).


* Pick an Archive Name

  For the examples here, I'll use the archive name:

	j.hacker@gnu.org--2002


* Pick a Location

  Decide where to store your archive.  In these instructions, you'll
  see how to create the archive, a revision library, a browser, and a
  notifier.  I suggest finding a location with plenty of disk space
  (if you have at least several gigabytes, you'll be unlikely to fill
  it up very soon).

  Let's suppose, just as a convenient short-hand that you'll store the
  archive and other directories in your home directory ("~/").

  If you want other people to be able to access your repository over
  the net, be sure to store it in a location that can be reached 
  with FTP.
 

* Create Your Archive

	% larch make-archive j.hacker@gnu.org--2002 ~/{archive}

  Note: the archive directory doesn't have to be named "{archive}".

  Verify that the directory has been created, and your list of
  registered archives updated:

	% larch archives
	j.hacker@gnu.org--2002
		/home/hacker/{archive}


* Make Your New Archive Your Default

	% larch my-default-archive j.hacker@gnu.org--2002

  and verify that with:

	% larch my-default-archive
	j.hacker@gnu.org--2002


* Create a Revision Library

  The revision library is where arch can store a forest of complete
  trees for each revision.  Enabling this feature optional, but
  strongly recommended (these trees are stored in a _reasonably_ space
  efficient manner, sharing unmodified files between revisions).

  There are several steps to creating your library.  The first is just
  to make a new directory for it:


	% mkdir ~/{revisions}

  Once again, the particular directory name doesn't matter.  If you
  want people to be able to browse your repository over the net -- a
  good idea if your archive is going to be remotely accessible -- then
  make sure that your revision library is in a location that can be
  accessed via HTTP.

  Next, inform `arch' of the location of your library:

	% larch my-revision-library ~/{revisions}

  and verify that:

	% larch my-revision-library
  	/home/hacker/{revisions}


* Create a Browser

  Setting up a browser is another optional but strongly recommended
  step.  Once again, for remote access, make sure the browser can be
  reached via HTTP.

  Create a directory:

	% mkdir ~/{browser}

  Copy the configuration files from the "browser" subdirectory where
  this README file is stored to your "{browser}" directory.  Read the
  comments in those files and edit them appropriately.  If you are 
  just getting started, you probably won't need to make any changes 
  to those files.

  
* Create a Notifier

  Finally, you want to make sure that the library and browser are
  automatically updated whenever you add new revisions to an archive. 
  You do that with a "notifier".

  Create a directory (as usual, the name doesn't matter):

	% mkdir ~/{notifier}

  Copy the configuration files from "notifier" in this directory
  to your new notifier, and edit them appropriately.

  Finally, tell `arch' where to find your notifier:

	% larch my-notifier ~/{notifier}

  and verify:

	% larch my-notifier
	/home/hacker/{notifier}

# tag: Tom Lord Tue Feb  5 14:37:11 2002 (examples/README.010.first-archive)
#
