\n \nDiaryMD

\n
\n\n[![Main-Docker](https://github.com/aceberg/DiaryMD/actions/workflows/main-docker.yml/badge.svg)](https://github.com/aceberg/DiaryMD/actions/workflows/main-docker.yml)\n[![Docker Image Size (latest semver)](https://img.shields.io/docker/image-size/aceberg/diarymd)](https://hub.docker.com/r/aceberg/diarymd)\n\nMarkdown editor written in `Go` and `SolidJS`:\n- Fully configurable Themes\n- Tabs\n- WorkSpaces\n- Simple Blog\n- Full screen mode\n- Works with a given directory (could be a `git` repo). No DB needed\n\n![Screenshot](https://raw.githubusercontent.com/aceberg/DiaryMD/refs/heads/main/assets/Screenshot_05.png)\n\n## More screenshots\n

Expand

\n\n![Screenshot](https://raw.githubusercontent.com/aceberg/DiaryMD/refs/heads/main/assets/Screenshot_04.png)\n![Screenshot](https://raw.githubusercontent.com/aceberg/DiaryMD/refs/heads/main/assets/Screenshot_03.png)\n![Screenshot](https://raw.githubusercontent.com/aceberg/DiaryMD/refs/heads/main/assets/Screenshot_02.png)\n\n

\n\n## Quick start (Docker)\n

Expand

\n\n```sh\ndocker run --name DiaryMD \\\n -e \"TZ=$YOURTIMEZONE\" \\ # your TZ here\n -e \"REPOPATH=/repo\" \\ # path to diary dir\n -v ~/.dockerdata/DiaryMD:/data/DiaryMD \\ # config\n -v ~/.dockerdata/DiaryRepo:/repo \\ # diary\n -p 8854:8854 \\\n -u $(id -u):$(id -g) \\ # run as current user, so created files will be owned by user, not root\n aceberg/diarymd\n```\nMounted volumes must have write permission for non-root user:\n```\nsudo chown $(id -u):$(id -g) ~/.dockerdata/DiaryMD\nsudo chown $(id -u):$(id -g) ~/.dockerdata/DiaryRepo\n```\n\n

\n\n## Install Binary\n

Expand

\n\nAll binaries are available in the [latest](https://github.com/aceberg/DiaryMD/releases/latest) release.\n

\n\n## Auth\n

Expand

\n\n**DiaryMD** does not have built-in auth option. But you can use it with SSO tools like Authelia, or my simple auth app [ForAuth](https://github.com/aceberg/ForAuth). \nHere is an example [docker-compose-auth.yml](https://github.com/aceberg/DiaryMD/blob/main/docker-compose-auth.yml).\n\n

\n\n## Config & WorkSpaces\n

Expand

\n\nApp config and config for `Default` workspace can be done through environment variables or `config.yaml` file. Also, `Default` workspace config and colors can be set through `GUI`.\n\nOther workspaces have their own paths and themes, which can be configured through `GUI` (recommended) or `workspaces.yaml` file.\n\n> :warning: **Note** \n> While `Default` workspace stores open tabs in browser, other workspaces keep them in `workspaces.yaml` file, so, if you want to access the same tabs from different devices, do not use `Default`.\n\n#### App config\n| Variable | Description | Default |\n| -------- | ----------- | ------- |\n| TZ | Set your timezone for correct time | |\n| HOST | Listen address | 0.0.0.0 |\n| PORT | Port for web GUI | 8854 |\n\n#### Default workspace config\n| Variable | Description | Default |\n| -------- | ----------- | ------- |\n| REPOPATH | Path to diary dir or repo | |\n| BLOGPATH | Path to dir with `blog.json` file | |\n| PAGE_STEP | Items per page in blog | 3 |\n| THEME | `dark`, `gray`, `lake`, `night`, `sand` or `CUSTOM` | sand |\n\nIf `THEME`=`CUSTOM`, colors can be set individually.\n\n#### Colors\n\n| Variable | Description | Default |\n| -------- | ----------- | ------- |\n| C_FONT | Font color | #313136 |\n| C_MENU | Menu color | #dfb377 |\n| C_EDIT | Editor back color | #faeddc |\n| C_BACK | Background color | #f8e6cc |\n| C_OUTLINE | Outline color | #616161 |\n\n

\n\n## Options\n

Expand

\n\n| Key | Description | Default | \n| -------- | ----------- | ------- | \n| -d | Path to config dir | /data/DiaryMD | \n\n

\n\n\n## Blog\n

Expand

\n\nBlog option is still under development and a bit experimental. \nTo enable blog in the workspace, set `BLOGPATH` to directory, where `blog.json` file is stored.\n\nExample of `blog.json` file. Here `path` is relative path inside the dir, specified in `BLOGPATH`. File `blog.json` must be at the root of the dir.\n\n```json\n[{\n \"date\": \"2024-11-03\",\n \"name\": \"Auth for WatchYourLAN and other apps\",\n \"path\": \"/IT/ForAuth.md\",\n \"tags\": [\"my-apps\"]\n},\n{\n \"date\": \"2024-10-06\",\n \"name\": \"WatchYourPorts\",\n \"path\": \"/IT/WYP.md\",\n \"tags\": [\"my-apps\"]\n},\n{\n \"date\": \"2024-10-02\",\n \"name\": \"Replace HDD in RAID1\",\n \"path\": \"/IT/Raid-replace.md\",\n \"tags\": [\"linux\", \"hardware\"]\n}] \n```\n

\n\n\n## Thanks\n

Expand

\n\n- [EasyMDE](https://github.com/Ionaru/easy-markdown-editor) editor\n- All go packages listed in [dependencies](https://github.com/aceberg/DiaryMD/network/dependencies)\n- Favicon and logo: [Flaticon](https://www.flaticon.com)\n- [Bootstrap](https://getbootstrap.com/)\n\n

","has_starred","hub_user","immutable_tags_settings",{"_211":11,"_212":213},"enabled","rules",[214],".*","is_automated","permissions",{"_218":17,"_219":11,"_220":11},"read","write","admin","user","storage_size",654120196,"isOrg","reponame","tag","canDeleteTags","isHubSbxKitsEnabled","currentTab","tagAttestations","displaySecurityMetadata","showSbxLogoOverride","routes/_layout.layers.$namespace.$reponame.$tag.(images).($imageUrlDigest)._index",{"_23":24,"_173":-7,"_171":-7,"_172":-7,"_25":235,"_31":65,"_247":248,"_253":11},{"_27":28,"_29":30,"_31":32,"_33":34,"_35":36,"_37":236,"_106":107,"_108":30,"_109":110,"_111":112,"_113":114,"_115":116,"_117":104,"_118":107,"_119":55,"_120":17},[237,238,239,240,241,242,243,244,245,246],{"_40":41,"_31":42,"_43":44,"_45":46,"_47":48,"_49":50,"_51":44,"_52":-5,"_53":34,"_54":55,"_56":-5},{"_40":58,"_31":59,"_43":44,"_45":60,"_47":61,"_49":50,"_51":44,"_52":-5,"_53":62,"_54":55,"_56":-5},{"_40":64,"_31":65,"_43":44,"_45":66,"_47":67,"_49":50,"_51":44,"_52":-5,"_53":68,"_54":55,"_56":-5},{"_40":70,"_31":71,"_43":44,"_45":72,"_47":73,"_49":50,"_51":44,"_52":-5,"_53":74,"_54":55,"_56":75},{"_40":70,"_31":77,"_43":44,"_45":78,"_47":79,"_49":50,"_51":44,"_52":-5,"_53":80,"_54":55,"_56":81},{"_40":83,"_31":84,"_43":44,"_45":85,"_47":86,"_49":83,"_51":44,"_52":-5,"_53":87,"_54":55,"_56":-5},{"_40":83,"_31":89,"_43":44,"_45":90,"_47":91,"_49":83,"_51":44,"_52":-5,"_53":87,"_54":55,"_56":-5},{"_40":83,"_31":93,"_43":44,"_45":94,"_47":95,"_49":83,"_51":44,"_52":-5,"_53":96,"_54":55,"_56":-5},{"_40":83,"_31":98,"_43":44,"_45":99,"_47":100,"_49":83,"_51":44,"_52":-5,"_53":101,"_54":55,"_56":-5},{"_40":83,"_31":103,"_43":44,"_45":104,"_47":105,"_49":83,"_51":44,"_52":-5,"_53":101,"_54":55,"_56":-5},"imageWithLayers",{"_40":64,"_31":65,"_43":44,"_45":66,"_47":67,"_124":249,"_49":50,"_51":44,"_52":-5,"_53":68,"_54":55,"_56":-5},[250,251,252],{"_31":127,"_53":128,"_129":130},{"_31":142,"_53":143,"_129":134},{"_53":136,"_129":137,"_31":44},"hasPermissionToViewRepoSettings","actionData","errors"]

aceberg/diarymd:latest