Detailing build instructions and app description

This commit is contained in:
Matéo Duparc 2020-12-29 17:25:13 +01:00
parent 1a6c1d2901
commit 754ef3bc5a
Signed by untrusted user: hardcoresushi
GPG Key ID: 007F84120107191E
2 changed files with 12 additions and 2 deletions

View File

@ -85,7 +85,15 @@ $ wget -qO - https://www.openssl.org/source/openssl-1.1.1h.tar.gz | tar -xvzf -
#### Build
First, we need to build libgocryptfs.<br>
Retrieve your Android NDK installation path, usually someting like "/home/\<user\>/AndroidSDK/ndk/\<NDK version\>".
For this, we will need to install some dependencies:
```
sudo apt-get install libcrypto++-dev libssl-dev pkg-config
```
And also Go dependencies:
```
go get golang.org/x/sys/unix golang.org/x/sys/cpu golang.org/x/crypto/hkdf
```
Then, retrieve your Android NDK installation path, usually someting like "/home/\<user\>/AndroidSDK/ndk/\<NDK version\>". We can now start the build process:
```
$ cd DroidFS/app/libgocryptfs
$ env ANDROID_NDK_HOME="<your ndk path>" OPENSSL_PATH="./openssl-1.1.1h" ./build.sh

View File

@ -1,5 +1,7 @@
DroidFS allows you to create encrypted virtual volumes on which you can safely store and access files.
It's free, open-source, and you can find the project's repository on <a href="https://github.com/hardcore-sushi/DroidFS">github</a>.
Currently, DroidFS supports only <b>gocryptfs</b>. This algorithm protects file contents and file names but doesn't hide directory structure or file sizes. If you want more details, take a look on their <a href="https://github.com/rfjakob/gocryptfs">github repository</a>.
DroidFS is free, open-source, and you can find the project's repository on <a href="https://github.com/hardcore-sushi/DroidFS">github</a> or on <a href="https://git.drycat.fr/hardcore-sushi/DroidFS">the gitea instance of drycat.fr</a>.
<b>Warning !</b>
Security is relative. DroidFS does not come with any warranty and should not be considered as an absolute safe way to store files.