5.5.1 ORF Online Help
Select your ORF version:

Table of Contents

Configuration Subscription: General Information

The Configuration Subscription feature allows you to synchronize a publisher configuration over multiple ORF installations. This is useful if you manage multiple ORF servers and do not want to update the configuration of each instance one-by-one every time something needs to be changed.

Terminology

ORF calls the server which has the configuration to be synchronized a publisher, while servers who pull the configuration from the publisher are called subscribers.

Synchronization Process

The subscriber fetches the configuration from the publisher, then polls it once per minute to check whether the publisher configuration has been changed. If it has, it retrieves the new configuration and updates itself. If no changes have been made or the synchronization is prevented by something, the subscriber will continue using its current configuration till the next successful sync attempt.

Localization

Upon successful synchronization all settings are overwritten by the publisher configuration on the subscribers by default, but as this could be problematic in some scenarios, you can configure exceptions: this is called localization, i.e., when you force a setting to be permanent (and editable) on the local subscriber, and ignore the setting propagated by the publisher.

You can localize specific settings (e.g., which tests to run, or what do with blacklisted emails) and file paths (e.g., where to store the logs and reports). The first are called local features, the latter are called local paths. You can read more about these in the Local Features and Local Paths topics.

Setting Up Configuration Subscription

The publisher server should have the Remote Access feature enabled, and the subscriber server should be listed as an allowed host (see Allowed Hosts and Services).

Publisher configuration

1
Enable the Remote Access feature on the publisher server (Administration Tool: SystemRemote Access page, Enable Remote Access)
2
Specify on which interfaces and ports the subscriber can connect to your server (Administration Tool: SystemRemote Access page, Local Bindings)
3
Specify the hosts which can synchronize with the publisher (Administration Tool: SystemRemote Access page, Allowed IPs)
4
Set a password for remote connections (Administration Tool: SystemRemote Access page, Set password)
5
Save your settings to apply the changes (Administration Tool: FileSave Configuration...)

Subscriber configuration

1
Configure the access parameters of the publisher server on the Configuration Subscription page (Administration Tool: SystemConfiguration Subscription page, Publisher Access)
2
If the subscriber is connecting through a proxy server to the publisher, configure the proxy settings as well (Administration Tool: SystemConfiguration Subscription page, Proxy Settings)
3
Specify the local paths if you want to store specific ORF files on the subscriber in a different folder than on the publisher (Administration Tool: SystemConfiguration Subscription page, Local Paths)
4
Specify which features should be localized (i.e., to ignore the configuration of the publisher) (Administration Tool: SystemConfiguration Subscription page, Local Features)
5
Save your settings to apply the changes (Administration Tool: FileSave Configuration...)
Copyright © Vamsoft Kft. All rights reserved. Document ID configsync-general, version 1.