While using Docker is not necessary for this project, it simplifies deployment for a variety of environments. The pre-built Docker images are available on the GitHub Container Registry.

​
Tags

Docker TagsDescription
ghcr.io/medama-io/medama:latestLatest stable release.
ghcr.io/medama-io/medama:edgeLatest development build.
ghcr.io/medama-io/medama:<version>Specific version.
ghcr.io/medama-io/medama:sha-<commit-sha>Specific commit (short format).

​
Setup

1

Run Container

2

Configure Deployment

Before you can start collecting data, you may want to configure your analytics instance to suit your needs. It is recommended to refer to the Environment Variables configuration page.

These variables can be set using the -e flag in docker run or the environment property in Docker Compose.

Afterwards, ensure your analytics instance is configured to be accessible from the internet. You must also set up SSL certificates for your deployment.

3

Add Your First Website

Success! You can now add your first website to the analytics instance by visiting the web interface at http://localhost:8080 or the publicly accessible hostname for your deployment.

The default login credentials are:

  • Username: admin
  • Password: CHANGE_ME_ON_FIRST_LOGIN
To successfully login, you must either use localhost or a HTTPS connection. Logging in via an unencrypted HTTP connection will not work.

If your hosting provider does not automatically provision SSL certificates to your machine, you may want to use the automatic SSL setup feature.
It is recommended to change the username and password immediately after logging in for the first time. This can be changed in the settings menu.
4

Embed Tracking Snippet

Then, embed the following HTML tracking snippet in the <head> element of your website to start collecting data:

<script defer src="https://[your-public-api-hostname].com/script.js"></script>
Learn more about configuring your tracking snippet here.