The LabKey source files are stored in two version control systems: (1) the build system and test sample data are stored in a Subversion (SVN) repository and (2) the core platform and all commonly distributed modules are stored in multiple GitHub repositories.
To access the source code, you'll need to install both a Subversion client and a Git client, then checkout/clone the desired repositories.
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 the latest version of TortoiseSVN 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. At this point, all the SVN-based LabKey source files and sample data will be copied to your computer.
Install Command Line SVN Client (Recommended for Non-Windows Operating Systems)
- Download the most recent Subversion package by visiting the Apache Subversion Packages page and choosing the appropriate link for your operating 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) Mass Spec and Proteomics Binaries
LabKey Server's mass spectrometry and proteomics binaries are housed on Artifactory and included by default in your enlistment. To skip the download of these binaries, exclude them using the gradle property "excludeProteomicsBinaries"
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.
The core platform and most server modules are located on GitHub. For a list of available modules see:https://github.com/LabKey
For details on acquiring the core server modules, see Clone Core Modules on GitHub
The optional 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 Optional Modules on GitHub
If you are running a production LabKey server, you should install only official releases of LabKey on that server. VCS 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.