Fix hashlib import
[darcsweb.git] / config.py.sample
blob6cebc3f4f5f87b8d7d99b025bb8aff9baac9cbc4
2 # base configuration, common to all repos
3 class base:
4         # location of the darcs logo
5         darcslogo = "darcs.png"
7         # location of the darcs favicon
8         darcsfav = "minidarcs.png"
10         # the CSS file to use
11         cssfile = 'style.css'
13         # this script's name, usually just "darcsweb.cgi" unless you rename
14         # it; if you leave this commented it will be detected automatically
15         #myname = "darcsweb.cgi"
17         # our url, used only to generate RSS links, without the script name;
18         # if you leave this commented it will be detected automatically
19         #myurl = "http://example.com/darcsweb"
21         # optionally, you can specify the path to the darcs executable; if you
22         # leave this commented, the one on $PATH will be used (this is
23         # normally what you want)
24         #darcspath = "/home/me/bin/"
26         # the text to appear in the top of repo list; this is also optional,
27         # and html-formatted
28         #summary = "I love darcs!"
30         # in case you want to change the beautiful default, you can specify an
31         # alternative footer here; it's optional, of course
32         #footer = "I don't like shoes"
34         # It is possible to have a cache where darcsweb will store the pages
35         # it generates; entries are automatically updated when the repository
36         # changes. This will speed things up significatively, specially for
37         # popular sites.
38         # It's recommended that you clean the directory with some regularity,
39         # to avoid having too many unused files. A simple rm will do just
40         # fine.
41         # If you leave the entry commented, no cache will be ever used;
42         # otherwise the directory is assumed to exist and be writeable.
43         # If you use this option you must set the "myname" and "myurl"
44         # variables.
45         #cachedir = '/tmp/darcsweb-cache'
47         # By default, darcsweb's search looks in the last 100 commits; you can
48         # change that number by specifying it here.
49         # Note that search are not cached, so if you have tons of commits and
50         # set the limit to a very high number, they will take time.
51         #searchlimit = 100
53         # If you want to log the times it took darcsweb to present a page,
54         # uncomment this option. The value should be a file writeable by
55         # darcsweb.
56         #logtimes = "/tmp/darcsweb_times"
58         # If you want darcsweb to automatically detect embedded URLs,
59         # define them here, using python-style regexps like the examples
60         # below. They will be replaced in summaries, logs, and commits.
61         # The following variables are replaced:
62         #   myreponame: repository link (darcsweb.cgi?r=repo)
63         #   reponame: repository name (repo)
64         #
65         #url_links = (
66           # Format is: (regexp, replacement)
67           # Some examples:
68           #
69           # Detect '#NNN' as a reference to bug database
70           #(r'#([0-9]+)',
71           #     r'<a href="/bugs/show_bug.cgi?id=\1">#\1</a>'),
72           #
73           # Replace hashes with commit-links.
74           #(r'(\d{14}-[0-9a-f]{5}-[0-9a-f]{40}\.gz)',
75           #     r'<a href="%(myreponame)s;a=commit;h=\1">\1</a>'),
76         #)
78         # If you want to generate links from patch author names, define the url
79         # here. Example for CIA:
80         #author_links = "http://cia.navi.cx/stats/author/%(author)s"
82         # If you want to disable the annotate feature (for performance reasons,
83         # the http connection will time out on slow machines), uncomment this
84         # option.
85         #disable_annotate = True
90 # From now on, every class is a repo configuration, with the same format
91 # There are no restrictions on the class' name, except that it can't be named
92 # "base" (because it's the name of the one above).
94 # If you have a lot of repos and/or you're too lazy to do this by hand, you
95 # can use the configuration generator that comes with darcsweb, called
96 # "mkconfig.py".
99 class repo1:
100         # the descriptive name
101         reponame = 'repo1'
103         # a brief description
104         repodesc = 'Example repository'
106         # the real path to the repository
107         repodir = '/usr/src/repo1'
109         # an url so people know where to do "darcs get" from
110         repourl = 'http://example.com/repos/repo1/'
112         # the encoding used in the repo
113         # NOTE: if you use utf8, you _must_ write 'utf8' (and not the variants
114         # like 'utf-8' or 'UTF8') if you expect darcsweb to work properly.
115         # This is because to workaround a bug in darcs we need to do some
116         # codec mangling and it needs special cases for UTF8.
117         # You can, optionally, specify multiple encodings; they're tried in
118         # order, and if one fails to decode a string, the next one is tried.
119         # Example: repoencoding = "utf8", "latin1"
120         repoencoding = "latin1"
122         # as with the base configuration, the footer is also optional, and it
123         # affects only this repository; if you don't specify, the one
124         # specified in base is used (and if you don't specify one there
125         # either, a default one is used)
126         #footer = "I don't like being cold"
128         # Each repository may show a link to some website associated with it.
129         # This is typically useful if you've got a website describing the
130         # software in your repository.
131         #repoprojurl = 'http://example.com/projects/repo1/'
134 class repo2:
135         reponame = 'repo2'
136         repodesc = 'Second example repository'
137         repodir = '/usr/src/repo2'
138         repourl = 'http://example.com/repos/repo2/'
139         repoencoding = 'latin1'
143 # If you have several repositories in a single directory and don't want to
144 # create a configuration entry for each one, you can use a "multidir" entry,
145 # which serves as a "template" for all the repositories in that directory.
146 # The name is taken from the directory, and inside the variables the string
147 # "%(name)s" gets expanded to the it. If displayname is set, "%(dname)s" gets
148 # expanded to it; otherwise it's the same as "%(name)s".
150 # If you set multidir_deep to True (note the capitalization) then all
151 # subdirectories are searched for darcs repositories. Subdirectories starting
152 # with a dot (.) are not searched. This may be slow, if huge directory trees
153 # must be searched. It's unnecesary unless you have a multidir with several
154 # nested repositories. It defaults to False, and it's optional.
157 class multi1:
158         multidir = '/usr/local/src'
159         #multidir_deep = False
160         repodesc = 'Repository for %(name)s'
161         repourl = 'http://example.com/repos/%(name)s/'
162         repoencoding = 'latin1'
164         # if you want to change the display name of the repositories (i.e. the
165         # name it will have on the listings, urls, etc.), you can set it here.
166         # You can use "%(name)s" expansion, see above.
167         #displayname = "local/%(name)s"
169         # optional, see above
170         #repoprojurl = 'http://example.com/projects/%(name)s/'
172         # if you want to exclude some directories, add them to this list (note
173         # they're relative to multidir, not absolute)
174         #exclude = 'dir1', 'dir2'
176         # if you want the descriptions to be picked up automatically from the
177         # file named "_darcs/third_party/darcsweb/desc" (one line only), set
178         # this to True. It defaults to False
179         #autodesc = True
181         # if you want to exclude all the repositories which do NOT have a
182         # directory named "_darcs/third_party/darcsweb/" inside, set this to
183         # True. It defaults to False.
184         #autoexclude = True
186         # if you want urls to be picked up automatically from the file named
187         # "_darcs/third_party/darcsweb/url" (one line only), set this to
188         # True. It defaults to False.
189         #autourl = True
191         # if you want the projects urls to be picked up automatically from the
192         # file named "_darcs/third_party/darcsweb/projurl" (one line only), set
193         # this to True. It defaults to False.
194         #autoprojurl = True