Binary

Run Marmot directly on a server from the single binary, against a PostgreSQL database you already have.

Install

Homebrew

brew install marmot

Install script

curl -fsSL get.marmotdata.io | sh

Verify scripts

It's good practice to inspect the contents of any script before piping it into bash.

1. 1

   Download the binary

   Download the latest Marmot binary for your platform from GitHub Releases.
2. 2

   Make it executable

   chmod +x marmot

3. 3

   Move to your PATH

   sudo mv marmot /usr/local/bin/

Start the server

1. 1

   Generate an encryption key

   Marmot encrypts the credentials it stores with this key. Keep it somewhere safe, because losing it means re-entering every stored credential:

   marmot generate-encryption-key

2. 2

   Create a config file

   Save your database settings as config.yaml:

   database:
     host: localhost
     port: 5432
     user: marmot
     password: "<database-password>"
     name: marmot

3. 3

   Start the server

   marmot run reads config.yaml from the current directory, or the file you pass with --config:

   export MARMOT_SERVER_ENCRYPTION_KEY="<encryption-key>"
   marmot run --config config.yaml

4. 4

   Sign in

   Open http://localhost:8080 and sign in as admin with the password admin. Marmot asks you to choose a new password straight away.

Without an encryption key

For local development only, Marmot can run without a key and store credentials unencrypted:

server:
  allow_unencrypted: true

database:
  host: localhost
  port: 5432
  user: marmot
  password: "<database-password>"
  name: marmot

Development only

Never set allow_unencrypted: true in production. Every stored credential would be readable by anyone with access to the database.

Next steps

• Configuration reference: every setting and its environment variable.
• Plugins: catalog your first source.
• Single sign-on: let your team sign in with your identity provider.