fraxplus/calculator repository overview

⁠FRAXplus® calculator

This is the docker image of the FRAXplus® application available at https://fraxplus.org⁠.
In order to run it, you'll need a valid licence.

⁠Prerequisites

• Starting FRAXplus requires a standardized execution platform: Docker. Please refer to https://docs.docker.com/get-docker/⁠ to follow the installation procedure on your system.
• Suscribe to https://fraxplus.org⁠
• Get a valid licence. You'll need it to activate this application.

⁠Running the image

Once Docker Desktop is running on your computer, open a command line and type this:

docker run -d -p 8085:8085 -v fraxplus:/app/data --name fraxplus fraxplus/calculator

That's it, the FRAX plus® calculator is now running locally on your computer.

⁠Licence activation

⁠Activate my product online

In order to activate the Docker version, you will need an active subscription.

• After completing the installation guide⁠, navigate to the web interface (by default: http://localhost:8085).
• A screen will invite you to Activate your product, click the Activate online button.
• You will be redirected to fraxplus.org⁠ and invited to log in, if you are not already.
• If a valid licence is found for your account, you are redirected back to your instance (by default: http://localhost:8085) where you can see that your product has been activated

⁠Activate my product offline

If you are denied to browse to fraxplus.org⁠ while activating your product, you can activate it manually with another device.

• After completing the installation guide⁠, navigate to the web interface (by default: http://localhost:8085).
• A screen will invite you to Activate your product, copy the Request code.
• On another device with internet access, browse to fraxplus.org/my-account/manual-licence-activation⁠ to get your personal licence activation code.
• Get back to your running container (by default: http://localhost:8085), enter your licence activation code and click the Activate manually button.

⁠Activate licence through CLI

• Get the running container's licence status, and licence request code:

docker exec fraxplus node calculator.js --licence-status

• On another device with internet access, browse to fraxplus.org/my-account/manual-licence-activation⁠ to get your personal licence activation code.
• Activate your container's licence:

docker exec fraxplus node calculator.js --licence-activate <activation code>

• Stop and remove the container

docker stop fraxplus
docker rm fraxplus

• Restart the container as described above, with the parameter you did have.

⁠Update my licence

If you need to see the status of your licence or apply a new one to your running container:

• navigate to the web interface's /licence page (by default: http://localhost:8085/licence).
• Click the Update licence button.

Alternatively, you can run again the Activate licence through CLI⁠ procedure.

⁠Going further

⁠Environment variables

⁠Enable the REST API

This application can be used by both

• the embedded web application available at http://localhost:8085
• the REST API described at http://localhost:8085/api-docs

To gain access to the API, clients must provide an API key that you should define when running the container.

Set FRAX_CALCULATOR_CLIENT_API_KEY to the key your clients should provide:

docker run \
  --detach \
  --publish 8085:8085 \
  --volume fraxplus:/app/data \
  --name fraxplus \
  --env FRAX_CALCULATOR_CLIENT_API_KEY=unicornsAreReal \
  fraxplus/calculator

Clients will have to provide the key as an HTTP header x-api-key:

curl -X 'GET' \
  'http://localhost:8085/api/v1/licence' \
  -H 'accept: application/json' \
  -H 'x-api-key: dev'

⁠Update the docker image

• Pull the latest docker image

docker pull fraxplus/calculator

• Stop and remove the container

docker stop fraxplus
docker rm fraxplus

• Start the container as described above, with the parameter you did have.