Skip to content

Commit

Permalink
feat: v1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
jht5945 committed Jun 23, 2024
1 parent 5153e96 commit c386afe
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 10 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@

> This project is fork from https://github.com/purejava/keepassxc-cryptomator , add GnuPG support
[![GitHub Release](https://img.shields.io/github/v/release/purejava/keepassxc-cryptomator)](https://github.com/purejava/keepassxc-cryptomator/releases)
[![License](https://img.shields.io/github/license/purejava/keepassxc-cryptomator.svg)](https://github.com/purejava/keepassxc-cryptomator/blob/master/LICENSE)
[![GitHub Release](https://img.shields.io/github/v/release/jht5945/gnupg-cryptomator)](https://github.com/jht5945/gnupg-cryptomator/releases)
[![License](https://img.shields.io/github/license/jht5945/gnupg-cryptomator.svg)](https://github.com/jht5945/gnupg-cryptomator/blob/master/LICENSE)

Plug-in for Cryptomator to store vault passwords with GnuPG encryption.


# Build Project

Requirement:
Expand All @@ -18,12 +19,13 @@ Requirement:
mvn package
```

Copy plugin in `target/gnupg-cryptomator-1.0.0-SNAPSHOT.jar` to Cryptomator plugins dir.
Copy packaged plugin from `target/gnupg-cryptomator-$VERSION.jar` to Cryptomator plugins directory.
> Usage reference [Wiki](https://github.com/purejava/keepassxc-cryptomator/wiki)

# Configuration

Config file location:
Configure file location:

* `/etc/cryptomator/config.json`
* `~/.config/cryptomator/config.json`
Expand All @@ -35,20 +37,19 @@ Config file location:
}
```
> `gnuPgCommand` GnuPG command path, find it by `which gpg` <br>
> `keyId` is GnuPG key ID, you can find it by `gpg -K`
> `keyId` is GnuPG key ID, you can find it by `gpg -K` <br>
> `encryptKeyBasePath` is key store path, default value is `$USER_HOME/.config/cryptomator/keys/`
Keys will store in directory:
`~/.config/cryptomator/keys/`

# Documentation

For documentation please take a look at the [Wiki](https://github.com/purejava/keepassxc-cryptomator/wiki).


# Copyright

Copyright (C) 2021-2024 Ralph Plawetzki<br>
Copyright (C) 2024-2024 Hatter Jiang

The Cryptomator logo is Copyright (C) of https://cryptomator.org/

The Cryptomator logo is Copyright (C) of https://cryptomator.org/ <br>
The KeePassXC logo is Copyright (C) of https://keepassxc.org/
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>me.hatter</groupId>
<artifactId>gnupg-cryptomator</artifactId>
<version>1.0.0-SNAPSHOT</version>
<version>1.0.0</version>

<name>gnupg-cryptomator</name>
<description>Plug-in for Cryptomator to store vault passwords with GnuPG encryption.</description>
Expand Down

0 comments on commit c386afe

Please sign in to comment.