A Linux-service allowing you to schedule recurring Memo notes, for example weekly to-do lists.

This project is in an early, but functional, state.

Installation

Prebuilt Package

I have prebuilt a Debian package, easily deployable on any Debian based container. Simply download the .deb package, and run:

dpkg -i ./auto-memos.deb

This will install the package, and systemd service. To finish, type systemctl enable --now auto-memos to start the service.

Building from Source

You can build the binary from scratch using Cargo and install this on your server, or build your own Debian package using cargo-deb.

If you build the binary from scratch, you will need to install the systemd service: this can be found in the services/ folder within this repository.

Configuration

The configuration file path must be /etc/automemos/schedule.yml

Example with explanation:

url: "https://memos.server.com" # your memos server url
token: "your_access_token_here" # your access token, generated in memos settings dashboard
log_level: "WARN" # either WARN (less verbose) or INFO (more verbose)

jobs:
  - schedule: "0 9 * * *" # a CRON expression, optionally you can include 6 placeholders for seconds
    text: "Good morning! Check your tasks please. #alert" # the message content
    visibility: "PUBLIC" # PUBLIC, PROTECTED or PRIVATE

  - schedule: "0 0 * * SAT"
    text: | # Multi-line message content, with the {{date}} placeholder
      Weekend Jobs {{date}}:
      - [ ] Clean coffee machine
      - [ ] Hoover house
      - [ ] Finish maths homework
    visibility: "PRIVATE"

Use systemctl restart auto-memos to reload the config file. To ensure the config file is valid, ensure systemctl status auto-memos shows: active (running).

The program will not run without a valid configuration file.

Licensing

This project is licensed under the GPL v3.0 license.