listmonk/docs/site/layouts/index.html

{{ partial "header.html" . }}
<div class="splash container center">
      <img class="s4" src="static/images/s4.png" />
      <div class="hero">
        <h1 class="title">Self-hosted newsletter and mailing list manager</h1>
        <h3 class="sub">
          Performance and features packed into a single binary.<br />
          <strong>Free and open source.</strong>
        </h3>
        <p class="center demo">
          <a href="https://demo.listmonk.app" class="button">Live demo</a>
        </p>
      </div>

      <div class="confetti">
        <img class="s1" src="static/images/s1.png" />
        <img class="s2" src="static/images/s2.png" />
        <img class="s3" src="static/images/s3.png" />
        <img class="box" src="{{ .Site.BaseURL }}static/images/splash.png" alt="listmonk screenshot" />
      </div>
  </div>
</div>

<section id="download">
  <div class="container">
    <h2 class="center">Download</h2>
    <p class="center">
      The latest version is <strong>{{ .Page.Site.Data.github.version }}</strong>
      released on {{ .Page.Site.Data.github.date | dateFormat "02 Jan 2006" }}.
      See <a href="{{ .Page.Site.Data.github.url }}">release notes.</a>
    </p><br />

    <div class="row">
      <div class="col-6">
        <div class="box">
          <h3>Binary</h3>
          <ul class="install-steps">
            <li class="download-links">Download binary:<br />
              {{ range.Page.Site.Data.github.assets }}
                <a href="{{ .url }}">{{ .name | title }}</a>
              {{ end }}
            </li>
            <li>
              <code>./listmonk --new-config</code> to generate config.toml. Edit the file.
            </li>
            <li><code>./listmonk --install</code> to setup the Postgres DB (⩾ v9.4) or <code>--upgrade</code> to upgrade an existing DB.</li>
            <li>Run <code>./listmonk</code> and visit <code>http://localhost:9000</code></li>
          </ul>
          <p><a href="/docs/installation">Installation docs &rarr;</a></p>

          <br />
          <h3>Hosting providers</h3>
          <a href="https://railway.app/new/template/listmonk"><img src="https://camo.githubusercontent.com/081df3dd8cff37aab35044727b02b94a8e948052487a8c6253e190f5940d776d/68747470733a2f2f7261696c7761792e6170702f627574746f6e2e737667" alt="One-click deploy on Raleway" style="max-height: 32px;" /></a>
          <br />
          <a href="https://www.pikapods.com/pods?run=listmonk"><img src="https://www.pikapods.com/static/run-button.svg" alt="Deploy on PikaPod" /></a>
          <br />
          <a href="https://dash.elest.io/deploy?soft=Listmonk&id=237"><img height="33" src="https://github.com/elestio-examples/wordpress/raw/main/deploy-on-elestio.png" alt="Deploy on Elestio" /></a>
        </div>
      </div>
      <div class="col-6">
        <div class="box">
          <h3>Docker</h3>
          <p><a href="https://hub.docker.com/r/listmonk/listmonk/tags?page=1&ordering=last_updated&name=latest"><code>listmonk/listmonk:latest</code></a></p>
          <p>
            Use the sample <a href="https://github.com/knadh/listmonk/blob/master/docker-compose.yml">docker-compose.yml</a> 
            to run manually or use the helper script.
          </p>
          <h4>Demo</h4>
<pre>mkdir listmonk-demo && cd listmonk-demo
sh -c "$(curl -fsSL https://raw.githubusercontent.com/knadh/listmonk/master/install-demo.sh)"</pre>
          <p>
            (DO NOT use this demo setup in production)
          </p>

          <h4>Production</h4>
<pre>mkdir listmonk && cd listmonk
sh -c "$(curl -fsSL https://raw.githubusercontent.com/knadh/listmonk/master/install-prod.sh)"</pre>
          <p>Visit <code>http://localhost:9000</code></p>

          <p><a href="/docs/installation">Installation docs &rarr;</a></p>

          <p class="small">NOTE: Always examine the contents of shell scripts before executing them.</p>
        </div>
      </div>
    </div>
  </div>
</section>

<div class="container">
  <section class="lists feature">
    <h2>Mailing lists</h2>
    <div class="center">
      <img class="box" src="static/images/lists.png" alt="Screenshot of list management feature" />
    </div>
    <p>
      Manage millions of subscribers across many single and double opt-in lists
      with custom JSON attributes for each subscriber.
      Query and segment subscribers with SQL expressions.
    </p>
    <p>Use the fast bulk importer (~10k records per second) or use HTTP/JSON APIs or interact with the simple
      table schema to integrate external CRMs and subscriber databases.
    </p>
  </section>

  <section class="tx feature">
    <h2>Transactional mails</h2>
    <div class="center">
      <img class="box" src="static/images/tx.png" alt="Screenshot of transactional API" />
    </div>
    <p>
      Simple API to send arbitrary transactional messages to subscribers
      using pre-defined templates. Send messages as e-mail, SMS, Whatsapp messages or any medium via Messenger interfaces.
    </p>
  </section>

  <section class="media feature">
    <h2>Analytics</h2>
    <div class="center">
      <img class="box" src="static/images/analytics.png" alt="Screenshot of analytics feature" />
    </div>
    <p class="center">
      Simple analaytics and visualizations. Connect external visualization programs to the database easily with the simple table structure.
    </p>
  </section>

  <section class="templating feature">
    <h2>Templating</h2>
    <div class="center">
      <img class="box" src="static/images/templating.png" alt="Screenshot of templating feature" />
    </div>
      <p>
        Create powerful, dynamic e-mail templates with the <a href="https://golang.org/pkg/text/template/">Go templating language</a>.
        Use template expressions, logic, and 100+ functions in subject lines and content.
        Write HTML e-mails in a WYSIWYG editor, Markdown, raw syntax-highlighted HTML, or just plain text.
      </p>
  </section>

  <section class="performance feature">
    <h2>Performance</h2>
    <div class="center">
      <figure class="box">
        <img src="static/images/performance.png" alt="Screenshot of performance metrics" />

        <figcaption>
          A production listmonk instance sending a campaign of 7+ million e-mails.<br />
          CPU usage is a fraction of a single core with peak RAM usage of 57 MB.
        </figcaption>
      </figure>
    </div>
    <br />
    <p>
      Multi-threaded, high-throughput, multi-SMTP e-mail queues.
      Throughput and sliding window rate limiting for fine grained control.  
      Single binary application with nominal CPU and memory footprint that runs everywhere.
      The only dependency is a Postgres (⩾ 12) database.
    </p>
  </section>

  <section class="media feature">
    <h2>Media</h2>
    <div class="center">
      <img class="box" src="static/images/media.png" alt="Screenshot of media feature" />
    </div>
    <p class="center">Use the media manager to upload images for e-mail campaigns
      on the server's filesystem, Amazon S3, or any S3 compatible (Minio) backend.</p>
  </section>

  <section class="lists feature">
    <h2>Extensible</h2>
    <div class="center">
      <img class="box" src="static/images/messengers.png" alt="Screenshot of Messenger feature" />
    </div>
    <p class="center">
      More than just e-mail campaigns. Connect HTTP webhooks to send SMS,
      Whatsapp, FCM notifications, or any type of messages.
    </p>
  </section>

  <section class="privacy feature">
    <h2>Privacy</h2>
    <div class="center">
      <img class="box" src="static/images/privacy.png" alt="Screenshot of privacy features" />
    </div>
    <p class="center">
      Allow subscribers to permanently blocklist themselves, export all their data,
      and to wipe all their data in a single click.
    </p>
  </section>

  <h2 class="center">and a lot more &hellip;</h2>

  <div class="center">
    <br />
    <a href="#download" class="button">Download</a>
  </div>

  <section class="banner">
    <div class="row">
      <div class="col-2">&nbsp;</div>
      <div class="col-8">
        <div class="confetti">
          <img class="s2" src="static/images/s3.png" />
          <div class="box">
            <h2>Developers</h2>
            <p>
              listmonk is free and open source software licensed under AGPLv3.
              If you are interested in contributing, check out the <a href="https://github.com/knadh/listmonk">GitHub repository</a>
              and refer to the <a href="/docs/developer-setup">developer setup</a>.
              The backend is written in Go and the frontend is Vue with Buefy for UI. 
            </p>
          </div>
        </div>
      </div>
      <div class="col-2">&nbsp;</div>
    </div>
  </section>
</div>

{{ partial "footer.html" }}