Edit on GitHub

Amplia - Setup on Docker

To install an on-premises instance of Amplia on Docker, follow the steps below. For other platforms, click here.

Tip

Before you start, make sure you have completed the steps outlined on Planning before installation

For Docker-based setup the following image is provided on Docker Hub:


Amplia Docker image

The current recommended image is lacunasoftware/amplia:4.8

Featured image tags:

  • Tag 4.8 points to the latest 4.8.x image (recommended)
  • Tag 4 points to the lastest 4.x image
  • Tag stable points to the latest stable image

Note

To test the upcoming version of Amplia, currently in Release Candidate state, use the image lacunasoftware/amplia:4.9.0-rc05 instead. Beware: Release Candidate versions are not production-ready and thus should only be installed on staging or test environments.

This image requires:

Configuration

The container for this image is configured using environment variables. Get the sample environment file for a template to fill in the image's settings.

To fill the General__EncryptionKey setting, generate a 256-bit key to encrypt sensitive data stored on the database:

docker run lacunasoftware/amplia:4.8 -- gen-enc-key

To fill the General__RootPasswordHash setting, choose a strong password for root access to the dashboard and hash it:

docker run -i lacunasoftware/amplia:4.8 -- hash-root-pass
Note

If you wish to enable user management, leave the General__RootPasswordHash setting blank and follow the steps on Configure OpenID Connect instead

Exposed ports

The Amplia image listens on port 80.

You should set up a reverse proxy or load balancer listening on both default ports for HTTP (80) and HTTPS (443), redirecting traffic on both ports to Amplia's port 80. Additionaly, your setup should fill the request headers X-Forwarded-Proto, X-Forwarded-For and X-Forwarded-Port. The configuration Bindings__UseReverseProxy=True tells Amplia that the information on these headers should be trusted.

Example

In a production environment you would typically use a Docker orchestrator and a dedicated SQL Server (or a IaaS database offering), but for testing purposes you can run an instance of Amplia with an instance of SQL Server Express (which is free) with Docker alone.

Start by creating a volume for the database server:

docker volume create amplia_sql

Then, start it with a password of your choice (replace SOME_PASS below):

docker run -v amplia_sql:/var/opt/mssql -p 1433:1433 -e "MSSQL_PID=Express" -e "SA_PASSWORD=SOME_PASS" -e "ACCEPT_EULA=Y" mcr.microsoft.com/mssql/server:2019-latest

Check the console for any errors. This can take a few minutes.

Once SQL Server is up and running, open another terminal to start the Amplia instance.

Create a volume to use as blob storage:

docker volume create amplia_data

Then, download the sample environment file, save it with name amplia.env and fill it out.

On the connection string configuration, use the value below replacing HOST_IP with the IP address of the host and SOME_PASS with the password you chose for the SQL Server:

ConnectionStrings__DefaultConnection=Data Source=HOST_IP;Initial Catalog=Amplia;User ID=sa;Password=SOME_PASS

On the blob storage configuration, leave the default settings, since we'll mount the created volume on /var/app:

BlobStorage__Type=FileSystem
BlobStorage__Path=/var/app

Now, let's run the container with the configuration file, mounting the volume amplia_data on /var/app and exposing the app (which listens on port 80) on the host's port 8080:

docker run --env-file amplia.env -v amplia_data:/var/app -p 8080:80 lacunasoftware/amplia:4.8
Tip

If given a credential with enough privileges, Amplia will attempt to create the target database on the server (which is what will happen in this case)

Check the console for configuration errors. If everything is configured correctly, you should have a Amplia instance running on localhost:8080

See also