https://github.com/jack5341/super-dollop
Encrypt your files or notes by your GPG key and save to MinIO or AWS S3 easily!
https://github.com/jack5341/super-dollop
amazon-s3 cobra golang gpg hacktoberfest minio-server
Last synced: 3 months ago
JSON representation
Encrypt your files or notes by your GPG key and save to MinIO or AWS S3 easily!
- Host: GitHub
- URL: https://github.com/jack5341/super-dollop
- Owner: jack5341
- License: apache-2.0
- Created: 2021-09-01T19:08:07.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-12-06T23:31:16.000Z (over 4 years ago)
- Last Synced: 2024-06-19T00:32:32.213Z (almost 2 years ago)
- Topics: amazon-s3, cobra, golang, gpg, hacktoberfest, minio-server
- Language: Go
- Homepage:
- Size: 6.48 MB
- Stars: 60
- Watchers: 2
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Super Dollop
**Super Dollop** can encrypt your files and notes by your own [GPG](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) key and save them in [S3](https://docs.aws.amazon.com/sdk-for-go/api/service/s3/) or [minIO](https://docs.min.io/docs/golang-client-api-reference.html) to keep them safe and portability, also you can use **Super Dollop** for encrypt your file quickly to print it. So with **Super Dollop** you'll solve your keep your notes with security problem easily with Gopher.
By the way if you want to encrypt your file you can print it directly to your terminal with `-p` easily.
| | |
|-- |-- |
 | 
```sh
dollop list
```
# Requirements
- [Go](https://golang.org/) `>= 1.16
- [MinIO](https://docs.min.io/docs/minio-quickstart-guide.html)
- Core dependencies: `gnugpg`, `gpgme>=1.7.0`, `libgpg-error`
# Installation
Install [gnupg](https://www.gnupg.org/)
```sh
sudo apt-get install gnupg
```
Set your environments to your terminal
> .zshrc
```sh
# Environment variables for MinIO
export MINIO_ENDPOINT=127.0.0.1:9000
export MINIO_ACCESS_KEY=admin
export MINIO_SECRET_KEY=secretadmin
export MINIO_GPG_ID=GPG-ID
export MINIO_BUCKET_NAME=dollop-files
```
Get your [MinIO](https://docs.min.io/docs/minio-quickstart-guide.html) container.
> docker-compose.yml
```yaml
version: "3"
services:
s3:
image: "minio/minio"
hostname: "storage"
restart: "no"
volumes:
- data:/data
ports:
- "9000:9000"
- "9001:9001"
entrypoint: ["minio", "server", "/data","--console-address",":9001"]
networks:
- local
volumes:
data:
networks:
local:
```
```
// Pull minio/mc
docker pull minio/mc
// Run pulled image with docker-compose.yml file
docker-compose up
```
Give first gas to **Super Dollop**
```sh
// clone the super-dollop repository
git clone https://github.com/jack5341/super-dollop && cd super-dollop
// try to run list command
go run . list
```
# Usage
```sh
dollop [FLAGS] [OPTIONS]
```
```sh
COMMANDS:
completion generate the autocompletion script for the specified shell
dec List your all encrypted files and notes.
enc A brief description of your command
help Help about any command
list List your all encrypted files and notes.
```
# Cli Schema
| Commands | Flags |
| :-------- | :------- |
| `dec` | `-n --name` |
| `enc` | `-f --file -n --note -p --print` |
| `list` | `-d --delete` |
## Feedback
If you have any feedback, please reach out to us at nedim.akar53411@gmail.com
## License
[Apache-2.0](https://choosealicense.com/licenses/apache-2.0/)