Getting Started: Encryption Programs Setup Script (PTE and Kleopatra)
=====================================================================

This guide walks you through installing two free encryption programs,
step by step, on Windows, Linux or a Raspberry Pi. No prior experience
needed -- just follow along.

For more information, see https://sitrepnet.com/


1. What these programs are, and what the script does
-----------------------------------------------------

PTE (Paranoia Text Encryption) is a free program from Paranoia Works
(paranoiaworks.mobi) that encrypts and decrypts text messages with a
password. It can also hide a message inside a picture (this is called
"steganography").

Kleopatra is a free program for GnuPG (also called OpenPGP or PGP)
encryption. Instead of a shared password, each person has a pair of
"keys": a public key you give to others so they can encrypt messages to
you, and a private key only you have, to decrypt them. Kleopatra makes
and manages these keys and encrypts, decrypts and signs files and text.

The script downloads the current version of each program from its
official source, installs anything else it needs (Java, for PTE), and
adds both programs to your menu and desktop. Run it again later to update
them. If there's nothing new, nothing is downloaded.


2. What you need before starting
---------------------------------

- One of:
    Windows 10 or Windows 11
    A Debian-based Linux system: Debian, Ubuntu, Linux Mint, Pop!_OS
    Raspberry Pi OS (32-bit or 64-bit)
- A desktop. Both programs open in a window, so they won't run on a Pi
  set up without a screen ("Lite" versions of Raspberry Pi OS).
- An internet connection.
- An account that can install programs (on Linux and the Pi, the normal
  default account that can use sudo; on Windows, an account that can
  answer "Yes" to the Windows permission prompt).
- A few minutes. On a Raspberry Pi allow 15-30 minutes the first time --
  Kleopatra needs a large download there.

Windows users: follow sections 3W-5W. Linux and Raspberry Pi users: skip
to sections 3L-5L. Everyone then continues at section 6.


3W. Windows: download the scripts
----------------------------------

1. Download BOTH of these files into the same folder (e.g. your
   Downloads folder):

     install-encryption.bat
     install-encryption.ps1

   If you were given a zip file (install-encryption-1.0.0.zip)
   instead, right-click it, choose "Extract All", and use the
   install-encryption folder inside the extracted folder.


4W. Windows: run it
--------------------

1. Double-click install-encryption.bat.

2. If a blue "Windows protected your PC" box appears, click "More info",
   then "Run anyway". This appears for any downloaded script.

3. A black window opens and the script starts. Read the screen and press
   Enter when asked.

4. When it installs Java or Gpg4win (which contains Kleopatra), Windows
   asks "Do you want to allow this app to make changes to your device?"
   Click Yes. If you click No, that program just isn't installed.

5. When it finishes it says "Press any key to continue". Press a key to
   close the window.


5W. Windows: what you'll see
-----------------------------

  ==> Checking installed vs. latest versions...
    PTE        installed: NOT INSTALLED              latest: release of 2026-09-06
               no Java (Java 11+ will be installed)
    Kleopatra  installed: NOT INSTALLED              latest: Gpg4win 5.1.1

  Which programs would you like to install? (default: both)
    1) PTE
    2) Kleopatra

  Enter a number to SKIP (e.g. 2), or press Enter to install both:

Press Enter to install both. Then:

  ==> PTE
  ==> Downloading Java (Eclipse Temurin 21 JRE)
  Signature OK: (the Java publisher's name)
  ==> Installing Java -- click Yes if Windows asks for permission
  Java 21 found (C:\Program Files\Eclipse Adoptium\...\bin\javaw.exe).
  ==> Downloading PTE
  PTE unpacked into C:\Users\you\Security\Paranoia Text Encryption
  PTE Start menu entry and desktop icon created.

  ==> Kleopatra (Gpg4win)
  ==> Downloading Gpg4win 5.1.1 (about 45 MB)
  Signature OK: g10 Code GmbH
  ==> Installing Gpg4win -- click Yes if Windows asks for permission
  Gpg4win 5.1.1 installed (includes Kleopatra).
  Kleopatra desktop icon created.

  All requested programs are installed and up to date.

Now go to section 6.


3L. Linux / Raspberry Pi: download the script
----------------------------------------------

1. Download install-encryption.sh to your computer (e.g. into your
   Downloads folder).
2. Open a terminal and move into that folder. For example, if it's in
   your Downloads folder:

     cd ~/Downloads

If you were given a zip file (install-encryption-1.0.0.zip) instead,
unzip it and move into the folder it makes:

     cd ~/Downloads
     unzip install-encryption-1.0.0.zip
     cd install-encryption


4L. Linux / Raspberry Pi: make it runnable and run it
------------------------------------------------------

Linux won't run a downloaded script until you mark it executable. Do that
once with:

  chmod +x install-encryption.sh

Then run it:

  ./install-encryption.sh

Don't put "sudo" in front of it. The script asks for your password when
it needs it.


5L. Linux / Raspberry Pi: what you'll see
------------------------------------------

First it shows a short description of what it does, ending with:

  Press Enter to continue...

Press Enter. Then:

  ==> OS: debian (like: n/a), arch: aarch64

  ==> Checking installed vs. latest versions...
    PTE        installed: NOT INSTALLED              latest: release of 2026-09-06
    Kleopatra  installed: NOT INSTALLED              latest: 22.12.3  (from your distribution)

  Which programs would you like to install? (default: both)
    1) PTE
    2) Kleopatra

  Enter a number to SKIP (e.g. 2), or press Enter to install both:

Press Enter to install both. It asks for your password, then:

  ==> PTE
  ==> Installing for PTE: default-jre        (only if Java is needed)
  Java 17 found.
  ==> Downloading PTE
  PTE unpacked into /home/pi/Security/Paranoia Text Encryption
  'pte' command created (/usr/local/bin/pte).
  PTE menu entry and desktop icon created.

  ==> Kleopatra
  ==> Installing Kleopatra 22.12.3 (this can be a large download the first time)
  ... (lots of package installation messages) ...
  Kleopatra 22.12.3 installed.
  Kleopatra desktop icon created.

  All requested programs are installed and up to date.
    Start PTE from the menu, the desktop icon, or by typing:  pte
    Start Kleopatra from the menu, the desktop icon, or by typing:  kleopatra

On a Raspberry Pi you'll also see a note that PTE's image-enlarging
feature isn't available. That's expected -- see section 9.


6. Start the programs
----------------------

Windows:
- Start menu: type PTE or Kleopatra in the Start menu search.
- Desktop: double-click the PTE or Kleopatra icon.

Linux / Raspberry Pi:
- The menu: look under Accessories / Utilities (PTE) and Utilities /
  Security (Kleopatra).
- The desktop icons. The first time, your desktop may ask whether to
  trust or execute them -- choose "Execute" or "Trust and Launch". On
  some desktops you right-click the icon and choose "Allow Launching"
  once.
- A terminal: type  pte  or  kleopatra  and press Enter.

Quick test for PTE: type a short message, enter a password, and click
Encrypt. Then click Decrypt with the same password and you should get
your message back.

Quick start for Kleopatra: click "New Key Pair", enter your name (and an
email address if you want), and set a passphrase you'll remember. Then
use "Export" to save your public key and give that file to the people who
will send you encrypted messages. Never give anyone your private key.


7. Updating later
------------------

Run the script again the same way (double-click install-encryption.bat
on Windows, or ./install-encryption.sh on Linux). Whatever is already
current is skipped:

  PTE is already up to date (release of 2026-09-06). Use --force to reinstall.
  Kleopatra is already up to date (22.12.3). Use --force to reinstall.

Close PTE and Kleopatra before updating them on Windows -- the script
will tell you if one is still open. Your PTE settings and your Kleopatra
keys are kept.


8. Optional settings
---------------------

These work the same way on Windows and Linux. On Windows, run them from
a Command Prompt opened in the script's folder.

Check what's installed without installing anything:

  ./install-encryption.sh --check-only
  install-encryption.bat --check-only

Install or update just one program:

  ./install-encryption.sh --only=pte
  install-encryption.bat --only=kleopatra

PTE window too small on a high-resolution screen?

  ./install-encryption.sh --only=pte --ui-scale=2
  install-encryption.bat --only=pte --ui-scale=2

(Try 1.5 if 2 is too big. The setting is remembered when you update.
Use --ui-scale=1 to go back to normal.)

Other options:

  --dir=FOLDER     Install PTE somewhere other than your Security folder
  --no-desktop     Don't add menu entries or desktop icons
  --force          Reinstall even if you already have the latest version

To see them all:

  ./install-encryption.sh --help
  install-encryption.bat --help


9. Raspberry Pi notes
----------------------

- PTE comes with an extra part that enlarges pictures in its
  steganography editor. Paranoia Works only makes that part for regular
  Intel/AMD PCs, so on a Raspberry Pi that one button says "not
  available". Everything else, including all text encryption and
  decryption and hiding text in pictures, works the same as on a PC.
- Kleopatra comes from Raspberry Pi OS's own software collection. The
  first install also brings in the KDE libraries it's built on, which
  is a few hundred MB -- make sure the SD card has room and give it time.


10. Already installed PTE with the AmRRON setup script?
-------------------------------------------------------

That's fine -- this script uses the same folder, so it updates your
existing PTE instead of installing a second copy.


11. Troubleshooting
--------------------

Windows: "Windows protected your PC" / nothing happens when I double-click
  Click "More info", then "Run anyway". Make sure install-encryption.ps1
  is in the same folder as install-encryption.bat.

Windows: "Windows permission wasn't given"
  You clicked No on the Windows permission prompt. Run the script again
  and click Yes.

Windows: "...isn't valid" or "...is signed by ..., not g10 Code"
  The downloaded installer didn't pass its security check, so it was not
  run. Try again later. If it keeps happening, install Gpg4win yourself
  from https://gpg4win.org/.

Windows: PTE stopped opening from its icon after a Java update
  Run the script again; it points the icon at the current Java.

"Permission denied" (Linux)
  You skipped the chmod step. Run chmod +x install-encryption.sh, then
  try again.

"PTE needs Java 11 or later..." (Linux)
  Your computer has more than one version of Java and an old one is the
  default. Choose a newer one with:

    sudo update-alternatives --config java

PTE doesn't open, or the terminal shows an error about "headless" (Linux)
  Install the full version of Java:

    sudo apt-get install default-jre

"The download isn't a valid zip" or "download failed"
  The website may be busy or down. Nothing on your computer was changed.
  Wait a while and run the script again.

"/usr/local/bin/pte already exists and wasn't made by this script..."
  Something else on your computer already uses the name "pte". The script
  left it alone. Use the menu entry or desktop icon to start PTE instead.

"Kleopatra: your distribution's repositories don't have a 'kleopatra'
package" (Linux)
  Rare on current systems. Make sure your system is up to date
  (sudo apt-get update && sudo apt-get upgrade) and try again.

"Kleopatra is running" (Windows)
  Close Kleopatra, including its icon in the notification area by the
  clock (right-click it, then Quit), and run the script again.


12. Removing the programs
--------------------------

Windows:
  - Delete the PTE icons from the desktop and Start menu, and delete the
    folder  Security\Paranoia Text Encryption  in your user folder.
  - Remove Gpg4win (and Eclipse Temurin JRE, if nothing else needs Java)
    in Settings > Apps.

Linux / Raspberry Pi:

  sudo rm /usr/local/bin/pte
  rm ~/.local/share/applications/pte.desktop ~/Desktop/PTE.desktop
  rm ~/.local/share/icons/pte.png
  rm -r ~/Security/"Paranoia Text Encryption"
  sudo apt-get remove kleopatra
  sudo apt-get autoremove
  rm ~/Desktop/Kleopatra.desktop


13. Need more help?
--------------------

Run the script with --help for the full built-in reference, or see
README.txt alongside this script for a more technical overview.

For more information, see https://sitrepnet.com/
