-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc/nixos/phoebus-save-and-restore: init guide
- Loading branch information
1 parent
0e4aa9f
commit 6d94036
Showing
2 changed files
with
51 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
--- | ||
title: Phoebus Save-and-restore setup | ||
--- | ||
|
||
The Phoebus Save-and-restore service is used by clients | ||
to manage configuration and snapshots of PV values. | ||
These snapshots can then be used by clients for comparison or for restoring PVs. | ||
|
||
This guide focuses on installing and configuring the Save-and-Restore service on a single server. | ||
|
||
For more details and documentation about Phoebus Save-and-Restore, | ||
you can examine the [Save-and-restore official documentation]. | ||
|
||
[Save-and-restore official documentation]: https://control-system-studio.readthedocs.io/en/latest/services/save-and-restore/doc/index.html | ||
|
||
{{< include _pre-requisites.md >}} | ||
|
||
# Enabling the Phoebus Save-and-restore service | ||
|
||
To enable the Phoebus Save-and-restore service, | ||
add this to your configuration: | ||
|
||
``` nix | ||
{lib, ...}: { | ||
services.phoebus-save-and-restore = { | ||
enable = true; | ||
openFirewall = true; | ||
}; | ||
# Elasticsearch, needed by Phoebus Save-and-restore, is not free software (SSPL | Elastic License). | ||
# To accept the license, add the code below: | ||
nixpkgs.config.allowUnfreePredicate = pkg: | ||
builtins.elem (lib.getName pkg) [ | ||
"elasticsearch" | ||
]; | ||
} | ||
``` | ||
|
||
From the Phoebus graphical client side, | ||
add this configuration | ||
|
||
``` ini | ||
# Replace the IP address with your server's IP address or domain name | ||
org.phoebus.applications.saveandrestore/jmasar.service.url=http://192.168.1.42:8080 | ||
``` | ||
|
||
::: callout-warning | ||
URLs for future versions of Phoebus Save-and-restore will need to change to: | ||
`http://192.168.1.42:8080/save-restore` | ||
::: |