CLI / Binary

Run Marmot directly on your system using the single binary.

Installation

AutomaticManual

Install Marmot with the installation 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

Download the binary

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

2

Make it executable

chmod +x marmot

3

Move to your PATH

sudo mv marmot /usr/local/bin/

---

Quick Start

1

Generate an encryption key

marmot generate-encryption-key

Save this key securely. You'll need it to start the server.

2

Create a config file

Create config.yaml with your database settings:

database:
  host: localhost
  port: 5432
  user: postgres
  password: your-password
  name: marmot

3

Start the server

export MARMOT_SERVER_ENCRYPTION_KEY="your-generated-key"
marmot server --config config.yaml

4

Access the UI

Open http://localhost:8080 in your browser.

Default Credentials

The default username and password is admin:admin. Change this after your first login.

---

Development Mode

For local development, you can skip encryption (credentials stored in plaintext):

server:
  allow_unencrypted: true

database:
  host: localhost
  port: 5432
  user: postgres
  password: password
  name: marmot

marmot server --config config.yaml

Not for Production

Never use allow_unencrypted: true in production environments.

---

Reference

For all configuration options, see the configuration guide.

Next Steps

Add Data with Plugins

Automatically discover assets from your data sources

Configure Authentication

Set up SSO with GitHub, Google, Okta and more