alex/s3-gpg-proxy-server
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Improved Readme

Browse Source
This commit is contained in:
Aleksey Lobanov
2020-09-06 18:20:20 +03:00
parent 67a9e5e6f6
commit 0d300f0cfd
1 changed files with 13 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -8,7 +8,10 @@ but can save results to S3-compatible server.
This applicaion provides additional local security layer that encrypts _locally_ all of received files This applicaion provides additional local security layer that encrypts _locally_ all of received files
before sending to target before sending to target
## How to use ## Dependencies
You need Docker [Engine](https://docs.docker.com/engine/install/) and Docker [Compose](https://docs.docker.com/compose/install/).
## Usage
1. `cp example_settings.env settings.env` 1. `cp example_settings.env settings.env`
2. Set correct credentials to target S3 server in `settings.env` 2. Set correct credentials to target S3 server in `settings.env`
@@ -29,10 +32,15 @@ It is containerized application,
only encrypted data may be uploaded to target server. only encrypted data may be uploaded to target server.
And no one can access this containers from the Internet. And no one can access this containers from the Internet.
### I never used Docker. Where I can get it? ### Is it possible to use this without Docker?
You need Docker [Engine](https://docs.docker.com/engine/install/) and Docker [Compose](https://docs.docker.com/compose/install/). Docker provides additional security,
It is possible to install this tools on almost any existing server, which is important for applications like this.
even on RaspberriPi. It also simplifies configuring.
This solution is not just one application,
but Minio server + application on golang.
You can run it without Docker,
but this is not recommended and not supported.
### Is it production ready? ### Is it production ready?
Quick answer is **no**. Quick answer is **no**.