To access the source code repository, you'll need to install a Subversion client. If you are developing on Windows, we recommend that you install TortoiseSVN, a helpful graphical interface to Subversion. If you are developing on a Mac, subversion is shipped with MacOS X and is accessible from the terminal.
Install TortoiseSVN (Recommended for Windows)
- Download TortoiseSVN version 1.10.x from the TortoiseSVN download page.
- Install TortoiseSVN on your local computer.
- On the list of features to install to the local hard drive, include the command line tools
- Add the TortoiseSVN/bin directory to your PATH
Check Out Source Files Using TortoiseSVN
TortoiseSVN integrates with the Windows file system UI. To use the TortoiseSVN commands, open Windows Explorer, right-click a file or folder, and select a SVN command.
- Create a new directory in the Windows file system. This will be the root directory for your enlistment.
- In Windows Explorer, right-click the new directory and select SVN Checkout...
- Enter the URL for the LabKey repository
- Make sure that the checkout directory refers to the location of your root directory.
- Click OK to create a local enlistment. Note that at this point all the LabKey source files, tests, and sample data will be copied to your computer.
Install Command Line SVN Client (Recommended for Non-Windows Operating Systems)
- Download a Subversion 1.10.x package by visiting the Apache Subversion Packages page and choosing the appropriate link for your operation system.
- Install Subversion on your local computer following instructions from the Apache Subversion website. Provide the server and account information from above.
- Extensive Subversion documentation is available in the Subversion Book.
Check Out Source Files Using Command Line SVN
Use the svn checkout
command, for example:
(Optional) Add the Mass Spec and Proteomics Binaries
LabKey Server's mass spectrometry and proteomics binaries are provided as a separate (and optional) enlistment. To add these binaries, follow the instructions in the topic: Add the Proteomics Binaries
SVN Access URLs
Read-only access is available using the following configuration:
Anonymous access is enabled, so no username/password is necessary. If you have a read-write account in the Subversion project, specify your username and password when accessing the repository.
Modules on GitHub
Note that the Subversion repository above only provides a minimal set of core LabKey Server modules. Many optional and specialty modules are located on GitHub. For a list of available modules see:https://github.com/LabKey
These modules can be added to your build on a module-by-module basis. For details on installing a Git client and cloning individual modules see Set Up a Development Machine
If you are running a production LabKey server, you should install only official releases of LabKey on that server. Subversion access is intended for developers who wish to peruse, experiment with, and debug LabKey code against a test database. Daily drops of LabKey are not stable and, at times, may not even build. We cannot support servers running any version other than an officially released version of LabKey.
Relocating Your Enlistment
If you have an enlistment created prior to May 24, 2018, you are likely using the previous LabKey SVN server ("hedgehog") which will no longer work. To correct this, use Tortoise SVN, select Relocate
and enter the new URL:
Instead of Tortoise SVN, you can also use the following on the command line:
If you have a read/write account, include your username and password. If you are working on a branch other than trunk, substitute the correct branch path in the URL.