Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrhwick/journal
easily installed and used CLI journal using obsidian
https://github.com/mrhwick/journal
journal journals lab-notebook zettelkasten
Last synced: about 2 months ago
JSON representation
easily installed and used CLI journal using obsidian
- Host: GitHub
- URL: https://github.com/mrhwick/journal
- Owner: mrhwick
- Created: 2020-03-04T15:56:05.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-08-31T21:00:06.000Z (over 1 year ago)
- Last Synced: 2024-08-13T07:16:07.178Z (4 months ago)
- Topics: journal, journals, lab-notebook, zettelkasten
- Language: Shell
- Homepage:
- Size: 18 MB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - mrhwick/journal - easily installed and used CLI journal using obsidian (Shell)
README
# journal
This repo provides easy install and sync utils for my [obsidian](https://obsidian.md/) journal.
It uses crontab alongside [git-crypt](https://github.com/AGWA/git-crypt) and [git-lfs](https://github.com/git-lfs/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
```bash
# clone the repo
git clone [email protected]: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](https://github.com/mrhwick/journal/blob/master/scripts/synccrontemplate) for every 20 minutes to run a [sync with github](https://github.com/mrhwick/journal/blob/master/scripts/gitsyncertemplate.sh) 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