diff options
Diffstat (limited to '')
| -rw-r--r-- | src/content/docs/overview/contact.md | 50 | ||||
| -rw-r--r-- | src/content/docs/overview/downloads.md | 96 | ||||
| -rw-r--r-- | src/content/docs/overview/getting-started.md | 175 | ||||
| -rw-r--r-- | src/content/docs/overview/glance.md | 21 |
4 files changed, 151 insertions, 191 deletions
diff --git a/src/content/docs/overview/contact.md b/src/content/docs/overview/contact.md index 95925f6..3fe60b7 100644 --- a/src/content/docs/overview/contact.md +++ b/src/content/docs/overview/contact.md @@ -5,45 +5,43 @@ sidebar: order: 5 --- -Please avoid discussing business or political matters here. This space is -dedicated to fostering the well-being and advancement of humanity. If you have -any technical questions or suggestions on how to enhance this software, your -insights are very much welcome. +Contact on this page is intended for technical collaboration and feedback. This +space is dedicated to fostering the well-being and advancement of humanity. If +you have any technical questions or suggestions on how to enhance this software, +your insights are very much welcome. -For correspondence, I strongly prefer plain text emails over HTML formatted -messages. +For email correspondence, I strongly prefer plain text over HTML format. ## Personal Details - **Preferred Name:** Eric -- **Full Legal Name:** Yu Hu -- **Email:** [[email protected]](mailto:[email protected]) (Server location: Germany) -- **Preferred Email Format:** Plain text, without HTML enhancements. -- **Headquarters:** Baden-Württemberg, Germany +- **Legal Name:** Yu Hu +- **Email:** [[email protected]](mailto:[email protected]) (server in Germany) +- **Headquarters:** Germany -**Note for CA Verification:** For informal correspondence you can call me -**Eric**; for formal or legal matters, please use **Mr. Hu**. +> **Note on Names**: I’ve used the name Eric since childhood, and prefer it in +> nearly all non-Chinese contexts, especially online. My legal name, Yu Hu, is +> only truly accurate in Chinese characters and is rarely needed outside of +> legal or formal situations. It’s provided here mainly for code signing +> certificate verification. In formal settings, please use Mr. Hu. -### About My Domain +## About My Domain -The domain BKTUS (Bakantu union us) is not a commercial entity but rather a -personal domain name of mine. The name "Bakantu" merges elements of technology -and community, reflecting a domain that values both innovation and connectivity. -It represents a seamless integration of advanced scientific pursuits with the -foundational principles of mutual support and collaboration, characteristic of a -forward-thinking, interconnected society. This name embodies the synergy between -technological progress and communal interdependence, aimed at fostering a better -future. +The domain [`bktus.com`](https://bktus.com/) (“Bakantu union us”) is just a +personal domain I registered as a teenager. “Bakantu” is simply a made-up +word—no hidden meaning! I just wanted a name that blended technology and +community, reflecting values like innovation, connectivity, and collaboration. +:) -### Language Proficiency +## Language Proficiency I can use the following languages and welcome communication in any of them: -1. English -2. Chinese -3. German +- English +- Chinese +- German -### Secure Communication (GPG Public Key) +## Secure Communication (GPG Public Key) For secure and encrypted communication, below is my long-term PGP public key. Please ensure any encrypted messages are sent in plain text format and avoid diff --git a/src/content/docs/overview/downloads.md b/src/content/docs/overview/downloads.md index 0dfc635..5e26f18 100644 --- a/src/content/docs/overview/downloads.md +++ b/src/content/docs/overview/downloads.md @@ -8,57 +8,87 @@ GpgFrontend is available for download through multiple channels. For more detailed instructions on installation and getting started, please refer to the [Getting Started Guide](/overview/getting-started/). -## Download Options Across Platforms - [](https://repology.org/project/gpgfrontend/versions) -### Releases & Downloads +## Direct Downloads + +Choose from the options below to download GpgFrontend directly for your platform. + +### GitHub Releases + +Click the badges below to access the latest stable and nightly builds. + +[](https://github.com/saturneric/GpgFrontend/releases/latest) + +[](https://github.com/saturneric/GpgFrontend/releases/nightly) + +### Static Mirror + +For privacy-conscious users, a fast and secure direct-download mirror is +available at [ftp.bktus.com](https://ftp.bktus.com/GpgFrontend/). This mirror is +served over HTTPS with no authentication, tracking, rate limits, or +redirections. + +### Asset Naming Patterns and Descriptions + +Below is a summary table explaining the naming patterns and purposes of each +downloadable asset. You can use the filename patterns to quickly identify and +select the appropriate package for your platform or use case. -- **GitHub Releases**: Click the badges below to access the latest stable and nightly builds. +| Filename Pattern | Description | +| --------------------------------- | ------------------------------------------------------------------------------------------- | +| `***-universal.zip` | The universal package: contains both Windows Portable and Linux AppImage in one archive. | +| `***-windows-x86_64-portable.zip` | Fully portable Windows version. No installation needed; just extract and run. | +| `***-windows-x86_64.msix` | MSIX installer for Windows (recommended for most Windows users). | +| `***-windows-x86_64.msi` | Classic MSI installer for Windows; suitable for legacy/enterprise environments. | +| `***-macos-**.dmg` | macOS disk image; number = minimum required macOS version. Drag to install. | +| `***-linux-******.AppImage` | AppImage for Linux; make it executable and run directly. | +| `*.sig` | GPG signature file for verifying the integrity and authenticity of the corresponding asset. | - [](https://github.com/saturneric/GpgFrontend/releases/latest) +## Homebrew Cask - [](https://github.com/saturneric/GpgFrontend/releases/nightly) +Mac users can check the version information through the +badge below or install using the command line. -- **Static Mirror**: A fast, direct-download mirror is also available at [ftp.bktus.com](https://ftp.bktus.com/GpgFrontend/), served securely over HTTPS via Nginx. No authentication, rate limits, or redirections. +[](https://formulae.brew.sh/cask/gpgfrontend) -### Homebrew Cask +Install command: -- **Homebrew Cask**: Mac users can check the version information through the - badge below or install using the command line. +``` +brew install --cask gpgfrontend +``` - [](https://formulae.brew.sh/cask/gpgfrontend) +## Flatpak - Install command: +Linux users can click the image below to navigate to the Flathub page for +installation. - ``` - brew install --cask gpgfrontend - ``` +[](https://flathub.org/apps/com.bktus.gpgfrontend) -### Flatpak +## Windows -- **Flatpak Installation**: Linux users can click the image below to navigate to - the Flathub page for installation. +There are several convenient ways to install GpgFrontend on Windows. Choose the +method that best fits your workflow. - [](https://flathub.org/apps/com.bktus.gpgfrontend) +### WinGet -### Windows +Windows users can install GpgFrontend through the Windows Package Manager +(WinGet). Check the version information through the badge below or install +using the command line. -- **WinGet Package**: Windows users can install GpgFrontend through the Windows - Package Manager (WinGet). Check the version information through the badge - below or install using the command line. +[](https://repology.org/project/gpgfrontend/versions) - [](https://repology.org/project/gpgfrontend/versions) +Install command: - Install command: +``` +winget install Saturneric.GpgFrontend +``` - ``` - winget install Saturneric.GpgFrontend - ``` +### Microsoft Store -- **Microsoft Store Download**: Windows users can also visit the application - store page through the Microsoft Store badge below. +Windows users can also visit the application store page through the Microsoft +Store badge below. - <a href="https://apps.microsoft.com/detail/9nh716mqk2b5"> - <img src="https://get.microsoft.com/images/en-us%20dark.svg" width="200"/> - </a> +<a href="https://apps.microsoft.com/detail/9nh716mqk2b5"> + <img src="https://get.microsoft.com/images/en-us%20dark.svg" width="200"/> +</a> diff --git a/src/content/docs/overview/getting-started.md b/src/content/docs/overview/getting-started.md index db531a1..5359b1f 100644 --- a/src/content/docs/overview/getting-started.md +++ b/src/content/docs/overview/getting-started.md @@ -12,8 +12,7 @@ communications as quickly and efficiently as possible. ## Before You Begin: Prerequisites -**Note for Windows or macOS users who utilize Homebrew: You may skip this -prerequisites section.** +**Note for Windows users: You may skip this prerequisites section.** GpgFrontend leverages the robust functionalities of GnuPG for encryption, decryption, and key management. It is crucial to have GnuPG installed on your @@ -29,26 +28,41 @@ pre-installed. Check your GnuPG version with `gpg --version` in your terminal. It is advisable to upgrade to GnuPG version 2.2 or later for optimal performance and compatibility. -## Installation & Execution Guide +## Brief Installation Guide + +GpgFrontend is distributed through multiple official channels, making +installation easy on all major platforms. **For the latest download options and +installation commands for your system, please visit the +[Downloads](/overview/downloads) page.** + +> Note: The installation methods below provide general guidance. If you prefer +> installing via package managers such as WinGet, Microsoft Store, or Flatpak, +> please refer to the Downloads page for the most up-to-date and recommended +> options. ### For Windows Users +You can choose from several installation methods based on your preferences. + #### Portable Version (No Installation Required) 1. **Download** the portable version from [GpgFrontend's latest releases](https://github.com/saturneric/GpgFrontend/releases/latest), labeled `GpgFrontend-*******-windows-x86_64-portable.zip`. 2. **Extract** the contents of the downloaded ZIP file. -3. **Run** `GpgFrontend.exe` from the extracted `Program/bin` directory. +3. **Run** `GpgFrontend.exe` from the extracted `bin` directory. #### Installer Version -1. **Download** the installer from [GpgFrontend's latest +1. **Download** the MSIX installer from [GpgFrontend's latest releases](https://github.com/saturneric/GpgFrontend/releases/latest), named - `GpgFrontend-*******-windows-x86_64-setup.exe`. + `GpgFrontend-*******-windows-x86_64.msix`. 2. **Install** GpgFrontend by following the on-screen instructions. After installation, you can access GpgFrontend directly from your desktop. +The MSIX installer is recommended for most users due to improved security, +simpler updates, and better integration with modern Windows features. + ### For macOS Users GpgFrontend's macOS packages are Apple-verified, allowing straightforward @@ -56,21 +70,24 @@ opening without additional permissions. #### Using Homebrew Cask -For an effortless install or removal process, use Homebrew Cask: +For an effortless install or removal process, use [Homebrew +Cask](https://formulae.brew.sh/cask/gpgfrontend): 1. Ensure **Homebrew** is installed. 2. **Install** GpgFrontend with the command `brew install --cask gpgfrontend`. 3. **Launch** GpgFrontend from your Launchpad. -#### Manual Installation from DMG +#### Installation from DMG 1. **Install GnuPG** via Homebrew or download it from [GPG for OS X](https://sourceforge.net/projects/gpgosx/files). 2. **Download** the `GpgFrontend-*******-macos-**.dmg` file from [GpgFrontend's - releases](https://github.com/saturneric/GpgFrontend/releases). + latest releases](https://github.com/saturneric/GpgFrontend/releases/latest). 3. **Mount** the DMG file and **run** GpgFrontend. 4. **Optional:** Drag GpgFrontend into your Applications folder for easy access. + + ### For Linux Users (AppImage) AppImage simplifies software distribution by bundling applications and all @@ -79,11 +96,11 @@ conflicts. 1. **Install GnuPG** if it's not already installed. - Debian/Ubuntu: `sudo apt update && sudo apt install gpg` - - CentOS: `sudo yum install gnupg` -2. **Download** the AppImage from [GpgFrontend's - releases](https://github.com/saturneric/GpgFrontend/releases), labeled - `GpgFrontend-*******-linux-x86_64.AppImage`. -3. **Make it executable:** `chmod u+x ./GpgFrontend-***-linux-x86_64.AppImage`. + - Fedora: `sudo yum install gnupg` +2. **Download** the AppImage from [GpgFrontend's latest + releases](https://github.com/saturneric/GpgFrontend/releases/latest), labeled + `GpgFrontend-*******-linux-******.AppImage`. +3. **Make it executable:** `chmod u+x ./GpgFrontend-***-linux-******.AppImage`. 4. **Launch** the AppImage with a double-click or through the terminal. ### BSD Users (FreeBSD/OpenBSD) @@ -92,119 +109,29 @@ Currently, there are no binary releases for BSD systems. However, GpgFrontend can be compiled and run on BSD. Refer to the GitHub repository for build instructions. -## Downloading from GitHub Releases - -GpgFrontend is primarily distributed through GitHub Releases, ensuring -accessibility and eliminating the need for personal server management. - -Upon navigating to [GpgFrontend's download -page](https://github.com/saturneric/GpgFrontend/releases/latest), you'll find -detailed information about the latest version, including new features and fixes. -Each release is signed for security verification purposes, allowing users with -heightened security needs to confirm the authenticity of the downloaded files. - -Scroll down to the **Assets** section to select the appropriate version for your -operating system. The filenames include a unique identification number, crucial -for reporting any version-specific issues. - -Files ending in 'signature' are GPG separate signatures, which can be verified -with GPG to ensure they are officially released and approved by me. - -Select the version that suits your system or follows the provided instructions -to begin the download. - -By following these steps, you'll be ready to use GpgFrontend, enhancing your -digital security with powerful encryption tools at your fingertips. - -## Basic Operations with GpgFrontend - -After successfully installing GpgFrontend, you're ready to dive into the world -of encryption and secure communication. This guide will walk you through some -fundamental operations to get you started. - -### Generating Your First Key Pair - -1. Open GpgFrontend: Launch the application. -2. Access Key Management: Navigate to the "Key Management" section. -3. Generate Key Pair: Look for an option to "Generate" a new key pair. -4. Fill in your details, such as name and email, and choose your desired key - type and size. You can also add a comment if you wish. -5. Set an expiration date for the key, or choose 'Never Expire' if you prefer. -6. Create a passphrase for your key to ensure its security. Remember to use a - strong passphrase that you won't forget. -7. Once all details are filled in, click 'OK' to generate your key pair. - -### Encrypting - -1. **Write a Message:** Start by writing a message in the main text area of - GpgFrontend. -2. **Choose Recipient:** Select the public key of the message's recipient. If - you're practicing, you can select your own public key. -3. **Encrypt:** With the recipient's public key selected, click on the "Encrypt" - option. The text will be encrypted, making it readable only by the selected - recipient. - -### Decrypting - -1. **Receive an Encrypted Message:** Copy the encrypted message into - GpgFrontend's main text area. -2. **Decrypt:** Click on the "Decrypt" option. If the message was encrypted with - your public key, you would need to enter the password for your private key to - decrypt it. - -### Signing - -1. **Create a Message:** Type your message in the text area. -2. **Sign:** Choose the "Sign" option and select your private key. Enter your - key's password to sign the message. This adds a digital signature that - verifies you as the message's sender. - -### Verifying - -1. **Receive a Signed Message:** Paste the signed message into GpgFrontend. -2. **Verify:** Click on "Verify" to check the signature. If the signature - matches the sender's public key, GpgFrontend will confirm the message's - integrity and authenticity. - -### Key Management and Sharing +## Basic Operations Index -#### Exporting and Sharing Your Public Key +Before diving into the specific operations, **we highly recommend that beginners +start with the [Fundamental Concepts](/guides/fundamental-concepts/) guide**. It +provides an essential overview of encryption principles, key management basics, +and the main concepts used throughout GpgFrontend. -1. Go to 'Manage Keys'. -2. Select your key pair and choose 'Export Key'. -3. Save your public key to a file or copy it to the clipboard to share it with - others. +Then, you can quickly get started by referring to the following topic-specific +guides. For more details about operations and the user interface, please refer to: +[Interface Understanding](/guides/understand-interface/) -#### Importing a Public Key +- [Generating a Key Pair](/guides/generate-key/) +- [Importing and Exporting Key Pairs](/guides/import-export-key-pair/) +- [File Encryption and Decryption](/guides/file-operations/) +- [Text Encryption and Decryption](/guides/text-opetations/) +- [Using Key Groups](/guides/key-group/) +- [Key Server Operations](/guides/key-server-operations/) +- [Smart Card Operations](/guides/smart-card/) -To communicate securely with someone else, you need their public key. Click -'Import key'. You can import a key file or copy and paste the public key -directly. After importing, the public key will appear in your keyring, ready for -use. +:::tip -### Exchanging Public Keys with Friends +You can also explore more topic-specific guides in the "Brief Guides" section. +If you encounter any questions, it is recommended to consult the dedicated +documentation for each feature first. -1. **Export Your Public Key:** From the "Key Management" section, find the - option to export your public key. Save it as a file or copy it to your - clipboard. -2. **Share Your Public Key:** Send your public key to your friend via email, - messaging app, or any secure channel you prefer. -3. **Import Your Friend's Public Key:** When your friend sends you their public - key, import it into GpgFrontend using the "Import" option in the "Key - Management" section. - -By exchanging public keys, you establish a secure channel for encrypted -communication. Only the holder of the corresponding private key can decrypt -messages encrypted with a public key, ensuring privacy and security in your -communications. - -## Conclusion - -GpgFrontend is a powerful tool for enhancing your digital security. By -generating key pairs, encrypting and decrypting messages, signing documents, and -exchanging public keys, you can safeguard your communications in a world where -privacy is increasingly precious. As you become more familiar with these -operations, explore further features and settings within GpgFrontend to tailor -your security practices to your needs. Remember, the cornerstone of digital -security is practicing safe key management and password hygiene. Welcome to the -secure side! +::: diff --git a/src/content/docs/overview/glance.md b/src/content/docs/overview/glance.md index 96c0d06..44fb0af 100644 --- a/src/content/docs/overview/glance.md +++ b/src/content/docs/overview/glance.md @@ -33,18 +33,23 @@ privacy easily and effectively. ## User Interface Glimpse -The example screenshot below shows GpgFrontend running on macOS, illustrating -its clean and modern interface design. Interface layout, fonts, and colors may -look different on Windows or Linux, but the core features and workflow remain -consistent across all platforms. +Most of the screenshots in this manual are from the macOS version of +GpgFrontend, as primary development and testing are conducted on macOS. This +approach ensures consistent screenshot quality and a unified visual style +throughout the manual. - + + + + + :::tip[Note] -GpgFrontend's appearance may vary across different operating systems and -themes. Always refer to the corresponding version of the software for the most -accurate documentation. +The core features and workflow of GpgFrontend are consistent across all +supported platforms (Windows, Linux, etc.). While visual details such as fonts +and window styles may differ slightly depending on your operating system, the +documentation remains applicable and relevant for all users. ::: |