diff options
| author | saturneric <[email protected]> | 2023-08-01 14:12:15 +0000 |
|---|---|---|
| committer | saturneric <[email protected]> | 2023-08-01 14:12:15 +0000 |
| commit | 838c71dbbcb8e144eb7a664d93571a1054a13bbc (patch) | |
| tree | 83c24ea464e02143f1893a4555c7f3700b31a0ef | |
| parent | fix: update manual (diff) | |
| download | GpgFrontend-838c71dbbcb8e144eb7a664d93571a1054a13bbc.tar.gz GpgFrontend-838c71dbbcb8e144eb7a664d93571a1054a13bbc.zip | |
fix: remove large mdiea files in manual
| -rw-r--r-- | manual/_coverpage.md | 2 | ||||
| -rw-r--r-- | manual/_media/_coverpage/gpgfrontend-logo.png | bin | 17878 -> 0 bytes | |||
| -rw-r--r-- | manual/_navbar.md | 2 | ||||
| -rw-r--r-- | manual/features/introduce.md | 5 | ||||
| -rw-r--r-- | manual/features/short-ciphertext.md | 14 | ||||
| -rw-r--r-- | manual/features/sync-all-public-keys.md | 34 | ||||
| -rw-r--r-- | manual/manual/import-export-key-pair.md | 10 | ||||
| -rw-r--r-- | manual/manual/key-server-operations.md | 12 | ||||
| -rw-r--r-- | manual/manual/view-keypair-info.md | 18 | ||||
| -rw-r--r-- | manual/overview.md | 8 | ||||
| -rw-r--r-- | manual/quick-start.md | 110 |
11 files changed, 99 insertions, 116 deletions
diff --git a/manual/_coverpage.md b/manual/_coverpage.md index 02ce9a30..348e4d2f 100644 --- a/manual/_coverpage.md +++ b/manual/_coverpage.md @@ -1,4 +1,4 @@ - + # GpgFrontend diff --git a/manual/_media/_coverpage/gpgfrontend-logo.png b/manual/_media/_coverpage/gpgfrontend-logo.png Binary files differdeleted file mode 100644 index 7e9841be..00000000 --- a/manual/_media/_coverpage/gpgfrontend-logo.png +++ /dev/null diff --git a/manual/_navbar.md b/manual/_navbar.md index 80c0b1a3..5af344e6 100644 --- a/manual/_navbar.md +++ b/manual/_navbar.md @@ -1,6 +1,6 @@ <!-- _navbar.md --> -- [Source Code(Develop Repo)](https://repo.stdv.de/?p=public/main/GpgFrontend.git;a=summary) +- [Source Code(Develop Repo)](https://git.bktus.com/gpgfrontend/GpgFrontend) - [Document](https://doxygen.gpgfrontend.bktus.com) - [Manual](overview.md) - [Downloads](downloads.md) diff --git a/manual/features/introduce.md b/manual/features/introduce.md index eb250877..00eb5e21 100644 --- a/manual/features/introduce.md +++ b/manual/features/introduce.md @@ -1,4 +1,5 @@ # Introduce Features -GpgFrontend provides some advanced functions that can meet the needs of certain scenarios. -These features will be gradually introduced as the version is updated. +GpgFrontend provides some advanced functions that can meet the needs of certain +scenarios. These features will be gradually introduced as the version is +updated. diff --git a/manual/features/short-ciphertext.md b/manual/features/short-ciphertext.md deleted file mode 100644 index 8e301966..00000000 --- a/manual/features/short-ciphertext.md +++ /dev/null @@ -1,14 +0,0 @@ -# Short Cipher-text - -**NOTICE: As of version 2.0.0, GpgFrontend has eliminated this feature.** - -The short ciphertext function allows OpenPGP to transfer ciphertext quickly and conveniently in instant messaging software. -After successfully configuring the own key and obtaining the Service Token, you can use the short cipher text function. - -After the encryption and signature operations, you can click the short crypto button in the additional operations menu. -GpgFrontend will return a very short ciphertext, and you can publish the short ciphertext anywhere. - -You can paste the ciphertext into the text tab of GpgFrontend and select decryption and verification operations. -At this time, GpgFrontend will perform the corresponding operations. - -Note: The short ciphertext is valid within seven days of being generated. The short ciphertext function has restrictions on the length of the ciphertext. diff --git a/manual/features/sync-all-public-keys.md b/manual/features/sync-all-public-keys.md index cfc87d60..00f09c9b 100644 --- a/manual/features/sync-all-public-keys.md +++ b/manual/features/sync-all-public-keys.md @@ -1,26 +1,30 @@ # Public Key Sync -Sometimes, you need to keep your local key consistent with the one on the key server. This is critical in cases where a -key owner revokes its key, at which point you need to stop using the key immediately. This avoids potential -man-in-the-middle attacks. Or, if the key owner creates a new subkey for signing, gpg will not be able to verify the -validity of the ciphertext if the ciphertext he sends to you signs with the subkey and you do not have local information -about the subkey. +Sometimes, you need to keep your local key consistent with the one on the key +server. This is critical in cases where a key owner revokes its key, at which +point you need to stop using the key immediately. This avoids potential +man-in-the-middle attacks. Or, if the key owner creates a new subkey for +signing, gpg will not be able to verify the validity of the ciphertext if the +ciphertext he sends to you signs with the subkey and you do not have local +information about the subkey. ## How to use -It's very simple, after clicking the Sync Public Key button in the the Key Management interface, things will be done -automatically. +It's very simple, after clicking the Sync Public Key button in the the Key +Management interface, things will be done automatically. - + -This feature will check all the public keys you now have (only the public key, not any private keys) and then search for -it in the key server. If the corresponding public key is found in the key server, GpgFrontend will import the latest -public key from the key server to the local. +This feature will check all the public keys you now have (only the public key, +not any private keys) and then search for it in the key server. If the +corresponding public key is found in the key server, GpgFrontend will import the +latest public key from the key server to the local. ### Which Key Server Was Used -How do I know which key server GpgFrontend accessed? It's simple, GpgFrontend will exchange keys using the default key -server you set up. If you need to change the key server you need to access, you just need to add your key server in the -settings and set it as the default. +How do I know which key server GpgFrontend accessed? It's simple, GpgFrontend +will exchange keys using the default key server you set up. If you need to +change the key server you need to access, you just need to add your key server +in the settings and set it as the default. - + diff --git a/manual/manual/import-export-key-pair.md b/manual/manual/import-export-key-pair.md index 0198c53e..7f8f42da 100644 --- a/manual/manual/import-export-key-pair.md +++ b/manual/manual/import-export-key-pair.md @@ -9,13 +9,13 @@ To access the import options, navigate to the toolbar and select the desired method based on your specific requirements. Additionally, you can access additional options by selecting the action menu in the key management section. - + In fact, you can find the action menu in the key management section, which provides access to additional key management options beyond those available in the toolbar. - + ### File @@ -80,7 +80,7 @@ shown in the screenshot below. This will save the data to a file. Before proceeding, please make sure to choose a suitable directory to store the file containing the public key data. - + ### Export multiple public keys at once @@ -89,7 +89,7 @@ pairs on the key management interface and click on the "Export to Clipboard" option. This will copy the data to your system clipboard, which you can then paste into any application or file. - + ### Export Private Key @@ -98,7 +98,7 @@ contains the private key (either the primary key or subkey). From there, you can select a destination and GpgFrontend will export the corresponding private key content to that location. - + Exporting the private key also exports both the public key and private key data, as the private key data alone is meaningless without the corresponding public diff --git a/manual/manual/key-server-operations.md b/manual/manual/key-server-operations.md index f4354db4..c0994e41 100644 --- a/manual/manual/key-server-operations.md +++ b/manual/manual/key-server-operations.md @@ -23,19 +23,19 @@ updating when a subkey is added to the key pair. In the main page or in the key manager's Import key operation mode, there is a key server option. After selecting this option you can see such an interface. - + You can get a list of public keys associated with a key server by searching for Key ID, fingerprint or email address via the search box. If there is a suitable public key in the list, you can import it by double-clicking it. - + When the import is complete, you can check whether the public key is actually imported through the pop-up window (no need to import when the local public key is newer), and you can also check some brief information about the public key. - + It is important to note that the public key you import may have expired or been revoked. You can check the status of the key by navigating to the category tab @@ -58,7 +58,7 @@ and the function being performed. You can find the entry of this operation through the operation tab of the key pair detail interface, as shown in the following figure. - + Perform the operation by clicking Upload key pair to key server. Note that the naming of operations here is a bit confusing, but this is where your public key @@ -82,7 +82,7 @@ uploaded anywhere by the user. Refer to the last section of this document on how to set the default key server. - + The "Synchronize key pair with key server" function allows for automatic retrieval of public key information from the key server, which is then compared @@ -112,7 +112,7 @@ by accessing the Settings interface and navigating to the Key Servers tab. Here, you will find options for managing your key server candidate list and determining which key server is set as the default. - + To add a candidate key server to the list, simply enter the http or https address of the key server you wish to add into the input box and click "Add". It diff --git a/manual/manual/view-keypair-info.md b/manual/manual/view-keypair-info.md index e981d457..4fa407b9 100644 --- a/manual/manual/view-keypair-info.md +++ b/manual/manual/view-keypair-info.md @@ -8,14 +8,14 @@ be relatively long. The screenshot below is my friend's public key that I got from the key server. - + Below is a private key I randomly generated. You can find that the biggest difference between him and the above is that the key pair with only the public key is only used for encryption, and if you have the private key, you can do more things (it also depends on your algorithm, DSA can only for signature). - + ## General Info @@ -31,7 +31,7 @@ section and set it as the main UID to change it. According to the OpenPGP protocol, this part is divided into Name, Email, and Comment. - + ### Primary key @@ -47,7 +47,7 @@ not exist, but neither the public key nor the private key exists. Please remember: Each subkey and primary key consists of a pair of public and private keys. - + #### Key ID @@ -111,7 +111,7 @@ pairs. ### Fingerprint - + The fingerprint of the key pair is used for humans to quickly compare whether the key pair is the expected key pair. This field is unique for all keys in the @@ -131,7 +131,7 @@ primary UID. The primary UID is always listed first in the interface. - + UID has three elements, Name, Email, Comment. The name must be greater than or equal to five characters, and the email must conform to the format. Comment @@ -165,7 +165,7 @@ this concept, you may find it helpful to consult the below documentation. [Basic Concepts](../basic-concepts.md) - + To get a basic understanding of this concept, the following points can be considered: @@ -201,10 +201,10 @@ public key or a key pair that includes a private key. Here's what you can do with a public key-only key pair. - + And the screenshot below lists what a key pair containing a private key can do. - + These operations will be scattered in the documentation to explain in detail. diff --git a/manual/overview.md b/manual/overview.md index b87f20f8..beb5869d 100644 --- a/manual/overview.md +++ b/manual/overview.md @@ -29,7 +29,7 @@ Note: For different operating system and system style settings, GpgFrontend may look different.Documentation can also vary widely from release to release. Please check the corresponding program release version for the document. - + ## System Requirement @@ -116,9 +116,9 @@ assured that you will never be asked to pay a fee to use the software. ## Source Code -The primary code repository for GpgFrontend resides on the BKTUS server. -Every update gets committed here first. You can visit the original [code -repository](https://repo.stdv.de/?p=public/main/GpgFrontend.git;a=summary) to +The primary code repository for GpgFrontend resides on the BKTUS server. Every +update gets committed here first. You can visit the original [code +repository](https://git.bktus.com/gpgfrontend/GpgFrontend) to follow our development progress and stay updated on the latest changes. diff --git a/manual/quick-start.md b/manual/quick-start.md index ecba884b..91d188c6 100644 --- a/manual/quick-start.md +++ b/manual/quick-start.md @@ -25,13 +25,15 @@ general recommendation, you should install versions of GnuPG 2.2 or higher.** ### Windows (No Setup) -1. [Download](https://github.com/saturneric/GpgFrontend/releases/latest)`GpgFrontend-*******-Windows-NoSetup.zip` -2. Unzip `GpgFrontend-*******-Windows-NoSetup.zip` -3. Go into the directory and double click `GpgFrontend.exe`. +1. [Download](https://github.com/saturneric/GpgFrontend/releases/latest) + `GpgFrontend-*******-windows-x86_64-portable.zip` +2. Unzip it. (Necessary) +3. Go into the `Program/bin` directory and double click `GpgFrontend.exe`. ### Windows（Setup） -1. [Download](https://github.com/saturneric/GpgFrontend/releases/latest) `GpgFrontend-*******-Windows-Setup.exe` +1. [Download](https://github.com/saturneric/GpgFrontend/releases/latest) + `GpgFrontend-*******-windows-x86_64-setup.exe` 2. Install it, and you can find GpgFrontend on your desktop. ### macOS @@ -49,19 +51,24 @@ You can use Homebrew Cask to quickly and easily install or remove GpgFrontend in #### 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` - - `x86_64` just means it build in such an x86 machine. Actually, it can run smoothly on both Intel and Apple(M1/M2) Chips. +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-*******-macos-**.dmg` + - `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) -AppImage is a format used in Linux systems to distribute portable software without the need for superuser privileges to -install them. The core idea of AppImage is a file as an application. Each AppImage contains the application and all the -files needed for the application to run. In other words, in addition to the underlying components of the operating -system itself, AppImage runs without dependency. This is convenient for users. +AppImage is a format used in Linux systems to distribute portable software +without the need for superuser privileges to install them. The core idea of +AppImage is a file as an application. Each AppImage contains the application and +all the files needed for the application to run. In other words, in addition to +the underlying components of the operating system itself, AppImage runs without +dependency. This is convenient for users. 0. Install gnupg (If you have already followed please skip) - For Debian/Ubuntu @@ -73,68 +80,53 @@ system itself, AppImage runs without dependency. This is convenient for users. ```shell $ sudo yum install gnupg ``` -1. [Download](https://github.com/saturneric/GpgFrontend/releases) `GpgFrontend-*******-x86_64.AppImage` -2. Give `GpgFrontend-***.AppImage` permission to execute +1. [Download](https://github.com/saturneric/GpgFrontend/releases) `GpgFrontend-*******-linux-x86_64.AppImage` +2. Give it permission to execute ```shell - $ chmod u+x ./GpgFrontend-***-x86_64.AppImage + $ chmod u+x ./GpgFrontend-***-linux-x86_64.AppImage ``` -3. Just double-click `GpgFrontend-***-x86_64.AppImage` to run it. - -### Debian/Ubuntu (DEB) - -With deb, you can easily manage dependencies using the apt tool. Deb packages are small compared to AppImage. - -0. Install gnupg (If you have already followed please skip) - - - For Debian/Ubuntu - - ```shell - $ sudo apt update - $ sudo apt install gpg - ``` - -1. [Download](https://github.com/saturneric/GpgFrontend/releases) `GpgFrontend-*******-x86_64.deb` - -2. Use apt to install GpgFrontned. - - ```shell - $ apt install ./GpgFrontend-*******-x86_64.deb - ``` - -3. At this point, you can find the GpgFrontend icon in your app menu. +3. Just double-click it to run it. ## 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. +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 +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. +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. +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. +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. +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. +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. +Follow your needs or follow the instructions below to click on the name of the +corresponding release version to download. |
