Admin

The Admin guide runs through how to use uberSVN.

1. Starting/Stopping uberSVN (Linux/Mac OSX)

Starting uberSVN

To start the uberSVN portal follow these steps:

1. Open a terminal window on the server and login with suitable file permissions. (With OSX this means that you must be the ubersvn users.)
2. Go to uberSVN's binary directory, i.e.
```
/opt/ubersvn/bin
```

3. Run the start/stop script:

[root@localhost bin]# ./ubersvncontrol start
Starting Tomcat
Using CATALINA_BASE:   /opt/ubersvn/tomcat
Using CATALINA_HOME:   /opt/ubersvn/tomcat
Using CATALINA_TMPDIR: /opt/ubersvn/tomcat/temp
Using JRE_HOME:        /home/user/jdk1.6.0_21/
Using CLASSPATH:       /opt/ubersvn/tomcat/bin/bootstrap.jar
Please allow 30 seconds or so for the uberSVN portal to start

4. Wait about 30 seconds, then open a browser and enter the portal's address - http://<:Server IP>:<port>/ubersvn

Stopping uberSVN (Linux/Mac OSX)

To stop uberSVN portal:

1. Open a terminal window on the server and login with suitable file permissions.
2. Go to uberSVN's binary directory, i.e.
```
/opt/ubersvn/bin
```

3. Run the start/stop script:

[root@localhost bin]# ./ubersvncontrol stop
Stopping Tomcat
Using CATALINA_BASE:   /opt/ubersvn/tomcat
Using CATALINA_HOME:   /opt/ubersvn/tomcat
Using CATALINA_TMPDIR: /opt/ubersvn/tomcat/temp
Using JRE_HOME:        /home/user/jdk1.6.0_21/
Using CLASSPATH:       /opt/ubersvn/tomcat/bin/bootstrap.jar
Killing: 31981

2. Starting/Stopping uberSVN (Windows)

Starting uberSVN

The Windows version of uberSVN is run as a Windows service, so it requires less user intervention to run. However, there's a batch file available from the Start menu that you can run that will setup uberSVN to automatically start up on system boot.

Starting uberSVN on Windows

Also present are batch files for starting and stopping uberSVN manually.

Stopping uberSVN (Windows)

The Windows version of uberSVN can be stopped by clicking on the Stop uberSVN batch file that is present in the Server Control directory of the uberSVN installation directory.

Stopping uberSVN on Windows

3. Starting/Stopping Subversion (Linux/Mac OSX)

To start the Subversion server follow these steps:

1. Open a terminal window on the server and login with suitable file permissions
2. Go to the uberSVN's binary directory, i.e.
```
/opt/ubersvn/bin
```

3. Run the start/stop script:

[root@localhost bin]# ./svnservercontrol start

To stop the Subversion server follow these steps:

1. Open a terminal window on the server and login with suitable file permissions.
2. Go to the uberSVN's binary directory, i.e.
```
/opt/ubersvn/bin
```

3. Run the start/stop script:

[root@localhost bin]# ./svnservercontrol stop

4. Starting/Stopping Subversion (Windows)

On the Windows version of uberSVN, you control the Subversion service through the Subversion Server tab, located under Administration.

5. Setting up a repository

Setting up a repository couldn't be easier. We made it that way, although, right now, the focus is on setting up a common-or-garden repository, without all the options available when manually setting up using pure Apache Subversion.

Although you can surely add a repository without referring to the following procedure, you might appreciate having it as an overview of the procedure and as an explanation of what everything means.

1. Ensure that you are logged in as the administrator, or a user with sufficient (System Admin or Global Repository ) permissions.

2. Click on the Repositories tab.

3. Click on the ADD button.

Add a repository
4. Enter a name for the repository, by default uberSVN will use this name for the location (referred to as the DAV) which will be used to access the repository. You can choose a different name for the location, though we recommend that you keep it as simple as possible as users may be called to regularly type it in.

Name the repository

Repository Naming Rules:
The following restrictions apply to the naming of repositories:

Limited to 25 characters.
colons (:), spaces, double forward slashes (//) are not permitted. Single forward slashes (/) are allowed, but not as the first character.
On Windows systems, the usual Windows restrictions apply with the following characters not permitted: -?*<>|
While names that contain multi-byte characters are permitted they are not recommended. Multi-byte characters are not supported by the repository browser, and may result in other problems.

5. At this point you choose how to add the repository. You have four options which described below.

Create a new repository
Create a completely new, empty repository.

Import from uploaded dump file
Use a dump file that has been uploaded onto the server remotely.

Import from dump file located on the sever
Use a dump file that has been copied onto the server, then just imported from the server's own local drive.

Add an existing repository located on the server
You can add an existing repository to uberSVN.

Alert
Existing repositories that are added to uberSVN become new repositories, losing all their revision history.

Copying an existing repository and keeping its revision history
1. Create a new blank repository in uberSVN, with the same name as your current repository.
2. Delete the new repository from the file system.
3. Create a hotcopy of your existing repository and move it into the file location where you had deleted the new uberSVN repository.
4. uberSVN will now treat the hotcopy as a 'live' repository with its revision history intact.

In this example we'll Create a new repository. There's a checkbox option to Create trunk, branches and tags directories, these directories form part of the established workflow for using Subversion for software configuration management. You can read more about how these directories are used in the Beginners Guide to Subversion.

3 options for new repositories: 1) New (blank), 2) new (with imported data) or 3) old (added into uberSVN).
6. The repository is now created. To make the new repository appear, a graceful restart of the Apache service is triggered.

Repository created.
7. Finally, the repository's permissions need to be set up so that only the users who need to use the repository have access. By default each new repository is open, allowing all users full read and write access. While this is okay for starting out, you should set up repositories so that access is limited by default.

Setting users permissions - you can add existing users or teams.

6. Adding Users

Manually add new users into uberSVN using the Add User Wizard.

1. Open the uberSVN portal and click on the Users tab.

2. Click on the Add button.

Users - Add Users.
3. The User Creation screen will load. By default the Create new user entry fields will be displayed:

Users - Single User Creation

Full Name:

The user's full name, e.g. Thomas Hobbes.

Username:

A name by which the user will be known on uberSVN. It should consist of a single word, with only numbers and letters.

Password

A password, which also should consist of numbers and letters only.

Email:

The email address for the user. Tick the Email password to user checkbox to have the password sent to the user in an email.

When all fields have been filled, click CREATE. If, instead, you want to create another user then click CREATE & ADD, the screen will refresh, ready for the entry of a new user's details.

Import users

To bulk import users into uberSVN you need either a Subversion password file (file format: username:password) or a comma delimited (CSV) with the file format: username, full name, email, password.

Users Main Screen

The Multiple tab, used for the bulk import of users.

Click Choose File and select a comma delimited (csv) file containing new users. The, click the Import button.

7. Adding teams

Use this procedure to add a new team to your uberSVN implementation.

1. Login to uberSVN with suitable permissions (System Admin or Global Team Admin). Click on the Team tab and then click the ADD button.

The Multiple tab, used for the bulk import of users.
2. Enter the new team's details:

The Multiple tab, used for the bulk import of users.
Team Name: A name for the team.

Caution with team names
Don't give a team exactly the same (case-matching) name as a repository. When a team is created with a name that matches that of an existing repository, assigning this team to another repository can result in unintended read-write access being assigned to non-members of the team.
Description: A brief description of the team.
Repositories: Add the repositories that you wish team members to be able to access.
Users: Add users who you wish to be members of the team.

When the details have been added, click the CREATE button.
3. The team is now created and will appear at the end of the list of Teams. You can make changes to the team's settings by clicking on its name, or clicking on it's edit widget.

The Multiple tab, used for the bulk import of users.
4. From the Team's screen it's possible to edit the labelling, add or remove repositories or team players, or assign admin permissions to one of the team players by clicking on the key widget so that it turns solid.

The Multiple tab, used for the bulk import of users.

8. Enabling SSL for the uberSVN portal

Secure connections to uberSVN by enabling SSL. This will ensure that connections to the uberSVN portal are encrypted.

1. Click on the Administration tab (You'll need to be logged in with an admin account to see it). Click on the uberSVN Server sub-tab. Set the Enable HTTPS to Yes then click SAVE.
2. You may encounter your browser's "This Connection is Untrusted" screen. Don't be alarmed, this screen appears because certification is not yet in place.
Click Add Exception...
3. Click Confirm Security Exception.
4. uberSVN will reload using https, on the Https port that was specified on the uberSVN Server screen (port 9900 by default).

9. Disabling SSL for the uberSVN portal

1. Login to uberSVN, click on the Administration tab.
2. Click on the uberSVN Server sub-tab. Ensure that Enable Https is set to No, then click SAVE.
3. Refresh your browser, making sure that the port is changed from the ssl port (9900 by default) back to the standard uberSVN port (9890 by default).

10. Replacing the integrated repository browser

The integrated repository browser doesn't work with all Linux distributions. The following procedure can be used to replace the browser with the latest version of Sventon (supporting SVNKit):

1. Download the latest version of Sventon with SVNkit support - http://prdownload.berlios.de/sventon/sventon-2.5.0-bin-svnkit.zip
2. Extract Sventon to a folder of your choice.
3. Navigate to that <extract_folder>/sventon-2.5.0
4. Rename svn.war to RepositoryBrowser.war. Important! The case must match.
5. On your ubersvn server stop the uberSVN service using:
```
<uberSVN_Install_Directory>/bin/ubersvncontrol stop
```
6. Navigate to <uberSVN_Install_Directory>/tomcat/webapps
7. Delete the RepositoryBrowser folder and RepositoryBrowser.war
8. Copy in your renamed RepositoryBrowser.war
9. Change the owner and group of RepositoryBrowser.war with:
```
chown <New User>:<New Group> RepositoryBrowser.war
 
```
10. Start uberSVN:
```
<uberSVN_Install_Directory>/bin/ubersvncontrol start 
 
```
This is required to expand the RepositoryBrowser.war into the webapps folder. This process can take a while to complete, so wait a minute or so before proceeding.
11. Once uberSVN has restarted, stop it again.
12. Navigate to <uberSVN_Install_Directory>/tomcat/webapps/RepositoryBrowser/WEB-INF
Open applicationContext.xml in an editor. Search for "configurationReloadSupported" and change the value to "true"
13. Save the applicationContext.xml file.
14. Start uberSVN using uberSVN:
```
<uberSVN_Install_Directory>/bin/ubersvncontrol start
```
You now have a working replacement repository browser.

11. Changing the user/group that runs uberSVN

Under Linux, uberSVN is run by a user and group called ubersvn. If you need to run uberSVN using a different user and group then follow these steps:

1. Open the bin/ubersvncontrol startup script in an editor.
2. Change the TOMCATUSER=<New User>, the <New User> variable being the name of the user you want to run uberSVN. Save the changes and close the startup script.
3. Open conf/conf.d/30-user.conf in an editor and replace the ubersvn user and group with the one you defined as the TOMCATUSER in step 2.

Change the ownership of httpdstarter:

    
$ sudo su
# find /opt/ubersvn | grep -v "httpdstarter" | xargs chown <New User>:<New Group>
# chown root:<New Group> /opt/ubersvn/bin/httpdstarter
# chmod 4750 /opt/ubersvn/bin/httpdstarter

4. Restart Subversion and uberSVN:

sudo /opt/ubersvn/httpdserverctl restart
sudo /opt/ubersvn/ubersvncontrol restart

uberSVN/Apache will now run with your chosen user and group.

12. Changing the port used by Apache

The following procedure lets you change the port on which uberSVN's Apache server runs. You may need to change the port if you have another application or service (maybe another instance of Apache) already runs on the same port.

Changing the Apache port will change the URLs that are used to access repositories, so before making the change it's a good idea to let everyone know that they'll need to update their settings.

1. Login to uberSVN with a user account that has the System Admin permission.
2. Click on the Administration tab
3. Click on the Subversion sub-tab.
4. Enter a new port number in the Server Port box, then click Save.
5. The update is going to require a restart of Apache.
Caution
Anyone currently accessing Subversion will lose their connection, and will need to change their client settings to the new port to regain access.
Click on the link Click here to apply configuration changes. When clicked, Apache will restart on the new port.
6. To check that the change has worked, browse to one of your repositories.
The repository URL includes the new Apache port number, so if you use port 7777 for Apache, then your repository will be accessible via
```
http://[server address]:[new port number]/[repository name]
```

12.1 Reset uberSVN to run Apache on port 80, or any privileged port (0-1023)

During setup you elected to not allow uberSVN to run Apache on a common port, but what if you later find that you need to, in spite of the security risks.

1. Open a console and run the following commands to change Apache's owner and permissions -

$   su - -c 'chown root:ubersvn /opt/ubersvn/bin/httpdstarter'
$   su - -c 'chmod 4750 /opt/ubersvn/bin/httpdstarter'

2. Open the uberSVN portal, go to the Administration tab
3. On the Apache server tab set the Server port to the port number of your choice - just ensure that it isn't already in use.
4. restart uberSVN. Apache will now run on your new port.

uberSVN "Chimney House"
Last doc build: 10:17 - Tuesday 19th June 2012