Skip to content

Commit

Permalink
Merge pull request #3047 from nscuro/api-key-prefix
Browse files Browse the repository at this point in the history
Add documentation for API key prefix, and set default to `odt_`
  • Loading branch information
nscuro authored Sep 23, 2023
2 parents bad108d + 3ade7d4 commit 593ab00
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 25 deletions.
18 changes: 6 additions & 12 deletions docs/_docs/getting-started/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,12 @@ alpine.data.directory=~/.dependency-track
# Default is "<alpine.data.directory>/keys/secret.key".
# alpine.secret.key.path=/var/run/secrets/secret.key

# Optional
# Defines the prefix to be used for API keys. A maximum prefix length of 251
# characters is supported.
# The prefix may also be left empty.
alpine.api.key.prefix=odt_

# Required
# Defines the interval (in seconds) to log general heath information. If value
# equals 0, watchdog logging will be disabled.
Expand Down Expand Up @@ -162,18 +168,6 @@ alpine.database.pool.max.lifetime=600000
# DO NOT CHANGE UNLESS THERE IS A GOOD REASON TO.
# alpine.datanucleus.cache.level2.type=

# Optional
# When authentication is enforced, API keys are required for automation, and
# the user interface will prevent anonymous access by prompting for login
# credentials.
alpine.enforce.authentication=true

# Optional
# When authorization is enforced, team membership for both API keys and user
# accounts are restricted to what the team itself has access to. To enforce
# authorization, the enforce.authentication property (above) must be true.
alpine.enforce.authorization=true

# Required
# Specifies the number of bcrypt rounds to use when hashing a users password.
# The higher the number the more secure the password, at the expense of
Expand Down
19 changes: 6 additions & 13 deletions src/main/resources/application.properties
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,12 @@ alpine.data.directory=~/.dependency-track
# Default is "<alpine.data.directory>/keys/secret.key".
# alpine.secret.key.path=/var/run/secrets/secret.key

# Optional
# Defines the prefix to be used for API keys. A maximum prefix length of 251
# characters is supported.
# The prefix may also be left empty.
alpine.api.key.prefix=odt_

# Required
# Defines the interval (in seconds) to log general heath information.
# If value equals 0, watchdog logging will be disabled.
Expand Down Expand Up @@ -128,19 +134,6 @@ alpine.database.pool.max.lifetime=600000
# DO NOT CHANGE UNLESS THERE IS A GOOD REASON TO.
# alpine.datanucleus.cache.level2.type=

# Optional
# When authentication is enforced, API keys are required for automation,
# and the user interface will prevent anonymous access by prompting for login
# credentials.
alpine.enforce.authentication=true

# Optional
# When authorization is enforced, team membership for both API keys and
# user accounts are restricted to what the team itself has access to.
# To enforce authorization, the enforce.authentication property (above)
# must be true.
alpine.enforce.authorization=true

# Required
# Specifies the number of bcrypt rounds to use when hashing a users password.
# The higher the number the more secure the password, at the expense of
Expand Down

0 comments on commit 593ab00

Please sign in to comment.