Skip to content

Latest commit

 

History

History
74 lines (54 loc) · 1.8 KB

README.md

File metadata and controls

74 lines (54 loc) · 1.8 KB
Raw

mjml-server

A self-hosted alternative to the mjml API. Built with express.

The API is compatible with https://mjml.io/api in that it only exposes one endpoint - /v1/render, but doesn't require authentication. You should probably run this within your own private network.

Why?

You're writing an app in another language than Javascript and need to interop with MJML. Instead of embedding NodeJS in your Python image you can call MJML compilation over HTTP.

You can alternatively use the MJML API, but it's currently invite only and has privacy implications (do you want your emails to be sent to yet another third party?).

For an elaborate discussion see: mjmlio/mjml#340

Usage

docker run -p 8080:80 ghcr.io/anny-co/mjml-server

$ http POST localhost:8080/v1/render
HTTP/1.1 200 OK
Connection: keep-alive
Content-Length: 2141
Content-Type: application/json; charset=utf-8
Date: Mon, 15 Jul 2019 12:26:48 GMT
ETag: W/"85d-hn49R397DBvYcOi5/4cb+gcoi/I"
X-Powered-By: Express

{
    "html": "\n    <!doctype html>\n    ..."
}

Configuration

Configure the server either with environment variables or with a .env file in the server's root directory:

HOST=0.0.0.0
PORT=80

# mjml configuration
KEEP_COMMENTS=true
BEAUTIFY=false
MINIFY=false
VALIDATION_LEVEL=soft # "strict", "soft", "skip"
MAX_BODY=1mb

# authentication configuration
AUTH_ENABLED=false
AUTH_TYPE=none # "basic", "token", "none"
BASIC_AUTH_PASSWORD=
BASIC_AUTH_USERNAME=
AUTH_TOKEN=

Authentication

When exposing the mjml API server to the web, you can opt-in to use authentication.

Available options are

  • (a) HTTP basic auth
  • (b) Predefined token in query parameter ?token or as HTTP header X-Authentication-Token

See the above section for required configuration values.