StackEdit/README.md

StackEdit Docker server

StackEdit v5.14.5 (January 2020) with a Golang HTTP server on Scratch

Image size	RAM usage	CPU usage
34.1MB	7MB	Very low

Features

• Stackedit features
• Lightweight image based on:
  • Stackedit 5.14.5
  • Scratch
  • Golang simple HTTP static server
• Running without root
• Built-in Docker healthcheck
• Nice emojis in the logs...

Setup

1. CLICK IF YOU HAVE AN ARM DEVICE

   You need to build the Docker image yourself using git and docker

   docker build -t qmcgaw/stackedit https://github.com/qdm12/stackedit-docker.git
   

2. Use the following command:

   docker run -d -p 8000:8000/tcp qmcgaw/stackedit
   

   You can also use docker-compose.yml with:

   docker-compose up -d
   

3. Access at http://localhost:8000

Environment variables

Environment variable	Default	Description
LISTENING_PORT	8000	Internal server listening port
ROOT_URL	/	Root URL to use, useful when used with a reverse proxy
NODE_ENV	production	Sets production behavior for stackedit
PANDOC_PATH	pandoc	Non functional yet
WKHTMLTOPDF_PATH	wkhtmltopdf	Non functional yet
USER_BUCKET_NAME	stackedit-users	?
PAYPAL_RECEIVER_EMAIL		Receive Paypal donation email address
DROPBOX_APP_KEY
DROPBOX_APP_KEY_FULL
GITHUB_CLIENT_ID
GITHUB_CLIENT_SECRET
GOOGLE_CLIENT_ID
GOOGLE_API_KEY
WORDPRESS_CLIENT_ID

Acknowledgements

Credits to the developers of StackEdit

TODOs

• Add static binary programs
  • pandoc
  • wkhtmltopdf
• Travis CI build cross CPU arch