Properties Files

file-name.properties are simple key=value files used to configure all things in TEDI.

TEDI uses the UTF-8 character set; however, do not use special characters or non-printable characters in property files.

---

Collections

In order to specify a collection of related settings, which result in duplicated key names, TEDI employs the following syntax: {integer}.key

For example:

0.key_1 = value_1
1.key_1 = value_2
2.key_1 = value_3

For more nested collections, TEDI will augment the syntax and add more integer segments: {integer}.{integer}.key

TEDI is a zero-based index system. Counting always starts at 0. You’re welcome.

---

Comments

# prefix the line with the pound sign as in a shell script to add comments

# ----------------------------------------------------------------------
#  for multi-line comments, repeat #
# ----------------------------------------------------------------------

---

Single Line Values

spacing is allowed between the key and value. Whitespace will be ignored.

key = value

---

Multi-Line Values

for multi-line values, use a backslash \ to indicate the value continues on the next line. note - white-space is not preserved by default.

Enclose each line in quotes “ “ if you need to preserve the whitespace.

key =   value-1 \
      , value-2 \
      , value-3

key =   "Lorem ipsum dolor sit amet, consectetur adipiscing elit "  \
        "minim veniam, quis nostrud exercitation ullamco laboris "  \
        "in voluptate velit esse cillum dolore eu fart"

---

Includes

You can also include other files using the keyword .include

Using the .include will allow you to easily reuse property files between the services in your workflows.

.include =  /absolute/path/to/files.properties
.include =  ../../relative/path/to/files.properties

---

Environment Variables

You can inject environment variables via the .env.{key} syntax.

.env.user_name = USER_NAME

You cannot inject an environment variable into a string of text

For example, this is not currently supported:

    key =  "Lorem ipsum dolor sit amet, ${ENVIRONMENT_VARIABLE} consectetur adipiscing elit "