GpgFrontend/README.md

GpgFrontend

GpgFrontend is a Powerful, Easy-to-Use, Compact, Cross-Platform, and Installation-Free OpenPGP Crypto Tool.

By using GpgFrontend, you can quickly encrypt and decrypt text or files. Or at the same time as the above operations, you can add your own signature to let others know that this document or this paragraph of text was issued by you. It aims to allow ordinary users to quickly use gpg and make professional users more convenient. GpgFrontend supports new features of OpenPGP.

Notice: GpgFrontend does not provide an embedded gnupg binary library and needs to be installed by the user. This is to ensure safety and avoid code or binary files being implanted in the backdoor during the delivery process.

>> Quick Start

>> Code & Binary Security

>> 中文文档

Workflows Status:

---

Table of Contents

• Features
• Usage
  • Quick Start
  • How to Run it
    • Windows
    • macOS
    • Debian/Ubuntu/CentOS
• Document
• Purpose
• Build
• Contract
  • Contributing
  • Maintainers
• Licenses

Features

• Can run on Windows, Linux and macOS.
• Open source, free, no need to install.
• Just double-click, and then you can use it freely.
• Supports multiple languages.
  • If you are interested, you can help me translate the interface.

Usage

Quick Start

Fast encryption

Encryption can be done in just a few clicks.

Fast Decryption

I want to see what you wrote right away.

More Helpful Operation

Read the animated pictures in the Document to learn more awesome operations.

How to Run it

Windows

1. Download gnupg-w32-******.exe
2. Double Click it to install it
3. Download GpgFrontend Windows Edition from the latest release
4. Unzip gpgfrontend-windows-latest-*******.zip
5. Go into the directory and double click GpgFrontend.exe.

macOS

0. If command gpg is not avaliable, please use homebrew to install it first.
1. Download GpgFrontend macOS edition from the latest release
2. Double-Click GpgFrontend.dmg to load it
   • macOS will automatically decompress the zip file and then you will be able to see the dmg
3. Double click and run it (due to macOS security policy, you may need a little more step).
4. If it satisfies you, you can drag it into your Application folder.

Debian/Ubuntu/CentOS

1. Install gnupg (If you have already followed please skip)
   • For Debian/Ubuntu

     $ sudo apt update
     $ sudo apt install gpg
     

   • For CentOS

     $ sudo yum install gnupg 
     

2. Download GpgFrontend Linux edition from the latest release
3. Unzip gpgfrontend-ubuntu-16.04-*******.zip
   • ubuntu-16.04 shows that Linux distributions at the same time as 16.04 or later are supported.
4. Give GpgFrontend-***.AppImage permission to execute

   $ chmod u+x ./GpgFrontend-***.AppImage
   

5. Just double-click GpgFrontend-***.AppImage to run it.

Document

For more usage information, please read Document.

Purpose

The GpgFrontend project inherit from a relatively mature but not maintained gpg4usb project. It inherits the stable, easy-to-use, compact, and installation-free features of gpg4usb, and plans to support some new features of OpenPGP based on it and continue to improve it.

GpgFrontend will add more functions in the future to improve the ease of use of GPG in end-to-end transmission. At the same time, the addition of new functions does not affect the old basic functions. My personal strength is always limited. GpgFrontend welcomes volunteers to join. You can use the GitHub platform to file an issue, or submit a pull request.

The GpgFrontend project is as open source, and it also insists on using open source codes and libraries.

Build

The tutorial for building the software will be released shortly.

Contract

If you want to contact me individually, you can email eric@bktus.com.

Contributing

Feel free to dive in! Open an issue or submit PRs.

Maintainers

@Saturneric.

LOGO

LICENSES

GpgFrontend itself is licensed under the GPLv3.

There are some libraries and binary included in the zip-file which (may) have different licenses, for more information check their homepages. You can also obtain the sources from there.

gpg4usb: https://www.gpg4usb.org/

Gnupg: https://gnupg.org/

QT: https://www.qt.io/

MSYS2: https://www.msys2.org/

mingw-w64: http://mingw-w64.org/doku.php

The icons of this software use materials from Alibaba vector icon library. The Alibaba vector icon library is free to use. The icons in the free library aren't registered as trademarks. There is no copyright issue involved and can be used commercially.