🌺 Hibiscus.txt

Simple plaintext diary.

This project is very opinionated and minimal, and is designed primarily for my usage. As a result, I can't guarantee that it's either secure or stable.

Features:

• Each day, you get a text file. You have until 23:59 of that very day to finalise it.

• You can save named notes to document milestones, big events, or just a nice game you played this month

• There is also a readme.txt file (just like this one, except you get to write it!)*

• You can easily export entire data dir in a .zip archive for backups

• Everything is plain(text) and simple. No databases, encryption, OAuth, or anything fancy. Even the password is plainte- wait is this a feature?

• Docker support (in fact, that's probably the best way to run this)

• Optional Telegram notifications for failed login attempts

*only available through API, subject to change and removal

Technical details

You can read a relevant entry in my blog here. It provides some useful information and context for why this app exists in the first place. There is also TODO.md file that shows what I will (or may) change in the future.

Data format:

data
+-- day
|   +-- yyyy-mm-dd.txt (ISO 8601)
|       ...
+-- notes
|   +-- note1.txt
|   +-- note2.txt
|       ...
+-- readme.txt

config
+-- config.txt

Config options:

Below are defaults of config.txt. The settings are defined in newline separated key=value pairs. Please don't include the bash-style "comments" in your config, they are provided purely for demonstration only and will break the config if present.

username=admin  # Your username
password=admin  # Your password
port=7101  # What port to run on (probably leave on 7101 if using docker)
timezone=Local    # IANA Time zone database identifier ("UTC", Local", "Europe/Moscow" etc.), Defaults to Local if can't parse.
log_to_file=false   # Whether to write logs to a file (located in <config-dir>/log.txt)
enable_scram=false  # Whether the app should shut down if there are 3 or more failed login attempts within 100 seconds

# Not present by default, set only if you want to be notified of any failed login attempts over telegram
tg_token=tgtoken
tg_chat=chatid

Docker deployment:

Due to project's simplicity and me rarely using them there are no image tags, I just use latest and push to it. The package provided in this repository is for linux/amd64 architecture, and there is a Dockerfile in case you want to compile for something rarer (like a Pi). This repo contains the compose.yml that I personally use.

Executable flags

If you for some reason decide to run plain executable instead of docker, it supports following flags:

-config string
    override config file location
-user string
    override username
-pass string
    override password
-port int
    override port