https://github.com/elogiclab/dotbot-sops

https://github.com/elogiclab/dotbot-sops

Last synced: 1 day ago
JSON representation

• Host: GitHub
• URL: https://github.com/elogiclab/dotbot-sops
• Owner: elogiclab
• License: mit
• Created: 2024-11-13T06:53:08.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-11-13T09:23:55.000Z (2 months ago)
• Last Synced: 2024-11-13T10:28:10.232Z (2 months ago)
• Language: Python
• Size: 3.91 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[dotbot_repo]: https://github.com/anishathalye/dotbot

## Dotbot ```sops``` Plugin

Plugin for [Dotbot][dotbot_repo], that adds ```sops``` directive, which allows you to decrypt files encrypted with sops.

## Installation

1. Simply add this repo as a submodule of your dotfiles repository:

```

git submodule add https://github.com/elogiclab/dotbot-sops.git

```

2. Pass this folder (or directly sops.py file) path with corresponding flag to your [Dotbot][dotbot_repo] script:

- ```-p /path/to/file/sops.py```

or

- ```--plugin-dir /pato/to/plugin/folder```

## Usage

### Example config

```yaml

- sops:

    systemd/cryfs.conf:

      source: systemd/cryfs.sops.conf

```

You need to have sops installed and the .sops.yaml file present in the directory where the encrypted file is located.

Typically you will have the encrypted file committed to the repository and the plaintext file specified in the .gitignore. Place the sops directive before the linking process so that you will have the decrypted file ready to be linked.

For more information on how to encrypt files with sops refer to the sops documentation. [This is a practical example](https://blog.gitguardian.com/a-comprehensive-guide-to-sops/) of how to encrypt a file using gpg.