Phoebus save-and-restore

List of NixOS options related to the Phoebus save-and-restore service. For how to use them, examine the Phoebus save-and-restore setup user guide.

services.phoebus-save-and-restore
services.phoebus-save-and-restore.enable boolean[source]

Whether to enable the Phoebus Save-and-restore service.

This service is used by clients to manage configurations (aka save sets) and snapshots, to compare snapshots, and to restore PV values from snapshots.

Default value
false
Example
true
services.phoebus-save-and-restore.openFirewall boolean[source]

Open the firewall for the Phoebus Save-and-restore service.

Warning

This opens the firewall on all network interfaces.

Default value
false
services.phoebus-save-and-restore.settings attribute set of (string, package, bool, int or float)[source]

Configuration for the Phoebus Save-and-restore service.

These options will be put into a .properties file.

Note that options containing a “.” must be quoted.

Available options can be seen here: https://github.com/ControlSystemStudio/phoebus/blob/v5.0.0/services/save-and-restore/src/main/resources/application.properties

Default value
{ }
services.phoebus-save-and-restore.settings."auth.impl" one of "ad", "ldap", "ldap_embedded", "demo"[source]

Authentication implementation.

Supported options:

"ad"

Microsoft Active Directory

"ldap"

LDAP

"ldap_embedded"

Embedded LDAP. Config in sar.ldif

"demo"

Hard coded users and passwords. Provides 3 users:

  • an admin

  • a read-only user

  • a normal user

See the following options:

services.phoebus-save-and-restore.settings."demo.admin" string[source]

Username for the admin demo user.

Only valid for if "auth.impl" is "demo".

Default value
"admin"
services.phoebus-save-and-restore.settings."demo.admin.password" string[source]

Password for the admin demo user.

Only valid for if "auth.impl" is "demo".

Default value
"adminPass"
services.phoebus-save-and-restore.settings."demo.readOnly" string[source]

Username for the normal demo user.

Only valid for if "auth.impl" is "demo".

Default value
"johndoe"
services.phoebus-save-and-restore.settings."demo.readOnly.password" string[source]

Password for the read-only demo user.

Only valid for if "auth.impl" is "demo".

Default value
"1234"
services.phoebus-save-and-restore.settings."demo.user" string[source]

Username for the normal demo user.

Only valid for if "auth.impl" is "demo".

Default value
"user"
services.phoebus-save-and-restore.settings."demo.user.password" string[source]

Password for the normal demo user.

Only valid for if "auth.impl" is "demo".

Default value
"userPass"
services.phoebus-save-and-restore.settings."elasticsearch.http.port" 16 bit unsigned integer; between 0 and 65535 (both inclusive)[source]

Elasticsearch server port.

Default value
config.services.elasticsearch.port
services.phoebus-save-and-restore.settings."elasticsearch.network.host" string[source]

Elasticsearch server host.

If localhost (the default), the Elasticsearch service will be automatically set up.

Default value
"localhost"
services.phoebus-save-and-restore.settings."server.port" 16 bit unsigned integer; between 0 and 65535 (both inclusive)[source]

Port for the Save-and-restore service

Default value
8080
services.phoebus-save-and-restore.settings."spring.ldap.embedded.ldif" string[source]

Path to LDIF file describing the content of the embedded LDAP server.

Only valid for if "auth.impl" is "embedded_ldap".

Default value
"classpath:sar.ldif"
Example
"file://${./sar.ldif}"