Upsource
 
2020.1
  1. Administering Upsource
  2. Advanced Upsource tuning
  3. Tuning up a ZIP installation

Tuning up a ZIP installation

Last modified: 02 April 2021

note

The commands on this page are for Linux and OS X. For a Windows installation, replace .sh with .bat and use the backslash.

Always execute commands on behalf of the OS user that runs the Upsource service. These commands create configuration files and folders. The Upsource service user should have sufficient permissions to access these files and folders.

note

Read about Upsource services, processes, properties and how they're organized and interrelated in Advanced Upsource tuning.

warning

The one-way synchronization from the configuration file to the database can lead to problems if you're not careful. System properties that are set in the Upsource UI are applied directly to the database. If you change a setting in the UI that has been updated in the configuration file, the setting in the configuration file will be applied to the database on restart, overwriting the setting in the UI.

Configuring Upsource Launcher properties

Upsource Launcher process uses:

To change Upsource-specific Launcher properties:

  1. Stop Upsource: <upsource_home>/bin/upsource.sh stop

  2. Enter the upsource.sh configure command, followed by all of the settings that you want to update in the configuration file. You can set multiple options in a single command. For example: 

    <upsource_home>/bin/upsource.sh configure --listen-port 1111 --base-url
                    http://upsource.mydomain.com:2222

  3. Start Upsource.

tip

You can mix Upsource-specific and JVM properties in a single configure command.

To change JVM Launcher properties programmatically:

  1. Stop Upsource: <upsource_home>/bin/upsource.sh stop

  2. Enter the upsource.sh configure command, followed by all of the settings that you want to update in the configuration file.

    Use the -J prefix followed by a JVM option. Do not add any spaces between the prefix and the option.

    The symbol that precedes the option determines how it is applied:

    • Add an option with the - symbol.

    • Remove an option with the + symbol.

    If you specify a value, the corresponding option is only removed if it has exactly the same value.

    You can set multiple options in a single command.

    Example:

    upsource.sh configure -J-Xmx1024m -J-XX:+HeapDumpOnOutOfMemoryError

  3. Start Upsource.

You can also change JVM setting by editing a configuration file manually.

To change JVM Launcher properties manually:

  1. Stop Upsource: <upsource_home>/bin/upsource.sh stop

  2. Open the configuration file upsource.jvmoptions located in the directory <upsource_home>/conf.

    If the the file does not exist, create it and copy the contents of the sample configuration file with the .dist extension into it.

  3. Edit the JVM options directly in the file. List each JVM option on a new line. To set a pre-defined JVM option, simply uncomment the corresponding line.

  4. Save and close the file.

  5. Start Upsource.

    • The changes to the configuration file are copied to the database.

    • Upsource starts using the specified settings.

To change JVM Launcher properties on a temporary basis (ad hoc):

  1. Stop Upsource: <upsource_home>/bin/upsource.sh stop

  2. Enter the upsource.sh start command, followed by all of the settings that you want to pass to Upsource on start.

    Use the --J prefix to pass the settings as ad hoc parameters. Follow the prefix with a JVM option. Do not add any spaces between the prefix and the option.

    The symbol that precedes the option determines how it is applied:

    • Add an option with the - symbol.

    • Remove an option with the + symbol.

    If you specify a value, the corresponding option is only removed if it has exactly the same value.

    You can set multiple options in a single command.

    Example:

    upsource.sh start --J-Xmx1024m --J-XX:+HeapDumpOnOutOfMemoryError

    • Upsource starts with the specified settings, bypassing the configuration file.

    • The configuration file is not modified.

    • Subsequent starts that do not specify the ad hoc parameter use the settings that are stored in the configuration file. To run Upsource with the previous settings, simply restart it without passing any custom parameters.

Configuring Upsource Frontend properties

Upsource Frontend process uses:

Upsource Frontend properties can be changed programmatically with the configure command or by manually editing the configuration file upsource-frontend.jvmoptions

To configure Frontend properties programmatically:

  1. Stop Upsource: <upsource_home>/bin/upsource.sh stop

  2. Switch to the directory <upsource_home>/conf/upsource-frontend

  3. Enter the upsource-frontend.sh configure command, followed by all of the settings that you want to update in the configuration file.

    Use the -J prefix followed by a property or JVM option. Do not add any spaces between the prefix and the option.

    The symbol that precedes the option determines how it is applied:

    • Add an option with the - symbol.

    • Remove an option with the + symbol.

    If you specify a value, the corresponding option is only removed if it has exactly the same value.

    You can set multiple options in a single command.

    Example 1:

    upsource-frontend.sh configure
                    -J-Dfrontend.diff.filesize.limit=2000

    In this example we increased the maximum number of lines to display in a diff from 1000(default) to 2000.

    Example 2:

    upsource-frontend.sh configure -J-Xmx1024m
                    -J-XX:+HeapDumpOnOutOfMemoryError

  4. Start Upsource.

    • Upsource starts with the specified settings.

    • The configuration file upsource-frontend.jvmoptions is modified and the new settings will be applied to any consequent startup.

To configure Frontend properties manually:

  1. Stop Upsource: <upsource_home>/bin/upsource.sh stop

  2. Open the configuration file upsource-frontend.jvmoptions located in the <upsource_home>/conf/upsource-frontend directory. If the file does not exist, create it.

  3. Edit existing properties directly in the file. Add new properties with their values to the end of the file.

  4. Save and close the file.

  5. Start Upsource.

    • The changes to the configuration file are copied to the database.

    • Upsource starts with the specified settings.

Configuring Upsource Cassandra properties

You can manage the Cassandra process by changing its JVM options with the configure command or by manually editing the configuration file cassandra.jvmoptions. See Upsource Cassandra properties for a list of the default options.

To configure Cassandra properties programmatically:

  1. Stop Upsource: <upsource_home>/bin/upsource.sh stop

  2. Switch to the directory <upsource_home>/conf/cassandra

  3. Enter the cassandra.sh configure command, followed by all of the settings that you want to update in the configuration file.

    Use the -J prefix followed by a JVM option. Do not add any spaces between the prefix and the option.

    The symbol that precedes the option determines how it is applied:

    • Add an option with the - symbol.

    • Remove an option with the + symbol.

    If you specify a value, the corresponding option is only removed if it has exactly the same value.

    You can set multiple options in a single command.

    Example:

    cassandra.sh configure -J-Xmx3500m
                    -J-XX:+HeapDumpOnOutOfMemoryError

  4. Start Upsource.

To configure Cassandra properties manually:

  1. Stop Upsource: <upsource_home>/bin/upsource.sh stop

  2. Open the configuration file cassandra.jvmoptions located in the <upsource_home>/conf/cassandra directory. If the file does not exist, create it.

  3. Edit existing properties directly in the file. Add new properties with their values to the end of the file.

  4. Save and close the file.

  5. Start Upsource.

    • The changes you made to the configuration file are copied to the database.

    • Upsource starts with the specified settings.