diff --git a/README.md b/README.md old mode 100644 new mode 100755 index 3fbba6e..3e8844d --- a/README.md +++ b/README.md @@ -33,6 +33,8 @@ * **SourceSFSVN**: SVN repositories hosted on [SourceForge](http://sourceforge.net/). * **SourceSVN**: SVN repositories locally accessible by the SVN binaries. +* **SourceViewVC**: SVN repositories accessible via a + [ViewVC](http://www.viewvc.org/) web frontend installation. * **SourceWebSVN**: SVN repositories accessible via a [WebSVN](http://www.websvn.info/) web frontend installation. @@ -88,6 +90,7 @@ relevant plugin extension: * [SourceGithub](docs/CONFIGURING.SourceGithub.md) + * [SourceViewVC](docs/CONFIGURING.SourceViewVC.md) 9. Once configured, click the "Return to Repository" link and click either the "Import Everything" or "Import Newest Data" button to perform initial diff --git a/docs/CONFIGURING.SourceViewVC.md b/docs/CONFIGURING.SourceViewVC.md new file mode 100755 index 0000000..dd1ff9b --- /dev/null +++ b/docs/CONFIGURING.SourceViewVC.md @@ -0,0 +1,67 @@ +# SourceViewVC Configuration + +## Description + +The **SourceViewVC** extension plugin adds support for SVN repositories +with a [ViewVC](http://www.viewvc.org/) front-end. + +## Requirements + +The **SourceViewVC** plugin requires Mantis 1.2.16. See the +[README](../README.md#requirements) for further information. + +Ensure both the **Source** and **SourceViewVC** plugins are installed. +See the [README](../README.md#installation) for overall instructions. + + +## Configuration + +1. Click the *Repositories* link in the navigation bar. + +2. In the *Create Repository* section: + + - Enter the repository name in the *Name* text field. + - Select *ViewVC* from the *Type* pop-up menu. + - Click the *Create Repository* button. + +3. This will take you to the *Update Repository* page where you'll need to fill + in all the details for the repository: + + - The *Name* field should be pre-populated with the name you entered in Step 3a above. + + - Paste in the SVN repository's URL in the *URL* field + (e.g. `https://localhost.localdomain/repos/myrepo` or + `file:///var/repos/myrepo`). + + - Paste in the ViewVC installation's root URL in the *ViewVC URL* field + (e.g. `http://viewvc-server/viewvc/`). + + - Enter the name of the SVN repository, as it appears in the list seen in + ViewVC, in the *ViewVC Name* field + (e.g. `myrepo`) + + - If the ViewVC installation has the `root_as_url_component` option enabled + (see the `viewvc.conf` file) then enable the *ViewVC Root As URL Component + Enabled?* field + + - If the ViewVC installation has the checkout view enabled (the + `allowed_views` field list includes `co` in the `viewvc.conf` file) then + enable the *ViewVC Checkout View Enabled?* field + + - Enter the username of a user which has read access to the SVN repository in + the *SVN Username* field (e.g. "repo-user"). + + - Enter the password for the user in the *SVN Password* field + (e.g. "Sup4rSecre7"). + + - If your repository is configured with the standard `trunk`, `branches` & + `tags` folders at the top-level, select the *Standard Repository* field, + otherwise enter the appropriate paths into the *Trunk Path*, *Branch Path* + and *Tag Path* fields. + + - Click the *Update Repository* button. + +4. Click the *Import Everything* button to test connectivity and perform an + initial import of the repository changesets. + + **Note:** This may take a long time or even fail for large repositories.