From 69c4fc3fa98502e962477a21b7719b3b87bfcf84 Mon Sep 17 00:00:00 2001 From: saturneric Date: Fri, 5 Apr 2024 20:46:30 +0800 Subject: feat: initial commit --- src/content/docs/overview/contract.md | 151 +++++++++++++++++++ src/content/docs/overview/downloads.md | 55 +++++++ src/content/docs/overview/faq.md | 101 +++++++++++++ src/content/docs/overview/getting-started.md | 211 +++++++++++++++++++++++++++ src/content/docs/overview/glance.md | 60 ++++++++ 5 files changed, 578 insertions(+) create mode 100644 src/content/docs/overview/contract.md create mode 100644 src/content/docs/overview/downloads.md create mode 100644 src/content/docs/overview/faq.md create mode 100644 src/content/docs/overview/getting-started.md create mode 100644 src/content/docs/overview/glance.md (limited to 'src/content/docs/overview') diff --git a/src/content/docs/overview/contract.md b/src/content/docs/overview/contract.md new file mode 100644 index 0000000..3adb3a3 --- /dev/null +++ b/src/content/docs/overview/contract.md @@ -0,0 +1,151 @@ +--- +title: Contact Information +sidebar: + label: Contact + 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. + +For correspondence, I strongly prefer plain text emails over HTML formatted +messages. + +## Personal Details + +- **Name:** Eric +- **Email:** [eric@bktus.com](mailto:eric@bktus.com) (Server location: Federal + Republic of Germany) +- **Preferred Email Format:** Plain text, without HTML enhancements. + +### About My Domain + +The domain BKTUS (Bakantu Union US) is not a commercial entity but rather a +personal domain name of mine. + +### Language Proficiency + +I am proficient in the following languages and welcome communication in any of +them: + +1. English +2. Chinese +3. German + +### 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 +rich text formats like HTML. + +``` +-----BEGIN PGP PUBLIC KEY BLOCK----- + +mQGNBGCVnvEBDACuEcjxckb4rocHGU7VPT/OOOOZapNG/0ViB3XhmzNh7q8QJiq6 +M4z0fpC5sf1pHXbbKtehLETrAUTFuaEp19askZI0ISoz5+qKGZuaM3bDZWBjwUpt +woVgUphfeZy2DFsnmTtVj9CRU9Nma6smXVFud3Roj2ImZ0NFrkdETvprfLJ7jqk/ +mXgznNbbJdqmQ4l0I1E91VmrqHHHSakh3grzRDj/GuDookQl2JZfLA0J55qOYdkF +5mmnqbYURGVcP2oot/wSrrWH0F/WatwRx9w+jZjrJWgKjJoqWwvzG8WGop1XkRn1 +Ea3Nzj/KsSL7C5YRu03BL7wNu6UNIJ/zsAnNLp87nCY85w+HnNGHkL3QcnqNQbQP +3aySOkIjXdT8AlGIV5r5wO/RBg4e+xASGzQXx9lYbjJiiIOP2uLxYGGFbalDoiCa +sonlXzMZTJrK7VvZ2UsnSnBJ8l/EPsY/AeZdWbmswQaFsJlfNsZZ6T5Rfyjtu8a3 +fwPJTTsbfIB6N3EAEQEAAbQbU2F0dXJuZXJpYyA8ZXJpY0Bia3R1cy5jb20+iQHO +BBMBCAA4AhsDBQsJCAcCBhUKCQgLAgQWAgMBAh4BAheAFiEE4zeUicObcnDnDi4w +Oq8cZBN87lcFAmCWg1kACgkQOq8cZBN87leJfQv/ShjV9PRi8ixlJ1Ez1TDG+4N9 +EHoi2IwVK1UF51kA9lxyD+8n1ZHpcz7bRXV+YhHAO4A2l1ENrkCJVIZK9OO+Z64l +TPKCV9JVSkxcpnr6sqKJ76Zplwah1ZkwAG9tdK9H95wgeIkO4oSRutX/cCJ35Gko +FfhbV+/OyPYTT2562SZeQ2VqnptGLm0eF+FVt0HP4uxvRyGfgHQD46Ki6dr/JOXQ +j57S06CIHGj1RT4uQVSx53gbFvfIgweHsWraRWwY8jMrgOazlo/KRHG4N04eQdzM +K+WA80ODKuXdhnlGFMhn3RCFZpRV+Upso9syJ1FFChzsuX69+mRPvAojEDnREgd9 +s61nx5xWy6vKMB9oZiomNuPw2EScBwS9EK0M6APqgBaIdL6HOC7kjxBLfqgyhulD +qGZXWNvFj5P2FNMVwSvK1cYftYz+QWqB5BhbJT2H/HpF2xNsH7jfTxwUp6KrN1Bz +geNWgpQDXS5ZXU7dk22BwSah3nXs+LJi3Sloeh/piQHUBBMBCAA+FiEE4zeUicOb +cnDnDi4wOq8cZBN87lcFAmCVnvECGwMFCQPC1M8FCwkIBwIGFQoJCAsCBBYCAwEC +HgECF4AACgkQOq8cZBN87le3zAv/fMnxVMORS5rz/vsc0X8YSldmM1MqdIKSNghK +nQKKnzTBtTKA/oHEyPhjnQRaCfi4eUGeUsdZq8fwbN6sWSmbhJ6cOVgIps9YcS/U +sCV4egUHGy/+ozgDSh563v82ROWxXjszcnFz0F2d4stgroe8A//3OgQDv1wuhMJe +vtSZe8W8ebj7mt0zNjccGQzNkWo82mOyZfjgvK//vWisW4JwP8gfEKBgAktj5MCY +iGS2NbWPAToDIPCA6hKPb3sHQIY2/tGkKwyvr4oxwYRkNq4T5PWcV0p3qRsQudHp +ZXGiL3VNIW04ihLcn8uxSE6sQK2eq5wp/6Wnt1EWG1xb0pU2nPFuAlULHsGxM+bB +YJOk5WzYST1xdgXW3QxVsIoTuVqA+ehqrzvu+gGCz4uenFt6OAswqR7ii8D/Tpso +RAU0nTEOAVpCxXAMgsdUS6jOjtyfTHixGlVL6U3dY3wTuqWdbxmYX/g00PnOTYF0 +1plvf21NHMeYLk68+1nRbtqoLnPViQG5BBABCgAjFiEEnGCv/tNBLyJzYTX+0QUx +Uz7XYkoFAmG6ODgFg2shizAACgkQ0QUxUz7XYkq+BQwAxEzCMKxa21iKv9P7S6Vh +/ZrPMWPzRMoNjMGFeNHxYzyO6lKojoCVsdHaRvqqSota8wVGHglsg4FEZgkqEy+S +kTwMsorqzVhxAtzG9K1pU+wGouT5UPBXFGjusbLfxigxvuIGEVD2025FroE4xvMG +WnyD7r0leWkbF0z1crms2jbPcH0E7nbiiVHA6iOuBV5jo6qm1UxvJH3izSCocrDC +/yqPXg5cng6BPnctcWFzXbVGcB1HQ4LdiN4HWvB7q1mwRG2+qwL+UBybGsMpP+oa +YlIGP0FxNureXJgg8bVGcOOLITmuQ1xTOFu/1lUzk1QBqNql0mvqqScSYsAJxQcy +d95MFFeRLnQ3fJU18YrvlLtJIFxrLE+9IVCQsM3XGblXLCltIEgAunp1ylaVtb/w +4ScbQ/a5vWILh80L3dxcvVe1RlZe6cRwOb4aXRQm7osVaZ/boiaJ1nHYGdrh+qxi +QprHmOXeSPVV708VRaY9t8tSiLCRwVQO1e5e8GeXzIv/uQINBGCWgxEBEAC1Eho3 +A6ksoDWiC+nODHz8Dw95cIq8o9n+Wz7ywnxFJltvyWZ34c3nayi2PeH1cZlc7XXb +dYtbkXuf8zcdrNEFEuUihR/mRae5CZdeZRnoMQKar1WhnfQI8dYMRm/8GhJxcQcx +k0SmnOJ5t7avntKpj1wg423sHbDOLexVxg60PJ5z70FRCgQS/+CtJ9E3/UvN7Nvw +Bz1djQl631cr8iYpsYKjEw3OzMZB4U7Y16DiFUbrk0geNNHDMxQ6nYP0ZXXjP+a7 +bGPnPSY/zNMvDafONJbxvSz17Cy9rAfjmz5cFLyd0xTdH6mcepkEldTU5H1eNJIx +mFo2T5yk6BXCWZsaE1RniNI81Vmv98AGmCljsGFy1jjZDcNlVIzBKaIZkDZSjLuQ +rHaq2bVDSiCHrHmar1Aoc4O6H5RzVeFurGF7JK/+NbG+daFGppEwEhj4fq8VtdGR +C9iN23DAdm8FHIXlU6x1JRt0u6ePIh4pOXbAypGGbTLaWL6dtMT7NsJyC4Y+0gxm +rpXTwzc5lkbFPWNlmhw6LfLSrC4ClpC8C+TsakKaONtKyr/KRs9QxJAeoCHvthj/ +3+/aQGHm7bV8E+a0/Kd0B5lM3K6QnZ2ryl5xWA96pP+xKz8afnpPVx6Q8Qi5SRTF +DgrWwtqHXPgb6ODxWoI8iPjIEfql93rMEQ/HvQARAQABiQPyBBgBCAAmAhsCFiEE +4zeUicObcnDnDi4wOq8cZBN87lcFAmG6N+8FCQTmG90CQMF0IAQZAQgAHRYhBMRK +HkzKVcw8ggq55DpQORmv+khfBQJgloMRAAoJEDpQORmv+khfVPoQALOfRST9qQkA +56xQq5pN/JlXjwMjzXHkpuyBJcyVrqMX+lzpM+0j+1YeJj8ckY98pbRJxTebS7wz +hfFvgMDDDB6yvU518Zydh8Am2Iny4ABpjazKviKGoEyQwGb5ZKeJt4B3usw2L/VC +GxSnZwePBW8LWoTZvS4zG6jQ3JywbfiLojvz11LunOelpfi/Z7TklS29ckp0YrCO +ImMeCfNBnBWjI5SRY0ObhrdI4QK3auMxS2ICX005enDPFkwDYijtmug4KWcW9ZJ3 +yjo3WrKnkHBLOGXAejX/QXMP10HthHvORQPqgpcbiDE0+Zenw8Pg14GX0kdHJcAO +KzGO4QlL7kcQo3NSwzgm8h3v2T1AJ7ZTTSq1xInF8YvDnac3KtP6w0edzjMsxYRl +6W28WvPRfwfeh9uPSFv8GnnzelSqUm+vd1TspfALUNrUQL8u2MWMoVECCigrmoY3 +aIm9xphTROu641vTFFX3nyIb6ZwSWmPLafGIWKwxdFPQzLmK0y3D7uVbEe4L5RWN +9CH9Vwmr6QJ6vnjWsSHUwyCnyUNnIACzwX86IBDnkfkWOC6OOnSBgmhGE6WyJnCX +bptBlQAqDG9E9aDlyB1ndYcuOomp2ChsTJo30tX9d3K+hdVNfJfECjAWYTUwWs8N +iHV2roHZ26q8hLKdtMz0PnGhkfhNcGZjCRA6rxxkE3zuV1CBC/0aOW74yuxVTBhi +c+UNCjbHAZxc6gB8DnhuFp/h0FFfWR5SPKE7KjiZSAH38fzp9i1JT2KMfcDBrs4m +PPCaN7KHViU8Z9YF2FDCn+xqhDvm9j64FNYnTihWttgMM3AbZI+LPbwGl+Uaa4vF +n+sXrUqag8hu7fnCzoE+YPj03CUxSzCw4jXHh0Dyan33msEN6n6G6/XRG073HXxt +xiEaAeNDE+izq98WIfH1c4DVpKFPlD9DVdaCWHzl6vzU3d04g+sUQuMqrScm+rcm +BYCa+SRWnyl2q0dhnG1XjONOBNAZGorB9ooKH5HBFUVeFNsM4ufA+oRp+1XlaqXo +Tc7l+JeDEsVK1fmQljNRhBshaxk8fLPmCi1rmApME33aEGDsg8uc3IZXPe3r8cmY +D/AVSQI5MdPpXqq1VWv+faXL0lZtECtfOXp6l81OX5hqCC7hp6eW7gMofi02YiXU +aBwg2Kx/x2IxG7u9givkBV4oysiedKLNYWUTqjB2aKcRyWISCn+4MwRhujfiFgkr +BgEEAdpHDwEBB0DvyZqcMWkH1WlSfOywXkKTbITdzBKzaf4jtd3g+kjaC4kCMwQY +AQoAJhYhBOM3lInDm3Jw5w4uMDqvHGQTfO5XBQJhujfiAhsiBQkDwtdvAIEJEDqv +HGQTfO5XdiAEGRYIAB0WIQQKoW+sJgfi4tfYq0XFuG82AZ5SpwUCYbo34gAKCRDF +uG82AZ5Sp8xMAQCc6Q7vJXYXIoShHk4RmT1vkAy68k8XgHn9Kw+jbAze4gD9F22u +wWfbsFjiMLUOE2uWlwuLmJN827DBaVw5eOx9HA1F1AwAgFTv4dNTS0jKKIncUN4Y +XX4fA7UbBrwLY8jTAV49V+D+hoFfv09hG+q4xwKwe1yFrgacsHOXnXpTJz6ipU08 +GP9vTheyxSfQUvaWXLzHcGXkaV6aCBsDVWdQ8MHXujOsx/hjQSTDruygmEyc1nFi +aF1BLQDtTXW7GIiQX/l/uLVlnMNI4kdt7YUxjkUL6xD+U5q43B4KyGVIU9+ps4Mr +9wCWS/lot66VLT4FUVTFDF0c8hwEdxVZagZvExlv2SaW3XidRWL5xVAElRs/fgRn +dKFCFDJ1rOLUwj25r6zgu2zXlQ2RHWjgzhLzZmhzv3IX0mI9s5D6bJWy+6/HNCs8 +bTSq0Af79FCdZfPT8GVlY9NWcwsMthxiYJ/cbc/D+w4dX771lP2dU/KZkKuGxdhA +jGWqnGt8lqL3PEIsf1ylPDx6b7peFABWfGlPVUmpik2lTemlqWNPLX5gGmiiktGm +lZ6+bATms7izrrSs521ZKWoUT5TI+qQ7Paq/qsF5zIBGuQGNBGCVnvEBDAC8zNpS +GRHUp+X7hit0bCDPP8HR+rxH50rOVFtQNyXw32lkIrwnHq0Y7FR4t7OSWTkX1xvx +hXMILQdTBxKKrBtFIpQ44cO1UcklkYdCwE/F0lasLLfleo2NlG7ISwNEOxmJcWiw +mkLHN3CnqXpXXqpGDTRavbuhE7yRewp/jNSCsikrvL7NedB5Ef5EZmSkvx7kXibX +KzgKcyft5OlylRMUJS8gzzTPA+xMH/Cl1zFCSgymJw1DK1wx+u0ye2Oj7NDdrYtR +R1qLpCq7kaGIPvIW556/58sj+/YRGeP5JTjhYFk/K8QQr8cK6HWuJQVASJUP+KBk +8CiaqzbOPjlq69eGOymraa8H7JvSR5ArJWPczOxQyiEbYABOtJk1ZSz4v4pa7+RL +UfwFOYuTMyBoY3rJuGhVxA77oHftfjteH1YcKyJXrWnJEA2UbUmyRa5cwZ8S7HXO +IvMhCQS897TzjpablfnIKE0n99c2ylJ4y4fHYSXYDKiCPKniFio8CxfqY+cAEQEA +AYkBvAQYAQgAJhYhBOM3lInDm3Jw5w4uMDqvHGQTfO5XBQJglZ7xAhsMBQkDwtTP +AAoJEDqvHGQTfO5XFbAL/0XZJW6XUca9d7f6Ft/0crMILRKID5uuSaLN1jG7BuLT +wyWPhi7eSWbZQmlDFun/E3vHFj3U/WG13DJL6M89f3707R6rKxT1B17Ht53bO9zH +qJ9KesP1G+mR3phkhnxoQFlFvfSASZbDFtwEm3eZs55UBY4EPYf9MV+qPT0iNu1K +PVX427uQfI0Ic/m4xFAO2XI11wMunDQoXi7rjknjYWxqVyGgqgRLrBD1Bb/aLenK +N9Wn4FajEDaYrgpH46HHyhAOJ2RZbenWO689rZY6/0qPwDGRL7B2xiktu2G+e5JM +JjuRhwEB0g63G8M1MVuRGr/PvrBjs58kF47rxWpp2xmo8dqCHjNS3ze9pl6oyshP +a1J5zeDTNk3Ujgr9IJEzWLDWv9PP9ApcSD15Ia60bxSvsC8FJAZh81JEadLywx0Q +NBLmnMP3Dxpd21LKW8cWXa31F6E6eNf/45h7UGxVBRoOdPQ/Kwg4z69V9T/AXOuK +65XgtG5ajwlmoQcvVx7KIg== +=syqc +-----END PGP PUBLIC KEY BLOCK----- +``` + +This setup is designed to maintain privacy and security in our communications. diff --git a/src/content/docs/overview/downloads.md b/src/content/docs/overview/downloads.md new file mode 100644 index 0000000..f870a04 --- /dev/null +++ b/src/content/docs/overview/downloads.md @@ -0,0 +1,55 @@ +--- +title: Downloads +sidebar: + order: 3 +--- + + +GpgFrontend is available for download through multiple channels. For more +detailed instructions on installation and getting started, please refer to the +[Quick Start Manual](quick-start.md). + +--- + +## Download Options Across Platforms + +### GitHub Releases + +- **Latest Release Download**: Click the badge below to directly navigate to the + GitHub page for the latest release download. + + [![GitHub Release (latest by date)](https://img.shields.io/github/downloads/saturneric/GpgFrontend/latest/total?style=for-the-badge)](https://github.com/saturneric/GpgFrontend/releases/latest) + +### SourceForge + +- **SourceForge Download**: Access the download page on SourceForge through the + download button below. + + [![Download GpgFrontend](https://a.fsdn.com/con/app/sf-download-button)](https://sourceforge.net/projects/gpgfrontend/files/latest/download) + +### Homebrew Cask + +- **Homebrew Cask**: Mac users can check the version information through the + badge below or install using the command line. + + [![Homebrew Cask](https://img.shields.io/homebrew/cask/v/gpgfrontend?style=for-the-badge)](https://formulae.brew.sh/cask/gpgfrontend) + + Install command: + + ``` + brew install --cask gpgfrontend + ``` + +### Flatpak + +- **Flatpak Installation**: Linux users can click the image below to navigate to + the Flathub page for installation. + + [![Download on Flathub](https://flathub.org/api/badge?locale=en)](https://flathub.org/apps/com.bktus.gpgfrontend) + +### Microsoft Store + +- **Microsoft Store Download**: Windows users can visit the application store + page through the Microsoft Store badge below. + + diff --git a/src/content/docs/overview/faq.md b/src/content/docs/overview/faq.md new file mode 100644 index 0000000..ca9e756 --- /dev/null +++ b/src/content/docs/overview/faq.md @@ -0,0 +1,101 @@ +--- +title: Frequently Asked Questions (FAQ) +sidebar: + label: FAQ + order: 4 +--- + +## 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 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. + +**How can I obtain and start using GpgFrontend?** You can download the latest +version of GpgFrontend from its GitHub repository. Visit [GpgFrontend's +Downloads Page](https://www.gpgfrontend.bktus.com/#/downloads) to find the most +recent release. Installation is straightforward: just follow the ReadME +instructions to set it up. + +## 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. + +**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. + +## Troubleshooting GnuPG Installation Issues + +**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: + +### For macOS Users + +- **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. + +### For Linux Users + +- 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. + +### For Windows Users + +- 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. + +### Additional Assistance + +- For more detailed guidance, refer to the quick start manual available at + [Quick Start Guide](quick-start.md). + +## Reporting Bugs and Contributing + +**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](contract.md) section for details. + +**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. + +## Why the Need for GnuPG? + +**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. + +## Understanding BETA Versions + +**What does "BETA" signify in a release?** A "BETA" label indicates that the +version may not have undergone comprehensive testing, particularly for new +modules. While beta versions are carefully evaluated post-release, and stable +versions are published when ready, the aim is to avoid beta releases from +version 2.0.0 onwards, barring exceptional circumstances. + +## Security and Privacy + +**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. diff --git a/src/content/docs/overview/getting-started.md b/src/content/docs/overview/getting-started.md new file mode 100644 index 0000000..7c40daf --- /dev/null +++ b/src/content/docs/overview/getting-started.md @@ -0,0 +1,211 @@ +--- +title: Getting Started with GpgFrontend +sidebar: + label: Getting Started + order: 2 +--- + +Welcome to GpgFrontend, the cross-platform, OpenPGP encryption tool designed for +simplicity and security. This guide will walk you through the installation +process tailored to your operating system, ensuring you can start securing your +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.** + +GpgFrontend leverages the robust functionalities of GnuPG for encryption, +decryption, and key management. It is crucial to have GnuPG installed on your +device to make full use of GpgFrontend. Starting from version 2.0, GnuPG +operates on modular components for enhanced functionality, requiring proper +integration with your system. + +Be aware, due to GnuPG's inability to function within an App Sandbox, +GpgFrontend is not available through the Apple Store. + +For Linux users, most contemporary distributions come with GnuPG 2.0 +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 + +### For Windows Users + +#### 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. + +#### Installer Version + +1. **Download** the installer from [GpgFrontend's latest + releases](https://github.com/saturneric/GpgFrontend/releases/latest), named + `GpgFrontend-*******-windows-x86_64-setup.exe`. +2. **Install** GpgFrontend by following the on-screen instructions. After + installation, you can access GpgFrontend directly from your desktop. + +### For macOS Users + +GpgFrontend's macOS packages are Apple-verified, allowing straightforward +opening without additional permissions. + +#### Using Homebrew Cask + +For an effortless install or removal process, use Homebrew Cask: + +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 + +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). Select + `x86_64` for compatibility with Intel and Apple Silicon chips. +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 +necessary libraries into a single, executable file, eliminating dependency +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`. +4. **Launch** the AppImage with a double-click or through the terminal. + +### BSD Users (FreeBSD/OpenBSD) + +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 + +#### Exporting and Sharing Your Public Key + +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. + +#### Importing a Public Key + +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. + +### Exchanging Public Keys with Friends + +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 new file mode 100644 index 0000000..9aefa66 --- /dev/null +++ b/src/content/docs/overview/glance.md @@ -0,0 +1,60 @@ +--- +title: "GpgFrontend: Your OpenPGP Companion" +sidebar: + label: At a Glance + order: 1 +--- + +**GpgFrontend** stands as a premier, cross-platform, user-friendly, and compact +tool for all your [OpenPGP](https://www.openpgp.org/) encryption needs. Designed +for both beginners and experts in data security, GpgFrontend simplifies +encryption, decryption, and digital signing, offering a seamless interface for +managing OpenPGP tasks. Embrace the latest features of GnuPG 2.x, enhancing your +security in the digital age. + +**Document Version Reference: [v2.1.2](https://github.com/saturneric/GpgFrontend/releases/tag/v2.1.2)** + +## User Interface Glimpse + +_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._ + +![GpgFrontend Interface](https://image.cdn.bktus.com/i/2024/02/02/a7e9e762-a8fa-6e52-2728-1488e338e5ef.webp) + +## Project Origins and Mission + +GpgFrontend inherits its core from the stable and user-friendly +[gpg4usb](https://www.gpg4usb.org/) project, aiming to introduce OpenPGP's new +features while maintaining simplicity and accessibility. My goal is to +ensure data security, making GnuPG's powerful tools available to all, +regardless of technical expertise. + +### A Commitment to Freedom and Security + +As a solo-maintained open-source project, GpgFrontend is a testament to the +power of community and the pursuit of privacy. It remains forever free, inviting +contributions, suggestions, and feedback from users worldwide. + +## Explore the Source + +Dive into the development journey on GitHub, where every line of code, each +update, and user feedback converge to refine and enhance GpgFrontend. + +- [GitHub Repository](https://github.com/saturneric/GpgFrontend) + +### License and Contributions + +Licensed under GPL-3.0, GpgFrontend champions open-source values. Contributions +are not just welcomed but essential—whether through issue reports, pull +requests, or code patches via email. + +## Ensuring Your Privacy + +With a serverless design, GpgFrontend guarantees your data stays yours alone. +For those requiring extra security layers, future versions will offer offline +functionality, further solidifying its stance as a privacy-first tool. + +GpgFrontend is more than software; it's a commitment to secure, accessible, and +open communication for everyone. Join us in this journey, where your security +and privacy are paramount. -- cgit v1.2.3