Configuration Catalog - Gadreel/dcraft GitHub Wiki

Catalogs are a way to store settings, typically for external services. A highlight is that these settings might vary in action depending on if used with on a test server or on a production server.

Where to add Catalogs

They can be placed at the Site or Server level - see configuration for details on levels.

When a catalog is queried a match is searched for in the current site, then in the root site (if current site is not root) and then the server level.

Catalog Tag

Attributes

  • Name: name for the settings, if there are more than one of the same type use a dash. For example normally there would only be one Facebook entry, but we can have more than one Facebook feed and in that case the Facebook tag on a web page would have an attribute Account with value Feed2. Since Facebook tag usually looks at the catalog named Facebook then with the addition of Account we now query a catalog named Facebook-Feed2 instead of the default catalog name.
  • Use: where to use this catalog. Production, Test or Both are all options
  • Squad: this catalog only matches server's running in the listed squad
  • Team: this catalog only matches server's running in the listed team
  • HubId: this catalog only matches the server with the given hub id

Example

<Catalog Name="name" Use="Production|Test|Both" HubId="id" Team="team" Squad="squad">
	<Settings>
		... xml settings ...
	</Settings>
</Catalog>
⚠️ **GitHub.com Fallback** ⚠️