upstream/mercurial-mirror Commit - r17333:ba36e771

1

Mercurial's internal web server, hgweb, can serve either a single

1

Mercurial's internal web server, hgweb, can serve either a single

2

repository, or a tree of repositories. In the second case, repository

2

repository, or a tree of repositories. In the second case, repository

3

paths and global options can be defined using a dedicated

3

paths and global options can be defined using a dedicated

4

configuration file common to :hg:`serve`, ``hgweb.wsgi``,

4

configuration file common to :hg:`serve`, ``hgweb.wsgi``,

5

``hgweb.cgi`` and ``hgweb.fcgi``.

5

``hgweb.cgi`` and ``hgweb.fcgi``.

6

7

This file uses the same syntax as other Mercurial configuration files

7

This file uses the same syntax as other Mercurial configuration files

8

but recognizes only the following sections:

8

but recognizes only the following sections:

9

10

- web

10

- web

11

- paths

11

- paths

12

- collections

12

- collections

13

14

The ``web`` options are thorougly described in :hg:`help config`.

14

The ``web`` options are thorougly described in :hg:`help config`.

15

16

The ``paths`` section maps URL paths to paths of repositories in the

16

The ``paths`` section maps URL paths to paths of repositories in the

17

filesystem. hgweb will not expose the filesystem directly - only

17

filesystem. hgweb will not expose the filesystem directly - only

18

Mercurial repositories can be published and only according to the

18

Mercurial repositories can be published and only according to the

19

configuration.

19

configuration.

20

21

The left hand side is the path in the URL. Note that hgweb reserves

21

The left hand side is the path in the URL. Note that hgweb reserves

22

subpaths like ``rev`` or ``file``, try using different names for

22

subpaths like ``rev`` or ``file``, try using different names for

23

nested repositories to avoid confusing effects.

23

nested repositories to avoid confusing effects.

24

25

The right hand side is the path in the filesystem. If the specified

25

The right hand side is the path in the filesystem. If the specified

26

path ends with ``*`` or ``**`` the filesystem will be searched

26

path ends with ``*`` or ``**`` the filesystem will be searched

27

recursively for repositories below that point.

27

recursively for repositories below that point.

28

With ``*`` it will not recurse into the repositories it finds (except for

28

With ``*`` it will not recurse into the repositories it finds (except for

29

``.hg/patches``).

29

``.hg/patches``).

30

With ``**`` it will also search inside repository working directories

30

With ``**`` it will also search inside repository working directories

31

and possibly find subrepositories.

31

and possibly find subrepositories.

32

33

In this example::

33

In this example::

34

35

[paths]

35

[paths]

36

/projects/a = /srv/tmprepos/a

36

/projects/a = /srv/tmprepos/a

37

/projects/b = c:/repos/b

37

/projects/b = c:/repos/b

38

/ = /srv/repos/*

38

/ = /srv/repos/*

39

/user/bob = /home/bob/repos/**

39

/user/bob = /home/bob/repos/**

40

41

- The first two entries make two repositories in different directories

41

- The first two entries make two repositories in different directories

42

appear under the same directory in the web interface

42

appear under the same directory in the web interface

43

- The third entry will publish every Mercurial repository found in

43

- The third entry will publish every Mercurial repository found in

44

``/srv/repos/``, for instance the repository ``/srv/repos/quux/``

44

``/srv/repos/``, for instance the repository ``/srv/repos/quux/``

45

will appear as ``http://server/quux/``

45

will appear as ``http://server/quux/``

46

- The fourth entry will publish both ``http://server/user/bob/quux/``

46

- The fourth entry will publish both ``http://server/user/bob/quux/``

47

and ``http://server/user/bob/quux/testsubrepo/``

47

and ``http://server/user/bob/quux/testsubrepo/``

48

49

The ``collections`` section is deprecated and has been superseeded by

49

The ``collections`` section is deprecated and has been superseded by

50

``paths``.

50

``paths``.

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

             Mercurial's internal web server, hgweb, can serve either a single
             repository, or a tree of repositories. In the second case, repository
             paths and global options can be defined using a dedicated
             configuration file common to :hg:`serve`, ``hgweb.wsgi``,
             ``hgweb.cgi`` and ``hgweb.fcgi``.
             This file uses the same syntax as other Mercurial configuration files
             but recognizes only the following sections:
               - web
               - paths
               - collections
             The ``web`` options are thorougly described in :hg:`help config`.
             The ``paths`` section maps URL paths to paths of repositories in the
             filesystem. hgweb will not expose the filesystem directly - only
             Mercurial repositories can be published and only according to the
             configuration.
             The left hand side is the path in the URL. Note that hgweb reserves
             subpaths like ``rev`` or ``file``, try using different names for
             nested repositories to avoid confusing effects.
             The right hand side is the path in the filesystem. If the specified
             path ends with ``*`` or ``**`` the filesystem will be searched
             recursively for repositories below that point.
             With ``*`` it will not recurse into the repositories it finds (except for
             ``.hg/patches``).
             With ``**`` it will also search inside repository working directories
             and possibly find subrepositories.
             In this example::
               [paths]
               /projects/a = /srv/tmprepos/a
               /projects/b = c:/repos/b
               / = /srv/repos/*
               /user/bob = /home/bob/repos/**
             - The first two entries make two repositories in different directories
               appear under the same directory in the web interface
             - The third entry will publish every Mercurial repository found in
               ``/srv/repos/``, for instance the repository ``/srv/repos/quux/``
               will appear as ``http://server/quux/``
             - The fourth entry will publish both ``http://server/user/bob/quux/``
               and ``http://server/user/bob/quux/testsubrepo/``
-            The ``collections`` section is deprecated and has been superseeded by
+            The ``collections`` section is deprecated and has been superseded by
             ``paths``.