.. _sec-config:

Module Configuration
====================

This section describes the configuration parameters used in
:file:`gsm.conf` which is generated during :ref:`initial setup <sec-setup>`.


.. list-table:: Configuration parameters
   :header-rows: 1

   * - Parameter
     - Description
   * - **os**
     - Distribution name, e.g., `rhel` or `ubuntu`.
   * - **os_version**
     - Major distribution version, e.g., `9` or `24.04`.
   * - **arch**
     - System architecture, e.g., `x86_64` or `aarch64`.
   * - **base_url**
     - Base URL of the gempa customer repository, e.g., `https://data.gempa.de/packages/foo`.
   * - **user**
     - Username provided in the Wiki section of the gempa customer portal.
   * - **password**
     - Password provided in the Wiki section of the gempa customer portal.
   * - **release**
     - Name of the SeisComP release, e.g., `6` or `nightly`.
   * - **download_dir**
     - Directory where downloaded files are stored.
   * - **install_path**
     - User-defined root path, e.g., `/home/sysop/seiscomp`.
   * - **data_dir**
     - Base directory for data packages like maps or greens functions.
   * - **verify**
     - Enable/disable SSL certificate check, e.g., `True`.
   * - **debug**
     - Enable verbose logging. Default: `False`.
   * - **sync_dir**
     - Remote package cache, contains information about available packages.
   * - **local_dir**
     - Local package storage, contains information about installed packages.
   * - **gpgverify**
     - Enable/disable the signature check for a package (default = `False`).
   * - **backup_package_enable**
     - [True/False] A backup of the package file to be installed is made before each installation. (default = `False`).
   * - **backup_package_path**
     - The directory in which the backups are created.


.. _sec-options:

Command-Line Options
====================

.. option:: --url arg

   Type: *string*

   URL of the package directory, e.g., https://data.gempa.de/packages/Public

.. option:: --noverify

   Do not verify server certificate

.. option:: -d, --downloadonly

   Do not install, just download.

.. option:: --downloaddir arg

   Type: *string*

   Specifies an alternative directory to store packages.

.. option:: --installdir arg

   Type: *string*

   Specifies an alternative directory to install packages.

.. option:: -u --user arg

   Type: *string*

   Username to use

.. option:: -p --password arg

   Type: *string*

   Password to use

.. option:: -r --release arg

   Type: *string*

   Default: ``6``

   Values: ``6, nightly``

   SeisComP release

.. option:: --arch arg

   Type: *string*

   Default: ``x86_64``

   Values: ``x86_64, aarch64 (not yet)``

   System architecture

.. option:: --showurls

   Display URLs

.. option:: -y --assumeyes

   Assume that the answer to questions which would be asked is yes. Errors still require user interaction. Configuration paramter: assumeyes

.. option:: --exclude arg

   Type: *list:string*

   Values: ``seiscomp,quakelink,scanloc``

   Exclude packages from (re)install and remove.

.. option:: -o --offline 

   Run gsm in offline modus.

.. option:: -f --force 

   Disables the remote file time check when downloading files. With this option enabled file downloads are always performed.

.. option:: -V --version 

   Show gsm version information.