sdmxio/fmrcl repository overview

⁠fmrcl Backup Tool

fmrcl is a command-line tool used to export the full contents of an operational FMR installation to disk and is the basis of the backup and restore process.

An account with administrative privileges on the FMR installation is required.

fmrcl can be run on any machine provided it has network access to the FMR installation's REST API.

⁠Usage

export ADMIN_USER=root
export ADMIN_PASSWORD=******

docker run --rm -v ./:/out sdmxio/fmrcl:latest -u ${ADMIN_USER} -p ${ADMIN_PASSWORD} -url http://registry.example.org

The backup is written to the container's /out directory on which a host volume should be mounted. In the example above, the current working directory is used specified by the -v ./:/out parameter.

⁠FMR installations on 'localhost'

For FMR installations on localhost, the URL should instead use the special hostname host.docker.internal.

Thus http://localhost:8080 becomes http://host.docker.internal:8080.

docker run --rm -v ./:/out sdmxio/fmrcl:latest -u ${ADMIN_USER} -p ${ADMIN_PASSWORD} -url http://host.docker.internal:8080

Using localhost will fail because it references the container rather than host.

⁠Documentation

The FMR Wiki⁠ has full guidance on both the fmrcl tool and FMR's backup and restore process.