Skip to content

easily installed and used CLI journal using obsidian

Notifications You must be signed in to change notification settings

mrhwick/journal

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

journal

This repo provides easy install and sync utils for my obsidian journal.

It uses crontab alongside git-crypt and git-lfs to perform automatic syncing of journal contents to this repository, encrypting the contents of the journal pages with a key, and storing any media files separately on git large file storage (LFS).

This repo can be adapted for your own journal by:

  1. forking the repo
  2. replacing the /journal directory with your own obsidian vault
  3. replacing the keyfile with your own
  4. initializing git-crypt on the fork.

Installation

# clone the repo
git clone git@github.com:mrhwick/journal.git

# run installer
cd journal
./scripts/install.sh

This installer script automatically:

  1. adds the git-crypt tool using brew install git-crypt
  2. Checks for a key file named keyfile and configures git-crypt encryption to use that key.
    • This step will fail if the keyfile is not the key initially used to encrypt the contents of my journal.
  3. Adds necessary extension config for the git-lfs to work with git-crypt.
  4. adds a crontab for every 20 minutes to run a sync with github to distribute changes in journal state or content.

Usage

https://obsidian.md/

https://github.com/git-lfs/git-lfs

https://github.com/AGWA/git-crypt

About

easily installed and used CLI journal using obsidian

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages