qmcgaw/meemo

By qmcgaw

Updated over 3 years ago

Runs a lightweight Meemo server with database on Docker with docker-compose

Image
4

100K+

Meemo on Docker

Lightweight Meemo 1.13.0 server with database on Docker with docker-compose

Manage your todo list, bookmarks and data in the Markdown format with Meemo

Docker Meemo

Build statusDocker PullsDocker StarsImage sizeImage version

Join Slack channelGitHub last commitGitHub commit activityGitHub issues

Donate PayPal

Features

  • Lightweight (uncompressed amd64) size of 114MB
  • Based on:
  • Compatible with amd64, 386, arm64, arm32v7 and arm32v6 CPU architectures

It also depends on a MongoDB database which is launched with Docker Compose.

Setup

  1. Ensure Docker and Docker-Compose are installed

  2. On your host machine, create the following files and directories

    # users file
    touch users.json
    # data and database directory
    mkdir data database
    # set ownership to map container user ID 1000
    chown 1000 users.json data database
    # set permissions
    chmod 400 users.json
    chmod 700 data database
    
  3. Download docker-compose.yml on your host, modify it as you wish:

    wget https://raw.githubusercontent.com/qdm12/meemo/master/docker-compose.yml
    vi docker-compose.yml
    # For ARM, you might change the mongo image to an ARM mongo image
    
  4. Launch the MongoDB database and Meemo container with

    docker-compose up -d
    
  5. You can check logs with

    docker-compose logs -f
    
  6. Meemo is at localhost:3000 (depending on your mapped port in docker-compose.yml)

Configuration

Provided your Meemo container is still named meemo, the shell script commands.sh can be executed on your host.

The following options are provided:

  • List users

    ./commands.sh ls
    
  • Add user

    ./commands.sh add username password
    
  • Edit user

    ./commands.sh edit username password
    
  • Remove user

    ./commands.sh remove username
    

All the changes are saved to users.json

Environment variables

Environment variableDefaultDescription
PORT3000TCP port to listen on internally (should not be changed)
BIND_ADDRESS0.0.0.0 (all)Address to listen on internally (should not be changed)
CLOUDRON_APP_ORIGINhttp://localhostUsed to share tasks etc.
CLOUDRON_MONGODB_URLmongodb://mongodb:27017/meemoLocation of the Mongo database (should not be changed)
ATTACHMENT_DIR/dataAttachment storage directory (should not be changed)
LOCAL_AUTH_FILE/users.confUsers configuration file location (should not be changed)
NODE_ENVproductionShould not be changed

TODOs

  • Mail environment variables & test
  • LDAP environment variables & test
  • Build binary meemo + Scratch container

License

This repository is under an MIT license

Docker Pull Command

docker pull qmcgaw/meemo