Skip to content

Commit 907ee71

Browse files
bright-toolsdregad
authored andcommitted
Add documentation for new plugin
1 parent fb45fe1 commit 907ee71

File tree

2 files changed

+70
-0
lines changed

2 files changed

+70
-0
lines changed

README.md

100644100755
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ plugins:
3333
* **SourceSFSVN**: SVN repositories hosted on
3434
[SourceForge](http://sourceforge.net/).
3535
* **SourceSVN**: SVN repositories locally accessible by the SVN binaries.
36+
* **SourceViewVC**: SVN repositories accessible via a
37+
[ViewVC](http://www.viewvc.org/) web frontend installation.
3638
* **SourceWebSVN**: SVN repositories accessible via a
3739
[WebSVN](http://www.websvn.info/) web frontend installation.
3840

@@ -88,6 +90,7 @@ enforced as of 2013-04-24.
8890
relevant plugin extension:
8991

9092
* [SourceGithub](docs/CONFIGURING.SourceGithub.md)
93+
* [SourceViewVC](docs/CONFIGURING.SourceViewVC.md)
9194

9295
9. Once configured, click the "Return to Repository" link and click either
9396
the "Import Everything" or "Import Newest Data" button to perform initial

docs/CONFIGURING.SourceViewVC.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# SourceViewVC Configuration
2+
3+
## Description
4+
5+
The **SourceViewVC** extension plugin adds support for SVN repositories
6+
with a [ViewVC](http://www.viewvc.org/) front-end.
7+
8+
## Requirements
9+
10+
The **SourceViewVC** plugin requires Mantis 1.2.16. See the
11+
[README](../README.md#requirements) for further information.
12+
13+
Ensure both the **Source** and **SourceViewVC** plugins are installed.
14+
See the [README](../README.md#installation) for overall instructions.
15+
16+
17+
## Configuration
18+
19+
1. Click the *Repositories* link in the navigation bar.
20+
21+
2. In the *Create Repository* section:
22+
23+
- Enter the repository name in the *Name* text field.
24+
- Select *ViewVC* from the *Type* pop-up menu.
25+
- Click the *Create Repository* button.
26+
27+
3. This will take you to the *Update Repository* page where you'll need to fill
28+
in all the details for the repository:
29+
30+
- The *Name* field should be pre-populated with the name you entered in Step 3a above.
31+
32+
- Paste in the SVN repository's URL in the *URL* field
33+
(e.g. `https://localhost.localdomain/repos/myrepo` or
34+
`file:///var/repos/myrepo`).
35+
36+
- Paste in the ViewVC installation's root URL in the *ViewVC URL* field
37+
(e.g. `http://viewvc-server/viewvc/`).
38+
39+
- Enter the name of the SVN repository, as it appears in the list seen in
40+
ViewVC, in the *ViewVC Name* field
41+
(e.g. `myrepo`)
42+
43+
- If the ViewVC installation has the `root_as_url_component` option enabled
44+
(see the `viewvc.conf` file) then enable the *ViewVC Root As URL Component
45+
Enabled?* field
46+
47+
- If the ViewVC installation has the checkout view enabled (the
48+
`allowed_views` field list includes `co` in the `viewvc.conf` file) then
49+
enable the *ViewVC Checkout View Enabled?* field
50+
51+
- Enter the username of a user which has read access to the SVN repository in
52+
the *SVN Username* field (e.g. "repo-user").
53+
54+
- Enter the password for the user in the *SVN Password* field
55+
(e.g. "Sup4rSecre7").
56+
57+
- If your repository is configured with the standard `trunk`, `branches` &
58+
`tags` folders at the top-level, select the *Standard Repository* field,
59+
otherwise enter the appropriate paths into the *Trunk Path*, *Branch Path*
60+
and *Tag Path* fields.
61+
62+
- Click the *Update Repository* button.
63+
64+
4. Click the *Import Everything* button to test connectivity and perform an
65+
initial import of the repository changesets.
66+
67+
**Note:** This may take a long time or even fail for large repositories.

0 commit comments

Comments
 (0)