Upsource Web Help

Creating your first project

To add your first project in Upsource:

  1. Make sure you’re logged into Upsource using the administrator account. Non-admin user accounts are not eligible to create new projects.

  2. Go to http://your-host-name:port_for_upsource (or click the link for Upsource Frontend from the welcome page)

  3. Click Create a project.

  4. In the Create Project form, specify settings for your project.


  • Name: Give your project a name and type it in.
  • ID: Project ID is created automatically based on the specified project name.

Version Control

  • Repository URL: The following formats are expected in the Repository URL (Server name) field for different version control systems:

    • Git: or git://

    • Subversion:

    • Mercurial:

    • Perforce:

  • Login, Password: Specify credentials to connect to your VCS.

  • Check interval: Reflects how often Upsource checks for new revisions in the repository (every 300 seconds by default.) If commits to your repository aren’t usually made this frequently, consider setting Check interval to a larger value.

Upsource Properties

  • Build system defines whether Upsource is able to execute static code analysis in your repository and provide related features including displaying code issues, “Find usages”, “Go to Declaration” etc.

    • This setting should only be considered if you are working on a Java project. If you are working on a project that doesn’t use Java, you’re safe to set Build system to None as code analysis for non-Java projects is not supported at this point

    • For Java, there’s a separate option for projects that use Maven irrelevant of which IDE is used to maintain code, and also an option that enables code analysis when IntelliJ IDEA is used in the project irrelevant of build system (for example, if your project is built with Ant but you’re using IntelliJ IDEA, then IntelliJ IDEA would be your choice of build system.)

  • If Maven is selected as build system:

    • Path to project model should contain the path to the parent pom.xml file (relative to project root.)

    • Maven settings - if your project requires non-standard Maven settings, paste the content of your maven-settings.xml here (up to 20KB).

      Note: If your existing Maven settings might differ from the default, make sure to specify them in this field, otherwise when running Upsource under a different user (as a service, for instance) these settings might not be recognised.

  • If IntelliJ IDEA is selected as build system, Path to project model should contain the path to the .idea directory (relative to project root.)

Issue Tracker Integration

Issue references mentioned in commit messages or discussion comments can be recognized by Upsource and linked to the corresponding issues in your tracker.

  • Tracker URL: Specify your tracker’s URL in the following format: http:/{}

  • Issue ID prefix: Specify issue ID that refers to your project


When you are done filling in the form, click Create Project (or Save changes if you’re editing)

You’ll be redirected to the Administration view (http://your-host-name:port_for_upsource/administration) that shows status summary for the project.

Meanwhile Upsource will start loading commit information from the repository, then fetching and indexing repository content. All this could take a while for larger projects (up to several hours.) You will most probably not be able to work with the project before these steps complete.

Upon completing them, Upsource will allow browsing code in revisions, displaying diffs in revisions, create and process code reviews etc.