From bde75d524a777df32bda00aff68ac5bb38be825b Mon Sep 17 00:00:00 2001 From: saturneric Date: Thu, 19 Jun 2025 16:31:26 +0200 Subject: refactor: improve faq page --- src/content/docs/overview/faq.md | 227 +++++++++++++++++++-------------------- 1 file changed, 110 insertions(+), 117 deletions(-) diff --git a/src/content/docs/overview/faq.md b/src/content/docs/overview/faq.md index 1ac820d..cc126ea 100644 --- a/src/content/docs/overview/faq.md +++ b/src/content/docs/overview/faq.md @@ -7,166 +7,159 @@ sidebar: ## Understanding GpgFrontend -**What is GpgFrontend?** GpgFrontend is a user-friendly, cross-platform tool -designed to facilitate the use of OpenPGP encryption, making it easier for -individuals to protect their privacy and secure their communications. +### What is GpgFrontend? -**What can I do with GpgFrontend?** Beyond basic encryption and decryption, -GpgFrontend supports digital signatures to verify the integrity and origin of -messages. Users can manage and generate key pairs, encrypt files and emails, and -sign their communications for added security. +A user-friendly, cross-platform tool for OpenPGP encryption, making it easy to +protect your privacy and secure your communications. -**How can I obtain and start using GpgFrontend?** You can download the latest -version of GpgFrontend from [GpgFrontend's Downloads Page](/overview/downloads) and -choose the installation method for your platform. +### What can I do with GpgFrontend? -**How do I update GpgFrontend to the latest version?** You can always get the -latest stable or nightly release from the Downloads Page. On Windows, simply run -the new installer. On macOS and Linux, replace the old app or AppImage with the -new version. Your settings and keys will be preserved unless noted otherwise in -the release notes. +Beyond basic encryption and decryption, you can generate/manage key pairs, +encrypt files and emails, and use digital signatures to verify integrity and +origin. + +## Getting and Updating GpgFrontend + +### How can I obtain and start using GpgFrontend? + +You can download the latest version of GpgFrontend from [GpgFrontend's Downloads +Page](/overview/downloads) and choose the installation method for your platform. + +### How do I update GpgFrontend to the latest version? + +You can always get the latest stable or nightly release from the Downloads Page. +On Windows, simply run the new installer. On macOS and Linux, replace the old +app or AppImage with the new version. Your settings and keys will be preserved +unless noted otherwise in the release notes. ## OpenPGP and GnuPG Explained -**How do OpenPGP and GnuPG relate?** OpenPGP serves as a standardized protocol -for encrypting and decrypting data, which GpgFrontend supports. GnuPG, or GPG, -implements the OpenPGP standard, providing the necessary cryptographic -functions. GpgFrontend leverages GnuPG for operations like encryption, -decryption, and key management. +### How do OpenPGP and GnuPG relate? -**Which operating systems does GpgFrontend support?** GpgFrontend is a -cross-platform application that supports Windows, macOS, and Linux, making it -accessible to nearly all users for their privacy and data protection needs. +OpenPGP serves as a standardized protocol for encrypting and decrypting data, +which GpgFrontend supports. GnuPG, or GPG, implements the OpenPGP standard, +providing the necessary cryptographic functions. GpgFrontend leverages GnuPG for +operations like encryption, decryption, and key management. -## Troubleshooting GnuPG Installation Issues +### Which operating systems does GpgFrontend support? -**Encountering 'GnuPG not installed correctly'?** This issue typically arises -when GpgFrontend cannot locate GnuPG on your system. Here are steps to address -this based on your operating system: +GpgFrontend is a cross-platform application that supports Windows, macOS, and +Linux, making it accessible to nearly all users for their privacy and data +protection needs. -### For macOS Users +### Why the Need for GnuPG? -- **Install GnuPG for OSX** from - [here](https://sourceforge.net/p/gpgosx/docu/Download/), or install - GpgFrontend using Homebrew with `brew install --cask gpgfrontend`. -- If GnuPG is installed in a custom location, please tell GpgFrontend where the - gpgconf binary it is at GnuPG Controller. +GpgFrontend itself does not handle direct encryption or decryption; it requires +GnuPG for these operations. This design choice ensures higher security, allowing +users to rely on their own verified version of GnuPG. -### For Linux Users +### Can I use keys/data from other OpenPGP software?? -- Install GnuPG via your package manager (apt, yum, etc.). -- If GnuPG is installed in a custom location, please tell GpgFrontend where the - gpgconf binary it is at GnuPG Controller. +Yes—as long as your keys and encrypted data are in a format accepted by GnuPG +(GPG), they can be used with GpgFrontend. GpgFrontend relies on GnuPG for all +OpenPGP operations, so compatibility is determined by what GnuPG supports. Most +keys and data produced by standard-compliant GPG or PGP programs will work +seamlessly. -### For Windows Users +## Troubleshooting GnuPG Installation Issues -- The latest GpgFrontend versions include GnuPG. It's recommended to download - the most recent GpgFrontend version. -- Alternatively, download GnuPG from - [here](https://www.gnupg.org/ftp/gcrypt/binary/gnupg-w32-2.4.0_20221216.exe) - and reinstall if necessary. +### What if I see "GnuPG not installed correctly"? -### Additional Assistance +This issue typically arises when GpgFrontend cannot locate GnuPG on your system. +Here are steps to address this based on your operating system: -- For more detailed guidance, refer to the quick start manual available at - [Getting Started Guide](/overview/getting-started). +- For macOS Users: Install GpgFrontend using Homebrew with `brew install --cask gpgfrontend`. +- For Linux Users: Install GnuPG via your package manager (apt, yum, etc.). +- For Windows Users: New versions include GnuPG; or get it + [here](https://www.gnupg.org/ftp/gcrypt/binary/). -## Reporting Bugs and Contributing +### Where can I find more help? -**Found a bug?** If you encounter any issues with GpgFrontend, please report -them via the GitHub repository. You can also contact me directly if you're not -on GitHub; see the [Contact](/overview/contact) section for details. +For more detailed guidance, refer to the quick start manual available at +[Getting Started Guide](/overview/getting-started). -**Interested in contributing?** Feel free to modify GpgFrontend's code and -submit a Pull Request with your enhancements. You can also send patches via -email if you prefer to contribute anonymously. +## Key and File Management -## Why the Need for GnuPG? +### How do I import or export keys in GpgFrontend? -**Importance of Installing GnuPG** GpgFrontend itself does not handle direct -encryption or decryption; it requires GnuPG for these operations. This design -choice ensures higher security, allowing users to rely on their own verified -version of GnuPG. +Use the Key Management section to import or export public/private keys. You can +also drag-and-drop key files directly into the application's Key ToolBox. -## Understanding Nightly Versions +### Can I encrypt and decrypt files as well as text? -A Nightly version is an automatically generated, experimental build of -GpgFrontend that may include the latest features, urgent fixes, and changes that -are still being tested. Nightly builds are less stable than official releases, -may introduce breaking changes without notice, and are not GPG-signed. They are -ideal for users who want early access and are willing to help test, but not -recommended for production use. For integrity, please verify the provided SHA256 -checksums. Your feedback is invaluable—please report any issues or suggestions -on GitHub to help improve future stable releases. +Yes, GpgFrontend supports both text and file encryption/decryption. Use the +dedicated file options in the main interface to protect or unlock files. -## Security and Privacy +## Nightly & Experimental Versions -**How does GpgFrontend ensure my communications are secure?** GpgFrontend uses -GnuPG to implement the OpenPGP standard, securing your data with robust -encryption algorithms to prevent unauthorized access. It supports public and -private key encryption methods, ensuring only intended recipients can decrypt -and read your messages. +### What are Nightly versions? -## Importing and Exporting Keys +Automatically generated experimental builds with new features/fixes under +testing. Less stable than official releases, may have breaking changes, and are +not GPG-signed. Not recommended for production. Always verify the SHA256 +checksum. Please report feedback/issues on GitHub. -**How do I import or export keys in GpgFrontend?** Use the Key Management -section to import or export public/private keys. You can also drag-and-drop key -files directly into the application's Key ToolBox. +## Password, PIN, and Security -## File Encryption and Decryption +### How does GpgFrontend handle passphrases or PINs? -**Can I encrypt and decrypt files as well as text?** Yes, GpgFrontend supports both -text and file encryption/decryption. Use the dedicated file options in the main -interface to protect or unlock files. +GpgFrontend never processes or stores your GPG key passphrases or smart card +PINs. All PIN entry is securely handled by GnuPG’s pinentry, independent from +GpgFrontend. -## Compatibility With Other OpenPGP Software +For app-specific encryption (e.g., KeyPackage), passphrases/PINs are used only +in memory and immediately cleared. Advanced users can enable PIN caching and +adjust security levels. -**Can I use keys and encrypted data created in other OpenPGP software?** Yes—as -long as your keys and encrypted data are in a format accepted by GnuPG (GPG), -they can be used with GpgFrontend. GpgFrontend relies on GnuPG for all OpenPGP -operations, so compatibility is determined by what GnuPG supports. Most keys and -data produced by standard-compliant GPG or PGP programs will work seamlessly. +### Can lost passwords or keys be recovered? -## Supported Languages +No, for your security, neither GpgFrontend nor the developer can recover lost +passwords or private keys. Make sure to back up your private key and remember +your passphrase! -**Is GpgFrontend available in my language?** GpgFrontend supports multiple -languages. You can change the display language from the `Settings > General` -tab. Want to help translate? See the [contribution -guide](/appendix/translate-interface) on GitHub! +### How does GpgFrontend ensure secure communications? -## Password & PIN Handling +It uses GnuPG to implement OpenPGP with robust encryption algorithms. Only +intended recipients can decrypt your messages. -**How does GpgFrontend handle passphrases or PINs?** +## Smart Card Support -GpgFrontend does not process or store your GPG key passphrases or smart card -PINs. All password and PIN entry for GPG keys is securely handled by the GnuPG -pinentry component, which operates independently of GpgFrontend. GpgFrontend -never sees, intercepts, or retains your passphrases or PINs. +### Does GpgFrontend support OpenPGP smart cards or tokens? -For application-specific encryption features (such as KeyPackage protection), -passphrases or PINs are used only in memory for cryptographic operations and -immediately cleared afterward. Advanced users can enable PIN caching for these -features, and adjust security levels for maximum protection. +Yes, if your GnuPG supports smart cards. Manage your smart cards directly via +the SmartCard Controller. -**Can lost passwords or keys be recovered?** No, for your security, neither -GpgFrontend nor the developer can recover lost passwords or private keys. Make -sure to back up your private key and remember your passphrase! +## Language Support -## Using GpgFrontend With Smart Cards +### Is GpgFrontend available in my language? -**Does GpgFrontend support OpenPGP smart cards or tokens?** Yes, GpgFrontend -supports smart card operations (such as viewing, key generation, and signing) if -your GnuPG installation is configured for smart card support. Users can manage -their OpenPGP smart cards directly using the SmartCard Controller within -GpgFrontend. +GpgFrontend supports multiple languages. You can change the display language +from the `Settings > General` tab. Want to help translate? See the [contribution +guide](/appendix/translate-interface) on GitHub! ## Privacy Policy -**What data does GpgFrontend collect?** GpgFrontend does not collect or transmit -any personal or usage data. All cryptographic operations are performed locally. -Update checks can be disabled, and no tracking or analytics are built in. +### What data does GpgFrontend collect? + +GpgFrontend does not collect or transmit any personal or usage data. All +cryptographic operations are performed locally. Update checks can be disabled, +and no tracking or analytics are built in. + +## Bugs, Feedback, and Feature Requests + +### How can I request a new feature? + +You can suggest new features by opening an issue on GitHub or contacting the +maintainer directly. + +### Found a bug? + +If you encounter any issues with GpgFrontend, please report them via the GitHub +repository. You can also contact me directly if you're not on GitHub; see the +[Contact](/overview/contact) section for details. -## Feature Requests +### Interested in contributing? -**How can I request a new feature?** You can suggest new features by opening an -issue on GitHub or contacting the maintainer directly. +Feel free to modify GpgFrontend's code and submit a Pull Request with your +enhancements. You can also send patches via email if you prefer to contribute +anonymously. -- cgit v1.2.3