Skip to content

Latest commit

 

History

History
47 lines (37 loc) · 2.68 KB

configuration.adoc

File metadata and controls

47 lines (37 loc) · 2.68 KB
Raw
Table of Contents

Configuration

IDEasy aims to be highly configurable and flexible. The configuration of the ide command and environment variables takes place via ide.properties files. The following list shows these configuration files in the order they are loaded so files can override variables from files above in the list:

  1. build in defaults (for JAVA_HOME, MAVEN_ARGS, etc.)

  2. ~/ide.properties - user specific global defaults (on windows in %USERPROFILE%/ide.properties)

  3. settings/ide.properties (settings/ide.properties) - project specific configurations from settings.

  4. workspaces/${WORKSPACE}/ide.properties - optional workspace specific configurations (especially helpful in projects using docker).

  5. conf/ide.properties - user specific configurations (e.g. M2_REPO=~/.m2/repository). During setup this file is created by copying a template from settings/template/conf/ide.properties.

ide.properties

The ide.properties files allow to define environment variables in a simple and OS independent way:

  • # comments begin with a hash sign (#) and are ignored

  • variable_name=variable_value with space etc.

  • variable_name=${predefined_variable}/folder_name

    Variable values can refer to other variables that are already defined, which will be resolved to their value. You have to used ${…​} syntax to make it work on all platforms (never use %…​%, $…​, or $(…​) syntax in ide.properties files.

  • export exported_variable=this value will be exported in bash, in windows CMD the export prefix is ignored

  • variable_name=

    This will unset the specified variable

  • variable_name=~/some/path/and.file

    Tilde is resolved to your personal home directory on any OS including windows.

  • array_variable=(value1 value2 value3)

    This will only work properly in bash worlds but as no arrays are used in CMD world of IDEasy it does not hurt on windows.

  • Please never surround values with quotes (var="value")

  • This format is similar to Java *.properties but does not support advanced features as unicode literals, multi-lined values, etc.

In order to know what to configure, have a look at the available variables.

Please only tweak configurations that you need to change and take according responsibility. There is a price to pay for flexibility, which means you have to be careful what you do.

Further, you can configure maven via conf/.m2/settings.xml. To configure your IDE such as Eclipse, IntelliJ, or VSCode you can tweak the settings.