Once you have configured your YAML file to include all the configuration changes needed, you can apply them by following the steps using the different YAML configuration files described below.
Modifying the Access configurations is an advanced feature, and if done incorrectly may render Access in an undefined and unusable state. Since it is easy to overwrite configurations, we strongly recommend backing up the configuration YAML file before making any direct changes, and taking great care when doing so.
There are several configuration files that may found under the $ACCESS_HOME/etc folder:
|If this file exists, it is the configuration file that the Access services actually imports when restarted. It is the values in this file that will determine the Access service configuration. If the file does not exist, Access will load with its latest configuration settings.|
This is a template file provided upon installation. It includes default values for a variety of configuration parameters, as well as simple examples for others.
|This file shows which configuration parameters are different from the default values in the current Access configuration. This is the file you should be editing and renaming to access.config.import.yml if you wish to make configuration changes|
|This file shows previous versions of the |
To setup your Access configuration files, you need to work with the above YAML files in the following way:
Find the Key for which you would like to change the Value and copy it
Paste the Key - Value pair you copied and set the relevant value as desired
access.config.latest.yml file as
Restart Access by restarting the corresponding Artifactory service
Note that an uploaded configuration file does not update the current configuration in Access, but rather completely replaces it.
You may configure synchronization as often as you want and with any combination of parameters.
To change the setting of
number-of-retries from 3 (the default) to 5, you would take the following steps:
access.config.template.ymland copy the
number-of-retries: 3Key-Value pair.
access.config.latest.yml,change the value of
access.config.latest.yml as access.config.import.yml
Every time you change the Access configuration by loading a new
access.config.import.yml file, Access stores the current configuration, before it is replaced, in an
At any time, if you want to revert to a previous configuration:
access.config.latest.<timestamp>.ymlfile with the relevant timestamp.
Below is an example of a complete YAML file showing all the different parameters that you may configure
# DO NOT IMPORT THIS FILE. # This file describes the JFrog Access YAML configuration file and should only be # as a reference. # # To change the configuration in an Access service, follow these instructions: # 1. Find the value you want to update # 2. Set the value in the access.config.latest.yml file under [access-home]/etc # 3. Change access.config.latest.yml to access.config.import.yml # 4. Restart Access --- security: password-policy: # users' password policy uppercase: 0 # minimum number of uppercase letters that the password must contain lowercase: 0 # minimum number of lowercase letters that the password must contain digit: 0 # minimum number of digits that the password must contain length: 4 # minimum length of the password not-match-old: true # should access allow setting a new password to the same one currently set for the user user-lock-policy: attempts: 0 # number of failed login attempts to allow before locking a user. 0 (default) means the feature is disabled seconds-to-unlock: 0 # number of seconds to wait before re-enabling login for a user that has been locked out password-expiry-days: 0 # number of days before a password expires. Set by Artifactory admin-password-expirable: false # does the access admin password expire audit: enabled: true # should access log all requests to a specific file or not password-strength: 8 # bcrypt password strength. A higher value means better security, but password verification will be slower local-interfaces-expire-in-seconds: 60 * 10 # number of seconds for which local server ips should be cached for users’ allowed-ips encryption-enabled: true # specifies if users’ custom data encryption is allowed http: port: 8340 # access port tls-enabled: true # specifies if https should be enabled or not grpc: port: 0 # the grpc port. 0 indicates that Access should find a random available port grpc-enabled: false # specifies if grpc is enabled. Default - false token: refresh-expiry: 86400 # grace period (seconds) during which an expired token can still be refreshed default-expiry: 3600 # default expiry period (seconds) when token expiry is set to null cache: expire-after-write-seconds: 60 # number of seconds Access waits before deleting an entry from the cache maximum-size: 1000 # maximum number of tokens Access allows in the cache revocation: minimum-revocable-expiry: -1 # (seconds) token with lifespan (issuedAt-expiry) below this value will not be revocable. (tokens without expiry are always revocable) set to -1 to make all tokens with expiry non-revocable (default). task: revoke-expired-tokens-cron: "0 0 0/1 * * ?" # cron expression defining when the "revoke expired token" job should run heartbeat: interval-seconds: 5 # interval between successive runs of the heartbeat job consider-stale-seconds: 30 # the time period (seconds) a server can remain unresponsive before being considered stale in the cluster cluster: sync: timeout-millis: 100 # initial time (ms) to wait before retrying a request socket-timeout-millis: 5000 # time to wait (ms) before giving up on executing a REST call on another server exponential-backoff-multiplier: 2 # number by which the retry timeout should be multiplied before a subsequent retry. For example, by default, the third retry will happen after 200 ms number-of-retries: 3 # maximum number of retries backoff-max-delay-millis: 1000 # maximum time between successive retries regardless of other settings federation: outbound: # outbound configuration specifies parameters for sending data entity-types-to-sync: # entity types to sync as part of federation (default - used if not configured for server) - users - groups - permissions - tokens buffer-wait-millis: 30000 # amount of time (ms) data should be accumulated before being sent buffer-max-size: 500 # maximum number of events that can be accumulated before triggering sending of data consider-stale-hours: 168 # time (hours) server can remain unresponsive before being considered stale maximum-future-time-diff-millis: 60000 # maximum difference between received data timestamp to current timestamp of the server that is allowed timeout-millis: 3000 # initial wait between retries exponential-backoff-multiplier: 2 # number by which the retry timeout should be multiplied before a subsequent retry. For example, by default, the third retry will happen after 6000 ms number-of-retries: 3 # maximum number of retries backoff-max-delay-millis: 10000 # maximum time between successive retries regardless of other settings delay-on-error-millis: 300000 # time to wait (ms) after an error occurred socket-timeout-millis: 5000 # time to wait (ms) before giving up on executing a REST call on another server servers: - name: hello-1 # the name of the target server url: "http:#example.com/access" # the target server url active: true # whether the federation to this server is enabled or not entity-types-to-sync: # entity types to sync as part of federation. if not configured - fallback to outbound entity types to sync - users - groups - permissions - tokens permission-filters: # include and exclude patterns filtering permissions to federate per server include-patterns: - ".*a.*" - ".*b.*" exclude-patterns: - ".*aa.*" - name: hello-2 # you can configure any number of target servers url: "http:#example2.com/access" inbound: # inbound configuration specifies receiving data number-of-retries: 3 # number of retries to consume the incoming data service-id-mapping: - from: jfrt@1234567890abcdef # service id to change from for permissions and tokens to: jfrt@fedcba0987654321 # service id to change to - from: jfbt@abcdefabcdefabcdef # any number of server mappings can be specified to: jfbt@aaaaaaaaaaaaaaaaa licenses: # should only be set by Artifactory server-name: "hello" # the id of the server key: "verylonglicense" # the license max-config-files-to-retain: 10 # maximum number of configuration file versions to save after being updated schema-version: 1 # internal for future use do-not-import-this-file # Ignore: a marker to prevent import of this file