8.4.1. NGENEACLIENTCONF

8.4.1.1. SYNOPSIS

The Ngenea Hub client configuration files is used to configure ngclient(1) and transparent_recall(1)

The default config file locations are in the user's HOME directory $HOME/.config/ngenea/ngenea-client.conf, with a global config at /etc/ngenea/ngenea-client.conf.

If both configuration files exist, the user config will take precedence, with the global config used for any values not specified in the user config.

For example

# global config
[settings]
base_url = http://10.172.0.23:8000
site = default

# user config
[settings]
site = mysite

would result in base_url = http://10.172.0.23:8000/api, since it's not specified in the user config, and site = mysite since the value from the user config takes precedence.

NOTE - unless explicitly specified with the --config flag, both ngclient(1) and transparent_recall(1) will use this same default config files.

If a config file is explicitly specified with --config, the default configs will not be considered at all.

Command line options take precedence over any corresponding config file settings.

8.4.1.2. FILE FORMAT

ngenea-client.conf(5) uses an ini-style format.

It is made up of key = value lines under the [settings] section header.

[settings]
client_key = mykey

Boolean type values can be either true, false, yes, or no (case-insensitive)

Additional sections, or unrecognised keys are ignored.

8.4.1.3. PARAMETERS

• base_url

  Base URL of the Ngenea Hub API, which operations will be performed against.

  This can be used to perform Ngenea Hub operations on a remote server.

  If not specified, the default is http://localhost:8000/api

• client_key

  Ngenea Hub authentication client key.

  This can be generated via the Ngenea Hub REST API, or using ngclient(1) authenticate

• site

  The default site to use for workflows.

  For migrate and recall, this is the site where the workflows execute. For send, this is the source site, from which files are sent.

• wait

  Whether to wait for workflows to complete.

  If true (default), tools will wait for the workflow to complete, subject to timeout.

  If false, tools will exit immediately. The workflow will continue to execute independently. In that case, the workflow can be monitored in the Ngenea Hub UI

• timeout

  How long to wait for workflows to complete, in seconds.

  If not set, tools will wait indefinitely.

  If the workflow doesn't complete within the timeout, the client will exit with an error. The workflow itself may continue to execute.

• hydrate

  For ngclient(1) send, controls whether sent files are hydrated on the target.

  If false, files are only reverse stubbed on the target.

• api_secure_verify

  Whether to enable/disable TLS Verification when communicating with Ngenea Hub REST API.

  This is particularly useful when Ngenea Hub REST API is behind a self-signed certificate.

  If false, TLS verification will be disabled.

  If not specified, the default is true.

8.4.1.4. EXAMPLE

[settings]
base_url = http://mypixserver:8000
client_key = ...
site = mysite
wait = true
timeout = 180
hydrate = true
api_secure_verify = true

8.4.1.5. SEE ALSO

ngclient(1), transparent_recall(1)

8.4.1.6. LICENSE

2021 ArcaPix Limited

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

---