Application
How the program looks and behaves.
How you open the settings window depends on your system:
Click Edit > Settings.
The window is called Preferences. You find it under the GpgFrontend menu.
Click Edit > Settings.
The window has a search box at the top and a list of pages down the left side.
The fastest way to find a setting is the search box at the top. It searches the page names and the settings on each page. So you do not have to guess which page a setting is on.
For example, type pin. The list then shows only the page with the PIN
setting, and that page opens. proxy, theme, and update work the same
way.
If you would rather browse, the pages are sorted into four groups:
Application
How the program looks and behaves.
Keys & Engines
Where your keys are kept, and which engine works with them. An engine is the program that does the encryption work, such as GnuPG.
Features
Extras that come from modules. A module is an add-on that gives GpgFrontend one more feature.
System
The technical settings, plus logging.
| Page | Group | What you change there |
|---|---|---|
| General | Application | Language, how operations behave, where the File Panel opens, which modules to look for |
| Appearance | Application | Theme, toolbar buttons, and the fonts of the text editor and the Status Panel |
| Network | Application | Proxy settings |
| Updates | Application | Whether GpgFrontend checks for a new version when it starts |
| Key Databases | Keys & Engines | Your key databases, which one is the default, and the built-in database’s engine |
| Key Generation | Keys & Engines | The default key type, the made-up identity for Quick Generate, and your key profiles |
| GnuPG | Keys & Engines | What happens to GnuPG on exit, keeping it offline, using your own copy, and fixing it when it stops responding |
| rPGP | Keys & Engines | How long the rPGP engine remembers a passphrase, how long its passphrase window waits, and passphrase encryption strength |
| Key Servers | Keys & Engines | The list of key servers, and which one is the default |
| Instant Messaging | Features | Your phrase for instant messaging |
| Mail Accounts | Features | Your email accounts for sending and reading email |
| Advanced | System | How the program protects its own key, and how much it writes to the log |
Some pages only show up when they apply to you:
The General page has these parts.
Module Discovery: decides which modules GpgFrontend looks for when it starts. The choices are Only Integrated Modules, Also Look For Modules I’ve Added and Disable. The default is Only Integrated Modules. Looking for a module never runs it. See Module Controller for the rest. A change here takes effect the next time you start GpgFrontend.
Sandboxed builds hide the whole Base box.
Sandboxed builds hide Default Workspace As: and File Panel Opens At:. They always start with the Text Editor, and ask for a folder each time you open a File Panel.
For more about the two recipient checks and about undo, see Encryption Safety.
Pick the language GpgFrontend uses. System Default follows your operating system. Changing it reloads the window.
Sandboxed builds hide the Data box.
The Appearance page changes how GpgFrontend looks. It has four boxes.
Theme sets the look of buttons, lists and windows. The list shows the styles your system offers. Changing it reloads the window.
The toolbar is the row of buttons at the top of the main window.
| Setting | Choices | Default |
|---|---|---|
| Icon Size | small, medium, large | medium |
| Icon Style | just text, just icons, text and icons | text and icons |
| Actions | Tick the actions that get a button | Encrypt, Decrypt, Sign, Verify |
On click only appears when you tick more than one action in the Encrypt or Decrypt row. It picks which action a plain click runs. See Customization for how the buttons share actions.
This box sets the font of the text editor, where you type and paste messages.
The Status Panel is the area below the workspace that shows the result of each task. This box has its own Font Family and Font Size (9 to 18, default 12). They work like the ones for the text editor.
The Network page holds the proxy settings. A proxy is a server that passes on GpgFrontend’s network traffic for it. You only need one if your network requires it. Sandboxed builds do not have this page.
The Proxy box:
With System Default, the address, port, user name and password fields are greyed out.
To test your proxy:
The Updates page has one box, Update Checking, with two checkboxes:
GpgFrontend only checks after the first-run setup has asked you whether you want this.
To check yourself, click Help > Check for Updates. If you have not turned the check on, the window does not check by itself. Click Check now to check once. The window then tells you one of these things:
Click Details to see each check the app made. For how the check works, see How Releases and Updates Work.
A key database is a folder where your keys are kept.
The Key Databases page lists your key databases and lets you add, edit and remove them. You can also pick which one is the default with Use as Default.
At the top is the Built-in Key Database box:
Below it, your other key databases are sorted into three tabs:
| Tab | What it holds |
|---|---|
| In Profile | Key databases kept inside your profile |
| Local Only | Key databases outside your profile, on this computer only |
| Recycle Bin | Key databases you removed from In Profile. Their keys are still on this computer |
Right-click a key database for more actions, such as Open (show its folder) and Copy Folder Path.
Sandboxed builds hide the Local Only tab and the Edit action. There, the built-in database cannot be turned off.
For the details, see Key Database.
This page decides what making a new key starts with. It has two tabs.
A pattern is normal text with placeholders in curly braces. GpgFrontend
replaces each placeholder with a value. For example, the default name pattern
anon-{token} gives anon- followed by 8 random letters and digits. Click
Placeholders to see them all. Some useful ones:
{token}: 8 random letters and digits, the same in every field.{domain} and {tld}: a made-up domain. {tld} gives test, example or
invalid, so no mail can ever reach the address.{date}: today’s date.Restore Default Patterns puts the three patterns back as they were.
The list shows every profile and its Status: Default, Hidden, Unavailable (your engine cannot make it) or Offered. Click a profile to see what it makes and where it appears in the Generate Key window.
You cannot delete or hide the default profile. Choose another default first. Deleting a profile never changes keys you already made with it.
Restore Built-in Profiles… adds back the profiles GpgFrontend comes with, if you deleted any. Your own profiles and your changes are kept.
The GnuPG page only appears if your copy of GpgFrontend has the GnuPG engine.
| Option | What it does | Default |
|---|---|---|
| Enable GpgME Debug Log | Writes much more detail about GnuPG to the log, to help find a problem. Needs a restart. | Off |
| Terminate GnuPG background processes on exit | Stops GnuPG’s helper programs when you close GpgFrontend. This can affect other apps that use GnuPG. | On |
| Clear password cache on exit | Makes GnuPG forget every passphrase it remembers when you close GpgFrontend. | On |
| Forbid all GnuPG network connection. | Keeps GnuPG offline. Takes effect without a restart. | Off |
Sandboxed builds hide Clear password cache on exit.
Use this box only if you want GpgFrontend to use a GnuPG you installed yourself.
gpgconf program, which is part of
GnuPG.If the folder does not hold gpgconf, an Illegal GnuPG Path message
tells you so, and nothing changes.
Three buttons that fix a stuck GnuPG. See If GnuPG Stops Responding.
This box only shows up when GnuPG cannot start because the folder path of the key database is too long. GnuPG needs a short path for its helper program. Move to a key database in a shorter folder, on the Key Databases page.
The rPGP page only appears if your copy of GpgFrontend has the rPGP engine. It has three boxes.
The rPGP engine can remember a passphrase for a while, so you do not have to type it again each time. These settings only affect the rPGP engine.
| Setting | What it means | Range | Default |
|---|---|---|---|
| Password Cache TTL (minutes): | Forget the passphrase after it has not been used for this long. Each use starts the time again. | 1 to 1440 (24 hours) | 10 minutes |
| Password Cache Max TTL (minutes): | Forget the passphrase this long after you first typed it, even if it is still in use. | 1 to 10080 (7 days) | 120 minutes |
The second value is never shorter than the first. If you set it shorter, GpgFrontend saves it as the same as the first.
Passphrase Prompt Timeout (seconds): how long the passphrase window waits for you. When the time is up, the window closes and the task is cancelled. You can pick from 0 to 3600 seconds. 0 shows as Never: the window then waits as long as needed. The default is 60 seconds.
This only applies to rPGP keys. GnuPG asks for passphrases in its own window, which has its own time limit.
Argon2 Parameters: is used when you encrypt with a password only. The choices are High memory, 2 GiB (the default) and Low memory, 64 MiB. See Choose How Much Memory Argon2 Uses.
The Advanced page has two boxes. Every change here takes effect only after a restart.
| Setting | Choices | Default |
|---|---|---|
| Log Level: | Trace, Debug, Info, Warning, Error, Fatal | Error |
| Log Ring Buffer: | 128 to 65536 entries | 1024 |
Log Level: decides how much GpgFrontend writes to its log. The log is a record of what the program did, and it helps to find problems. Trace writes the most. It adds detail from modules that Debug leaves out.
Log Ring Buffer: is how many recent log messages GpgFrontend keeps in memory, for crash reports and the log viewer. A bigger number uses more memory.
A profile can come with fixed values for Secure Level:, Application Key Protection:, Log Level: or Log Ring Buffer:. A fixed setting is greyed out, and a note on the page says that some settings are fixed. You cannot change a fixed setting in this window.
You can also set the level for one run when you start GpgFrontend from a terminal:
gpgfrontend --log-level traceThe short form is -l. The values are trace, debug, info, warn and
error.
Most settings take effect the moment you click OK. That now includes all changes on the Key Databases page, the built-in database’s engine, and Forbid all GnuPG network connection. on the GnuPG page. GpgFrontend opens your key databases again, without a restart.
On macOS there are no OK and Cancel buttons. Your changes are saved when you close the window.
A few settings still need a restart. If you changed one of them, GpgFrontend shows a Restart Required message when you click OK. It names the pages with these changes. Click Save and Restart or Save and Reload to apply them, or Cancel to throw away every change you made in the window.
These changes reload the window:
These changes restart the program:
A module’s settings page may also ask for a restart.
One exception: the buttons in the Maintenance part of the GnuPG page. See If GnuPG Stops Responding.
The GnuPG page has a Maintenance section with three buttons. Try them first when GnuPG hangs, forgets your passphrase at the wrong moment, or stops seeing your smart card. Sandboxed builds, such as Flatpak, hide this section and the Clear password cache on exit option.
These buttons act the moment you click them. Cancel does not undo them. Restarting interrupts anything GnuPG is doing, so do not use it during a large file operation.
When something looks wrong, it helps to see what GpgFrontend is using right now. Click Help > About, then open the Status tab.
The tab shows:
Hold the mouse over a row to read more about it, or to see a long value in full.
To share this with someone who helps you, click Copy Status Information. It copies every row, including the hidden ones.
Your key databases are not listed here. Look on the Key Databases settings page instead.
The other tabs of the About window are also useful: