1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
|
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)
#
|