diff options
| author | Saturneric <[email protected]> | 2023-02-09 06:17:12 +0000 |
|---|---|---|
| committer | Saturneric <[email protected]> | 2023-02-09 06:17:12 +0000 |
| commit | 2f17da22473a2e5c671c85222d6d7440e081df14 (patch) | |
| tree | 19b00ece455c5265179a1c1a5d3d2f97a8d58757 | |
| parent | feat: update README (diff) | |
| download | GpgFrontend-2f17da22473a2e5c671c85222d6d7440e081df14.tar.gz GpgFrontend-2f17da22473a2e5c671c85222d6d7440e081df14.zip | |
feat: update the user manual
1. update download, quick start and faq.
| -rw-r--r-- | manual/downloads.md | 10 | ||||
| -rw-r--r-- | manual/faq.md | 67 | ||||
| -rw-r--r-- | manual/quick-start.md | 152 |
3 files changed, 135 insertions, 94 deletions
diff --git a/manual/downloads.md b/manual/downloads.md index dd52e932..2dd488db 100644 --- a/manual/downloads.md +++ b/manual/downloads.md @@ -1,20 +1,22 @@ # Downloads -Currently you can download GpgFrontend through various channels. +Currently, you can download GpgFrontend in many ways. For more tips, you can see +the quick start manual [HERE](quick-start.md). It provides more information on +installing and running. --- ## GitHub Releases -[](https://github.com/saturneric/GpgFrontend/releases/latest) +[](https://github.com/saturneric/GpgFrontend/releases/latest) ## SourceForge -[](https://sourceforge.net/projects/gpgfrontend/files/latest/download) +[](https://sourceforge.net/projects/gpgfrontend/files/latest/download) ## Homebrew Cask -[](https://formulae.brew.sh/cask/gpgfrontend) +[](https://formulae.brew.sh/cask/gpgfrontend) Or just execute `brew install --cask gpgfrontend` diff --git a/manual/faq.md b/manual/faq.md index 5e09eb24..c8e1e19a 100644 --- a/manual/faq.md +++ b/manual/faq.md @@ -1,23 +1,56 @@ # FAQ -## What is GpgFrontend？ +## What is GpgFrontend? -GpgFrontend is a cross-platform encryption tool that conforms to the OpenPGP standard. It is committed to making OpenPGP -easier to use, so that more people can use the tool to protect their privacy. +GpgFrontend is a cross-platform encryption tool that conforms to the OpenPGP standard. It is committed to making GnuPG +easier to use, so that more people can use the tool to protect their privacy during their communications on Internet. -## Relationship between OpenPGP(pgp) and Gnupg(gpg)？ +## Relationship between OpenPGP(PGP) and GnuPG(GPG)？ -OpenPGP is a data encryption and decryption standard, and GpgFrontend supports it. GnuPG is a cryptographic software -used to encrypt, sign communication content and manage keys for asymmetric cryptography. It follows the OpenPGP -standard. GpgFrontend drives gnupg at runtime to implement operations such as encryption and decryption. +OpenPGP(PGP) is a data encryption and decryption standard, and GpgFrontend supports it. GnuPG(GPG) is a cryptographic +software used to encrypt, sign communication content and manage keys for asymmetric cryptography. It follows the +OpenPGP standard. GpgFrontend drives GnuPG at runtime to implement operations such as encryption and decryption. -## How to obtain and use GpgFrontend？ +## How to obtain and use GpgFrontend? The various versions of GpgFrontend will be released in the GitHub repository, and you can find and download the latest -version [HERE](https://www.gpgfrontend.pub/#/downloads). After downloading, you can refer to the instructions in ReadME and you can start using it in just a -few steps. +version [HERE](https://www.gpgfrontend.pub/#/downloads). After downloading, you can refer to the instructions in README +and you can start using it in just a few steps. -## I found some flaws in GpgFrontend, what should I do? +## How to deal with 'ENV Loading Failed'? + +The reason for this problem is that GpgFrontend failed to find the GnuPG in your machine. You can follow suggestions +below. + +### macOS + +For macOS users, please install GnuPG for OSX [Here](https://sourceforge.net/p/gpgosx/docu/Download/). Or just use Homebrew +to install GpgFrontend. By executing command: + +`brew install --cask gpgfrontend`. + +If you have installed GnuPG under a custom path, you can add the "bin" directory of GnuPG in to PATH. + +### Linux + +For Linux users, please install GnuPG through apt or yum. + +If you have installed GnuPG under a custom path, you can add the "bin" directory of GnuPG in to PATH. + +### Windows + +For Windows users, GnuPG is now integrated in the latest version of GpgFrontend, we recommend you to download the +latest GpgFrontend if you don't have any ideas. + +Or, you can download GnuPG installers for Windows [HERE](https://www.gnupg.org/ftp/gcrypt/binary/gnupg-w32-2.4.0_20221216.exe). +Try to reinstall GnuPG through installer when you have already install it. + +### More Tips? + +For more tips, you can see the quick start manual [HERE](quick-start.md). It provides more information on +dealing this situation. + +## I found some bugs in GpgFrontend, what should I do? If you find a defect in GpgFrontend, you are welcome to create an issue in the GitHub repository to describe the problem. When I see your issue, I will respond as soon as possible. If you do not have a GitHub account, please email my @@ -34,7 +67,7 @@ You can contribute completely anonymously, and you can email me patches. The source code of GpgFrontend does not contain operations such as encryption and decryption, which requires Gnupg to provide support. In addition, for users with higher security requirements, they can let GpgFrontend drive their trusted -copy of Gnupg. This design improves the security of GpgFrontend. +copy of GnuPG. This design improves the security of GpgFrontend. ## What is the release version with BETA? @@ -43,13 +76,3 @@ addition, some support for the beta version may not be complete. But rest assure released, and release a stable version at an appropriate time. But starting from 2.0.0, BETA versions will not be released unless there are special circumstances. - -## How to deal with 'ENV Loading Failed'? - -The reason for this problem is that GpgFrontend failed to find the GnuGP tool in your computer. - -- For macOS users, please install GnuPG for OSX [Here](https://sourceforge.net/p/gpgosx/docu/Download/). -- For Linux users, please install gnupg through apt or yum. -- For Windows users, GnuPG is now integrated in the latest version of GpgFrontend, we recommend you to download the - latest GpgFrontend. - diff --git a/manual/quick-start.md b/manual/quick-start.md index 4793131a..b898005e 100644 --- a/manual/quick-start.md +++ b/manual/quick-start.md @@ -1,58 +1,25 @@ # Quick Start -Getting started with GpgFrontend is very simple, you only need a few very simple steps. Moreover, it is oriented to all -PC platforms. - -## Get channels - -The current mainstream distribution channel is the Release feature available through GitHub. It's free and accessible to -most people in the world, without me having to worry about servers and bandwidth, which allows me to save a lot of -money. - -When you click on the [download](https://github.com/saturneric/GpgFrontend/releases/latest), you can see such an -interface. It identifies the current version number of the latest release, the release date of that version, and so on. - - - -You can see some notable features or fixes for the version in the main text, or if you're a programmer, you can also -click change log to get how the source code differs from the previous version. It is worth mentioning that you can see -two green tick marks, which represent that I have personally signed up to the source code of the version. This may be -important for some people with high security needs. - -Then, if you swipe down, you can see a lot of Assets, which are releases for GpgFrontned for different operating -systems. As you can see, the parts of the file name are separated by separators. You need to know that the second -section(e.g. 6171479) provides a unique identification number for the version's source code, and when pointing out -problems with a version, you need to provide the 7-digit unique identification number of the released version you are -using. - - - -Files with sig as the suffix are gpg separate signatures for the released version of the file of the same name. You can -use gpg to check if the changed file is signed and approved by me. - -Follow your needs or follow the instructions below to click on the name of the corresponding release version to -download. - -## Install & Run - GpgFrontend is cross-platform, which is one of its differences. For your operating system, you'll need to choose -different ways to lay out GpgFrontend. It is worth noting that GpgFrontend only supports 64-bit operating systems. -Please check your hardware with your operating system. +different ways to lay out GpgFrontend. -### Pre-conditions +## Pre-conditions -GpgFrontend runs dependent on the basic features provided by GnuPG, so you need to install GnuPG before you can install -GpgFrontend. Why does GpgFronend require users to install GnuPG separately?Starting with GnuPG 2.0, gpg relies on -separate modules to do all of its functions. This requires that when using gpg, these modules all need to be in the -correct location on your operating system so that the gpg can find them. +**For Windows users or macOS users using Homebrew, you can just skip this section.** -GnuPG is not included by default in some operating systems (e.g. Windows and macOS), so this situation has caused -GpgFrontend to be temporarily unavailable in the Apple Store and Microsoft Store. I have plans to launch GnuPG-based -version 1.4 in the future, which will enable GpgFrontend users to start using it when they get it. +GpgFrontend runs dependent on basic functions provided by GnuPG, so you need to install GnuPG before you can run +GpgFrontend. Why does GpgFrontend require users to install GnuPG separately? Starting with GnuPG 2.0, GPG relies on +separate modules to do all of its functions. This requires that when using GPG, these modules all need to be in the +correct location on your operating system so that the GPG can find them. + +GnuPG is not be able to run in App Sandbox, so this situation has caused GpgFrontend to be temporarily unavailable +in the Apple Store. I have tried for many times to bundle GnuPG into App Sandbox, but eventually failed. In general, the latest Linux distributions offer a GnuPG 2.0 environment. You can check by typing `gpg --version` in the command line tool. **In general, it is recommended to install versions of GnuPG 2.1 and above.** +## Install & Run Steps + ### Windows (No Setup) 1. [Download](https://github.com/saturneric/GpgFrontend/releases/latest)`GpgFrontend-*******-Windows-NoSetup.zip` @@ -62,15 +29,28 @@ command line tool. **In general, it is recommended to install versions of GnuPG ### Windows（Setup） 1. [Download](https://github.com/saturneric/GpgFrontend/releases/latest) `GpgFrontend-*******-Windows-Setup.exe` -2. Install it and you can find GpgFrontend on your desktop. +2. Install it, and you can find GpgFrontend on your desktop. ### macOS -0. Install gnupg using homebrew. +All published app packages have passed Apple's check, which means you can open it directly without +extra permission. + +#### Homebrew Cask + +You can use Homebrew Cask to quickly and easily install or remove GpgFrontend in your machine. + +0. Check if Homebrew is installed in your machine. +1. Install GpgFrontend by running command `brew install --cask gpgfrontend` +2. Find GpgFrontend in Launchpad, double-click and run it. + +#### Download and Install from DMG + +0. Install `gnupg` using Homebrew OR download "GPG for OS X" [Here](https://sourceforge.net/projects/gpgosx/files). 1. [Download](https://github.com/saturneric/GpgFrontend/releases) `GpgFrontend-*******-x86_64.dmg` -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. All published app packages have passed Apple's binary check, which means you can open it directly. + - `x86_64` just means it build in such an x86 machine. Actually, it can run smoothly on both Intel and Apple(M1/M2) Chips. +2. Double-Click GpgFrontend.dmg to load it. +3. Double-Click and run it. 4. If it satisfies you, you can drag it into your Application folder. #### Debian/Ubuntu/CentOS (AppImage) @@ -81,20 +61,20 @@ files needed for the application to run. In other words, in addition to the unde system itself, AppImage runs without dependency. This is convenient for users. 0. Install gnupg (If you have already followed please skip) - - For Debian/Ubuntu - ```shell - $ sudo apt update - $ sudo apt install gpg - ``` - - For CentOS - ```shell - $ sudo yum install gnupg - ``` + - For Debian/Ubuntu + ```shell + $ sudo apt update + $ sudo apt install gpg + ``` + - For CentOS + ```shell + $ sudo yum install gnupg + ``` 1. [Download](https://github.com/saturneric/GpgFrontend/releases) `GpgFrontend-*******-x86_64.AppImage` 2. Give `GpgFrontend-***.AppImage` permission to execute - ```shell - $ chmod u+x ./GpgFrontend-***-x86_64.AppImage - ``` + ```shell + $ chmod u+x ./GpgFrontend-***-x86_64.AppImage + ``` 3. Just double-click `GpgFrontend-***-x86_64.AppImage` to run it. ### Debian/Ubuntu (DEB) @@ -103,12 +83,12 @@ With deb, you can easily manage dependencies using the apt tool. Deb packages ar 0. Install gnupg (If you have already followed please skip) - - For Debian/Ubuntu + - For Debian/Ubuntu - ```shell - $ sudo apt update - $ sudo apt install gpg - ``` + ```shell + $ sudo apt update + $ sudo apt install gpg + ``` 1. [Download](https://github.com/saturneric/GpgFrontend/releases) `GpgFrontend-*******-x86_64.deb` @@ -118,4 +98,40 @@ With deb, you can easily manage dependencies using the apt tool. Deb packages ar $ apt install ./GpgFrontend-*******-x86_64.deb ``` -3. At this point, you can find the GpgFrontend icon in your app menu.
\ No newline at end of file +3. At this point, you can find the GpgFrontend icon in your app menu. + +## BSD(FreeBSD/OpenBSD) + +For BSD users, unfortunately, the binary release is not provided yet. But you can build and run GpgFrontend +in these operating systems. + +## Get from GitHub Release + +The current mainstream distribution channel is the Release feature available through GitHub. It's free and accessible to +most people in the world, without me having to worry about servers and bandwidth, which allows me to save a lot of +money. + +When you click on the [download](https://github.com/saturneric/GpgFrontend/releases/latest), you can see such an +interface. It identifies the current version number of the latest release, the release date of that version, and so on. + + + +You can see some notable features or fixes for the version in the main text, or if you're a programmer, you can also +click change log to get how the source code differs from the previous version. It is worth mentioning that you can see +two green tick marks, which represent that I have personally signed up to the source code of the version. This may be +important for some people with high security needs. + +Then, if you swipe down, you can see a lot of Assets, which are releases for GpgFrontend for different operating +systems. As you can see, the parts of the file name are separated by separators. + +You need to know that the second section(e.g. 6171479) provides a unique identification number for the version's source +code, and when pointing out problems with a version, you need to provide the 7-digit unique identification number of the +released version you are using. + + + +Files with signature as the suffix are GPG separate signatures for the released version of the file of the same name. +You can use GPG to check if the changed file is signed and approved by me. + +Follow your needs or follow the instructions below to click on the name of the corresponding release version to +download. |