Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/evanshortiss/notable-git-sync-setup
Automatically synchronise your Notable folder to Git every few minutes 🔄
https://github.com/evanshortiss/notable-git-sync-setup
notable
Last synced: 4 days ago
JSON representation
Automatically synchronise your Notable folder to Git every few minutes 🔄
- Host: GitHub
- URL: https://github.com/evanshortiss/notable-git-sync-setup
- Owner: evanshortiss
- Created: 2020-09-15T12:16:26.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-10-24T15:49:09.000Z (about 1 year ago)
- Last Synced: 2024-11-02T11:11:44.899Z (11 days ago)
- Topics: notable
- Language: Shell
- Homepage:
- Size: 48.8 KB
- Stars: 18
- Watchers: 3
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Notable Git Sync
Configures a User LaunchAgent for macOS and Service Manager for Linux that synchronises the ~/.notable folder to a Git repository.
You'll get a nice notification if you have a recent version of Node.js installed.
## Requirements
### macOS
* A Git repository on GitHub, GitLab, or some Git server.
* Git installed on macOS ([Installation options](https://git-scm.com/download/mac)).
* Git SSH keys configured ([GitHub Docs for SSH](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh)) using default `id_rsa` naming scheme.
* [Optional] Node.js v12+ is required for macOS notification integration.
### Linux
* A Git repository on GitHub, GitLab, or some Git server.
* Git installed ([Installation options](https://git-scm.com/download/linux)).
* Git SSH keys configured ([GitHub Docs for SSH](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh)) using default `id_rsa` naming scheme.
## OS Support
Currently only macOS and Linux is supported. Pull Requests that add support for other platforms are welcome!
## Setup
_NOTE: This script assumes you are using the `~/.notable` directory for storing notes. After running the script use the **Change Data Directory** option in Notable to set your data directory to `~/.notable`._
Clone the repository, run the `setup.sh`, and follow the prompts:
### macOS
```bash
git clone https://github.com/evanshortiss/notable-git-sync-setup notable-sync
cd notable-sync
./setup.sh
```
### Linux
```bash
git clone https://github.com/evanshortiss/notable-git-sync-setup notable-sync
cd notable-sync
sudo chmod +x ./setup.sh
# -E preserve environment (for git commands)
sudo -E ./setup.sh
```
## Default Configuration
The configuration for the service is defined in the *plist.template.xml*.
* Assumes a default `~/.ssh/id_rsa` SSH configuration for Git.
* Logs are written to `/tmp/notable-sync.stdout` and `/tmp/notable-sync.stderr` in macOS.
* `sudo journalctl -u notable-sync` to see logs in Linux.
* By default, notes are synchronised to the Git repository every 10 minutes.
* Fails on Git merge conflicts. Are your notes are not syncing? This might be why.