Installation

Run metrd on your own hardware with Docker Compose.

metrd runs as three containers - a database, the API, and the app - started together with Docker Compose.

Requirements

• A machine on your home network with Docker and Docker Compose
• Access to the metrd.io repository(opens in new tab)

Install

git clone https://github.com/ernokieran/metrd.io.git
cd metrd.io
docker compose up -d

Once it's running, open http://localhost:3000/dashboard(opens in new tab) and carry on with Setting Up.

Set an encryption key

metrd encrypts the passwords and API keys you give it. The default key is only there so it starts out of the box, so set your own before you add any integrations. Create a .env file next to docker-compose.yml:

ENCRYPTION_KEY=your-own-key-of-at-least-32-characters

Then run docker compose up -d again. The key needs at least 32 characters and no spaces.

If you change the key later, metrd can't read the credentials it already stored, and you'll need to re-enter them.

Update

Update both containers together:

docker compose pull
docker compose up -d

If only one is updated, metrd shows a message saying which one is out of date.

Stop

docker compose down

Your data is kept. Add -v to delete it and start fresh.