#Install monetr

monetr is completely free to self-host, giving you full control over your data and setup. This guide provides an overview of how to install and run monetr on your own infrastructure.

#Why Self-Host monetr?

Self-hosting monetr offers several advantages:

• Cost-Free Usage: Run monetr without paying subscription fees. Note: If you use Plaid as a data provider, you may incur additional costs. See Plaid’s Pricing for details.
• Full Data Ownership: Keep complete control over your financial data.

Whether you’re interested in hosting your own applications or prefer a private alternative to hosted services, self-hosting gives you more control over your data and setup.

#Requirements for Self-Hosting

Before you begin, ensure you have the following:

• Container Runtime: Docker Compose is the officially supported method for running monetr.
• Server or Host Machine:
  • Recommended: A system with at least 512MB of RAM and 1GB of disk space.
• Database: monetr runs with PostgreSQL, which is included in the Docker Compose setup.
• Domain and SSL (Optional): For public access, consider setting up a domain with HTTPS.

#Installation Options

Currently, monetr only officially supports container-based installations:

#Install via Docker Compose

The easiest way to self-host monetr is by using Docker Compose. This setup includes all necessary services, such as the monetr application and PostgreSQL.

#Install on Kubernetes

If you are looking to deploy monetr on a Kubernetes cluster, there is a very basic guide on how to do so. This is not the recommended way to run monetr at this time. A helm chart will be available in the future, but this guide has been made available until then.

#Verify Images

Starting in version v1.14.0 all monetr container images that are distributed are signed at build time using cosign. Build attestations are also published for the containers themselves and can be used to verify them before running.

Note: Container images shipped prior to v1.14.0 do not have signatures published for them and cannot be verified using either of the following two methods!

#Verify using cosign

To verify a monetr container image using cosign, first make sure you have cosign installed. Follow the directions here to get started.

Once cosign is installed you can run the following command against the desired container image version to verify it's signature.

cosign verify \
  --certificate-identity-regexp '^https://github.com/monetr/monetr/' \
  --certificate-oidc-issuer https://token.actions.githubusercontent.com \
  ghcr.io/monetr/monetr:1.14.0

Make sure to replace the version of the container image with the version you want to verify. This can also be used to verify container images from any of the supported container registries that monetr pushes to.

#Verify using GitHub CLI

Verifying the container image using the GitHub CLI is similar, once it is installed you can run the following command. Replacing the version of the container with the version you are trying to verify.

gh attestation verify \
  --repo monetr/monetr \
  oci://ghcr.io/monetr/monetr:1.14.0

#What’s Next?

After installing monetr, you can:

• Configure it for your specific needs. See Configuration.
• Explore advanced hosting options like reverse proxies or custom domains.
• Explore available resources for feedback and support, including documentation updates and support channels.

For detailed steps, visit the full Docker Compose Installation Guide.