Skip to content

MagicMirror2 Extension to display ToDo lists from NextCloud

License

Notifications You must be signed in to change notification settings

starlingfire/MMM-NextCloud-Tasks

 
 

Repository files navigation

MMM-NextCloud-Tasks

This is a module for the MagicMirror². Originally developed by SoulofN00b, I have forked it to resolve bugs and add new features.

This module loads a ToDo list via webDav from the NextCloud Tasks app using the "private link" and NextCloud Managed Devices

Current development status: released
Small Screenshot

Dependencies

  • Working NextCloud installation
  • Installed Tasks app

NextCloud preparations

  1. Create a new app password in your Nextcloud installation at Settings > Security (under Personal) > Create New App Password
  2. Give your app a name and generate the password:
    App password screenshot
  3. Create the Private Link to the ToDo list you want to display like this:
    Tasks Screenshot

Installing the module

  1. Navigate to your local MagicMirror/modules directory
  2. run git clone https://github.com/starlingfire/MMM-NextCloud-Tasks.git
  3. run npm install to install dependencies. (This could take several minutes because of the WebDav module)

Using the module

To use this module, add the following configuration block to the modules array in the config/config.js file:

var config = {
    modules: [
        {
            module: 'MMM-NextCloud-Tasks',
            config: {
                // See 'Configuration options' for more information.
                updateInterval: 60000,
                listUrl: "<NEXTCLOUD_TASKS_PRIVATE_LINK>",
                hideCompletedTasks: true,
                sortMethod: "<SORT_METHOD>",
                colorize: true,
                webDavAuth: {
                    username: "<NEXTCLOUD_APP_USERNAME>",
                    password: "<NEXTCLOUD_APP_PASSWORD>",
                }
            }
        }
    ]
}

Configuration options

Option Description
listUrl Required: "Private Link" url from your desired NextCloud task-list
webDavAuth Required: WebDav Authentication object consisting of username and password.
Example: {username: "<NEXTCLOUD_APP_USERNAME>", password: "<NEXTCLOUD_APP_PASSWORD>",}
updateInterval Optional: How often should the data be refreshed (in milliseconds)
hideCompletedTasks Optional: should completed tasks show up or not
sortMethod Optional: How to sort tasks. Options: "priority" "priority desc" "created" "created desc" "modified" "modified desc"
colorize Optional: Should the icons be colorized based on priority?

Screenshots

Sorting on "priority"
Module Screenshot

Sorting on "modified desc"
Module Screenshot 2

Non-colorized
Module Screenshot 2

About

MagicMirror2 Extension to display ToDo lists from NextCloud

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 97.2%
  • CSS 2.8%