WORKERS AHEAD!

You are viewing the development documentation for the Apereo CAS server. The functionality presented here is not officially released yet. This is a work in progress and will be continually updated as development moves forward. You are most encouraged to test the changes presented.

Git Service Registry

This registry reads services definitions from remote or local git repositories. Service definition files are expected to be either JSON or YAML files. The contents of the repository is pulled at defined intervals and changes to service definitions are committed and pushed to the defined remotes.

Support is enabled by adding the following module into the overlay:

<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-git-service-registry</artifactId>
    <version>${cas.version}</version>
</dependency>

implementation "org.apereo.cas:cas-server-support-git-service-registry:${project.'cas.version'}"

dependencyManagement {
    imports {
        mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
    }
}

dependencies {
    implementation "org.apereo.cas:cas-server-support-git-service-registry"
}

dependencies {
    /*
        The following platform references should be included automatically and are listed here for reference only.

        implementation enforcedPlatform("org.apereo.cas:cas-server-support-bom:${project.'cas.version'}")
        implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
        
    */
    implementation "org.apereo.cas:cas-server-support-git-service-registry"
}

The following settings and properties are available from the CAS configuration catalog:

_{The configuration settings listed below are tagged as Required in the CAS configuration metadata. This flag indicates that the presence of the setting may be needed to activate or affect the behavior of the CAS feature and generally should be reviewed, possibly owned and adjusted. If the setting is assigned a default value, you do not need to strictly put the setting in your copy of the configuration, but should review it nonetheless to make sure it matches your deployment expectations.}

cas.service-registry.git.clone-directory.location=

The location of the resource. Resources can be URLs, or files found either on the classpath or outside somewhere in the file system.

In the event the configured resource is a Groovy script, specially if the script set to reload on changes, you may need to adjust the total number of inotify instances. On Linux, you may need to add the following line to /etc/sysctl.conf: fs.inotify.max_user_instances = 256.

You can check the current value via cat /proc/sys/fs/inotify/max_user_instances.

In situations and scenarios where CAS is able to automatically watch the underlying resource for changes and detect updates and modifications dynamically, you may be able to specify the following setting as either an environment variable or system property with a value of false to disable the resource watcher: org.apereo.cas.util.io.PathWatcherService.

org.apereo.cas.configuration.model.SpringResourceProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value. The only possible exception to this rule is when naming actuator endpoints; The name of the actuator endpoints (i.e. ssoSessions) MUST remain in camelCase mode.

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.git.clone-directory.location=...

This is the most common form of property configuration that is recognized by CAS, regardless of the actual property source, which might in fact be managed separately outside the CAS environment, by another system or cloud framework.

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    git: 
      clone-directory: 
        location: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.git.clone-directory.location="..." -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory. Note the placement of the system property which must be specified before the CAS web application is launched.

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_GIT_CLONE_DIRECTORY_LOCATION="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.git.clone-directory.location="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.service-registry.git.private-key.location=

The location of the resource. Resources can be URLs, or files found either on the classpath or outside somewhere in the file system.

You can check the current value via cat /proc/sys/fs/inotify/max_user_instances.

org.apereo.cas.configuration.model.SpringResourceProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.git.private-key.location=...

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    git: 
      private-key: 
        location: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.git.private-key.location="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_GIT_PRIVATE_KEY_LOCATION="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.git.private-key.location="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.service-registry.git.active-branch=master

The branch to checkout and activate, defaults to master.

This setting supports the Spring Expression Language.

org.apereo.cas.configuration.model.support.git.services.GitServiceRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.git.active-branch=master

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    git: 
      active-branch: "master"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.git.active-branch="master" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_GIT_ACTIVE_BRANCH="master"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.git.active-branch="master"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.service-registry.git.branches-to-clone=*

If the repository is to be cloned, this will allow a select list of branches to be fetched. List the branch names separated by commas or use * to clone all branches. Defaults to all branches.

org.apereo.cas.configuration.model.support.git.services.GitServiceRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.git.branches-to-clone=*

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    git: 
      branches-to-clone: "*"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.git.branches-to-clone="*" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_GIT_BRANCHES_TO_CLONE="*"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.git.branches-to-clone="*"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.service-registry.git.repository-url=

The address of the git repository. Could be a URL or a file-system path.

This setting supports the Spring Expression Language.

org.apereo.cas.configuration.model.support.git.services.GitServiceRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.git.repository-url=...

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    git: 
      repository-url: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.git.repository-url="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_GIT_REPOSITORY_URL="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.git.repository-url="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

_{The configuration settings listed below are tagged as Optional in the CAS configuration metadata. This
flag indicates that the presence of the setting
is not immediately necessary in the end-user CAS configuration, because a default value is assigned or
the activation of the feature is not conditionally controlled by the setting value. In other words, you should only include this field in your
configuration if you need to modify the default value or if you need to turn on the feature controlled by the setting.}

cas.service-registry.git.clear-existing-identities=false

When establishing an ssh session, determine if default identities loaded on the machine should be excluded/removed and identity should only be limited to those loaded from given keys.

org.apereo.cas.configuration.model.support.git.services.GitServiceRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.git.clear-existing-identities=...

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    git: 
      clear-existing-identities: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.git.clear-existing-identities="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_GIT_CLEAR_EXISTING_IDENTITIES="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.git.clear-existing-identities="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.service-registry.git.group-by-type=true

Determine whether service definitions in the git repository should be located/stored in groups and separate folder structures based on the service type. @see #getRootDirectory()

org.apereo.cas.configuration.model.support.git.services.GitServiceRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.git.group-by-type=true

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    git: 
      group-by-type: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.git.group-by-type="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_GIT_GROUP_BY_TYPE="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.git.group-by-type="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.service-registry.git.http-client-type=JDK

Implementation of HTTP client to use when doing git operations via http/https. The jgit library sets the connection factory statically (globally) so this property should be set to the same value for all git repositories (services, saml, etc). Not doing so might result in one connection factory being used for clone and another for subsequent fetches. Available values are as follows:

JDK: Built-in JDK http/https client.
HTTP_CLIENT: Apache HTTP Client http/https client.

org.apereo.cas.configuration.model.support.git.services.GitServiceRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.git.http-client-type=JDK

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    git: 
      http-client-type: "JDK"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.git.http-client-type="JDK" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_GIT_HTTP_CLIENT_TYPE="JDK"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.git.http-client-type="JDK"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.service-registry.git.password=

Password used to access or push to the repository.

org.apereo.cas.configuration.model.support.git.services.GitServiceRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.git.password=...

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    git: 
      password: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.git.password="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_GIT_PASSWORD="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.git.password="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.service-registry.git.private-key-passphrase=

Password for the SSH private key.

org.apereo.cas.configuration.model.support.git.services.GitServiceRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.git.private-key-passphrase=...

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    git: 
      private-key-passphrase: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.git.private-key-passphrase="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_GIT_PRIVATE_KEY_PASSPHRASE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.git.private-key-passphrase="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.service-registry.git.push-changes=false

Decide whether changes should be pushed back into the remote repository.

org.apereo.cas.configuration.model.support.git.services.GitServiceRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.git.push-changes=...

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    git: 
      push-changes: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.git.push-changes="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_GIT_PUSH_CHANGES="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.git.push-changes="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.service-registry.git.rebase=false

Whether to rebase on pulls.

org.apereo.cas.configuration.model.support.git.services.GitServiceRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.git.rebase=...

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    git: 
      rebase: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.git.rebase="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_GIT_REBASE="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.git.rebase="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.service-registry.git.root-directory=

Root directory in the git repository structure to track service definition files. This might be most useful if the git repository is tasked with other types of files and configurations and allowing a separate root directory for service definitions provide a clean separation between services files and everything else. This setting may work in concert with #isGroupByType(). If left blank, the root folder of the git repository itself is used as the root directory for service definitions.

org.apereo.cas.configuration.model.support.git.services.GitServiceRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.git.root-directory=...

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    git: 
      root-directory: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.git.root-directory="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_GIT_ROOT_DIRECTORY="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.git.root-directory="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.service-registry.git.sign-commits=false

Whether commits should be signed.

org.apereo.cas.configuration.model.support.git.services.GitServiceRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.git.sign-commits=...

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    git: 
      sign-commits: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.git.sign-commits="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_GIT_SIGN_COMMITS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.git.sign-commits="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.service-registry.git.ssh-session-password=

As with using SSH with public keys, an SSH session with ssh://user@example.com/repo.git must be specified to use password-secured SSH connections.

org.apereo.cas.configuration.model.support.git.services.GitServiceRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.git.ssh-session-password=...

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    git: 
      ssh-session-password: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.git.ssh-session-password="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_GIT_SSH_SESSION_PASSWORD="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.git.ssh-session-password="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.service-registry.git.strict-host-key-checking=true

Whether on not to turn on strict host key checking. true will be "yes", false will be "no", "ask" not supported.

org.apereo.cas.configuration.model.support.git.services.GitServiceRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.git.strict-host-key-checking=true

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    git: 
      strict-host-key-checking: "true"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.git.strict-host-key-checking="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_GIT_STRICT_HOST_KEY_CHECKING="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.git.strict-host-key-checking="true"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.service-registry.git.timeout=PT10S

Timeout for git operations such as push and pull in seconds.

This settings supports the java.time.Duration syntax ^[?].

org.apereo.cas.configuration.model.support.git.services.GitServiceRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.git.timeout=PT10S

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    git: 
      timeout: "PT10S"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.git.timeout="PT10S" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_GIT_TIMEOUT="PT10S"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.git.timeout="PT10S"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.service-registry.git.username=

Username used to access or push to the repository.

org.apereo.cas.configuration.model.support.git.services.GitServiceRegistryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.service-registry.git.username=...

CAS properties can be specified using the YAML syntax:

cas: 
  service-registry: 
    git: 
      username: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.service-registry.git.username="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_SERVICE_REGISTRY_GIT_USERNAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.service-registry.git.username="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

# When establishing an ssh session, determine if default identities loaded on the machine should be excluded/removed and identity should only be limited to those loaded from given keys.
# cas.service-registry.git.clear-existing-identities=false

# Determine whether service definitions in the git repository should be located/stored in groups and separate folder structures based on the service type.
# cas.service-registry.git.group-by-type=true

# Implementation of HTTP client to use when doing git operations via http/https.
# cas.service-registry.git.http-client-type=JDK

# Password used to access or push to the repository.
# cas.service-registry.git.password=

# Password for the SSH private key.
# cas.service-registry.git.private-key-passphrase=

# Decide whether changes should be pushed back into the remote repository.
# cas.service-registry.git.push-changes=false

# Whether to rebase on pulls.
# cas.service-registry.git.rebase=false

# Root directory in the git repository structure to track service definition files.
# cas.service-registry.git.root-directory=

# Whether commits should be signed.
# cas.service-registry.git.sign-commits=false

# As with using SSH with public keys, an SSH session with {@code ssh://user@example.com/repo.git} must be specified to use password-secured SSH connections.
# cas.service-registry.git.ssh-session-password=

# Whether on not to turn on strict host key checking. true will be "yes", false will be "no", "ask" not supported.
# cas.service-registry.git.strict-host-key-checking=true

# Timeout for git operations such as push and pull in seconds.
# cas.service-registry.git.timeout=PT10S

# Username used to access or push to the repository.
# cas.service-registry.git.username=

Configuration Metadata

The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.

Be Selective

This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.

YAGNI

Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.

Naming Convention

Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc.

Note

Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the way you intend.

Validation

Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.

Indexed Settings

CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be incremented by the adopter to allow for distinct multiple configuration blocks.

No Interference!

Be careful to not manually modify the state of the git repository directory that is cloned on the local server. By doing so, you risk interfering with CAS' own service management processes and ultimately may end up corrupting the state of the git repository.

The service registry is also able to auto detect changes as it will pull changes from defined remotes periodically. It will monitor changes to recognize file additions, removals and updates and will auto-refresh CAS so changes may happen instantly.

Troubleshooting

To enable additional logging, configure the log4j configuration file to add the following levels:

...
<Logger name="org.eclipse.jgit" level="debug" additivity="false">
    <AppenderRef ref="casConsole"/>
    <AppenderRef ref="casFile"/>
</Logger>
...