https://github.com/qdm12/meemo

Run a lightweight Meemo server with database on Docker with docker-compose
https://github.com/qdm12/meemo

docker docker-compose meemo todo todoapp todolist

Last synced: 7 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/qdm12/meemo
• Owner: qdm12
• License: mit
• Archived: true
• Created: 2018-03-23T18:17:27.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-10-15T15:04:39.000Z (almost 4 years ago)
• Last Synced: 2024-10-23T20:11:41.072Z (12 months ago)
• Topics: docker, docker-compose, meemo, todo, todoapp, todolist
• Language: Dockerfile
• Homepage: https://hub.docker.com/r/qmcgaw/meemo
• Size: 137 KB
• Stars: 21
• Watchers: 4
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: readme.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# Meemo on Docker

*Lightweight Meemo 1.13.2 server with database on Docker with docker-compose*

Manage your todo list, bookmarks and data in the Markdown format with [**Meemo**](https://github.com/nebulade/meemo)

[![Docker Meemo](https://github.com/qdm12/meemo/raw/master/title.png)](https://hub.docker.com/r/qmcgaw/meemo/)

[![Build status](https://github.com/qdm12/meemo/workflows/Buildx%20latest/badge.svg)](https://github.com/qdm12/meemo/actions?query=workflow%3A%22Buildx+latest%22)

[![Docker Pulls](https://img.shields.io/docker/pulls/qmcgaw/meemo.svg)](https://hub.docker.com/r/qmcgaw/meemo)

[![Docker Stars](https://img.shields.io/docker/stars/qmcgaw/meemo.svg)](https://hub.docker.com/r/qmcgaw/meemo)

[![Join Slack channel](https://img.shields.io/badge/slack-@qdm12-yellow.svg?logo=slack)](https://join.slack.com/t/qdm12/shared_invite/enQtOTE0NjcxNTM1ODc5LTYyZmVlOTM3MGI4ZWU0YmJkMjUxNmQ4ODQ2OTAwYzMxMTlhY2Q1MWQyOWUyNjc2ODliNjFjMDUxNWNmNzk5MDk)

[![GitHub last commit](https://img.shields.io/github/last-commit/qdm12/meemo.svg)](https://github.com/qdm12/meemo/commits)

[![GitHub commit activity](https://img.shields.io/github/commit-activity/y/qdm12/meemo.svg)](https://github.com/qdm12/meemo/commits)

[![GitHub issues](https://img.shields.io/github/issues/qdm12/meemo.svg)](https://github.com/qdm12/meemo/issues)

[![Donate PayPal](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://paypal.me/qmcgaw)

## Features

- Lightweight (uncompressed amd64) size of 127MB

- Based on:

  - [Meemo 1.13.2](https://github.com/nebulade/meemo) and its NodeJS dependencies

  - [Alpine 3.14](https://alpinelinux.org)

  - [NodeJS](https://pkgs.alpinelinux.org/package/v3.14/main/x86_64/nodejs)

- 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](https://docs.docker.com/install) and [Docker-Compose](https://docs.docker.com/compose/install) are installed

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

    ```sh

    # 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 600 users.json

    chmod 700 data database

    ```

1. Download [**docker-compose.yml**](https://raw.githubusercontent.com/qdm12/meemo/master/docker-compose.yml) on your host, modify it as you wish:

    ```sh

    wget https://raw.githubusercontent.com/qdm12/meemo/master/docker-compose.yml

    ```

1. Launch the MongoDB database and Meemo container with

    ```sh

    docker-compose up -d

    ```

1. You can check logs with

    ```sh

    docker-compose logs -f

    ```

1. Meemo is at [localhost:3000](localhost:3000) (depending on your mapped port in docker-compose.yml)

## Configuration

We assume your Meemo container is named `meemo` in the following.

```sh

# List users

docker exec meemo ./meemo/admin users

# Add a user

docker exec meemo ./meemo/admin user-add -u yourUser -p yourPassword --display-name yourUser

# Edit a user

docker exec meemo ./meemo/admin user-edit -u yourUser -p yourPassword --display-name yourUser

# Remove a user

docker exec meemo ./meemo/admin user-del -u yourUser

```

All the changes are saved to `users.json`

## Environment variables

| Environment variable | Default | Description |

| --- | --- | --- |

| `PORT` | `3000` | TCP port to listen on internally (should not be changed) |

| `BIND_ADDRESS` | `0.0.0.0` (all) | Address to listen on internally (should not be changed) |

| `CLOUDRON_APP_ORIGIN` | `http://localhost` | Used to share tasks etc. |

| `CLOUDRON_MONGODB_URL` | `mongodb://mongodb:27017/meemo` | Location of the Mongo database (should not be changed) |

| `ATTACHMENT_DIR` | `/data` | Attachment storage directory (should not be changed) |

| `LOCAL_AUTH_FILE` | `/users.conf` | Users configuration file location (should not be changed) |

| `NODE_ENV` | `production` | Should 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](https://github.com/qdm12/meemo/master/LICENSE)