Files
proton-drive-linux/docs/USER_GUIDE.md
T
nvrl 0df4b3c5f9 feat(gui,core,cli): edit excluded files, open-with rules and the launcher in Preferences (#99)
Preferences gains two pages for the config.json settings that had no
place in the app:

- Sync: the patterns every synced folder leaves out (own patterns, and
  each built-in one on or off), and what the conflict sweep may do.
- Apps: which program opens which kind of file (open_with), and how the
  search launcher opens (prompt).

Each synced folder kept on this computer gets "Excluded Files…" in its
menu for its own .pdfsignore: checked as typed, "Check a path" says
which rule decides, and a version changed elsewhere is never written
over without asking. `pdfs sync ignore list|add|remove|reset|check` does
the same from a terminal, and `--page preferences-sync` (and -apps,
-storage) opens Preferences at a page.

Every writer of config.json now goes through AppDirs::update_config,
which reads, changes and writes under an flock on config.json.lock, so
the app, the tray and the daemon no longer undo each other's change
(B292). The opener reads its rules on each open, so a new rule applies
without a restart.

The built-in ignore list also leaves out what Nextcloud, Dropbox and
Syncthing leave out: desktop.ini, .directory, trash folders, NFS/FUSE
leftovers, partial downloads, Kate swap and office lock files.
2026-11-15 23:03:58 +01:00

62 lines
3.0 KiB
Markdown

# User guide
How Proton Drive for Linux works and how to use it day to day. To install it, see
[Installation](INSTALL.md). If you are new, [Getting started](GETTING_STARTED.md) is the quicker
read.
## Topics
| Page | What it covers |
|---|---|
| [Files and offline access](FILES.md) | The `~/ProtonDrive` folder, keeping files available offline, the Trash, earlier versions |
| [Synced folders](SYNCED_FOLDERS.md) | Backing up local folders, excluding files, changes waiting to upload, conflicts, pausing |
| [Photos](PHOTOS.md) | Timeline, albums, places, duplicates, importing from Google Photos |
| [Sharing](SHARING.md) | Invitations, public links, items shared with you |
| [Computers](COMPUTERS.md) | Other computers in your account, syncing several computers |
| [Search launcher and tray](LAUNCHER_AND_TRAY.md) | Finding files from a keyboard shortcut, the tray icon |
Every command mentioned in these pages is listed in the
[command-line reference](CLI.md).
## How it works
A background service, `proton-drive.service`, runs `pdfs daemon`. It holds your session, talks to
Proton Drive, and shows your Drive as a folder. Everything else asks the service to do things:
| Program | What it is |
|---|---|
| `pdfs-app` | The desktop app: files, photos, sharing, sync, preferences |
| `pdfs-tray` | Tray icon with status, pause and quick actions |
| `pdfs-prompt` | A search launcher for a keyboard shortcut |
| `pdfs` | The command-line client, for everything above and for scripts |
Your files, file names and photos are end-to-end encrypted by Proton. To show them to you, the
service decrypts them on this computer and keeps a cache, which is not encrypted. Use full-disk or
home-folder encryption. The [security model](SECURITY_MODEL.md#what-is-kept-on-this-computer)
lists exactly what is stored.
## Words used in the app
The app uses these words, and so do these pages:
| Term | Meaning |
|---|---|
| **My files** | Everything in your Proton Drive, apart from Photos and computer backups |
| **Proton Drive folder** | Where My files appears on this computer, `~/ProtonDrive` by default |
| **Online only** | A file or folder that downloads when you open it |
| **Available offline** | A file, or a folder with everything in it, kept on this computer |
| **Synced folder** | A local folder with a full copy on this computer, backed up to Proton Drive |
| **Proton Drive service** | The background service (`proton-drive.service`) |
## Preferences
| Page | Settings |
|---|---|
| **General** | Start on login · Proton Drive folder location · upload and download limits · Proton theme, street map for Places, tray icon · language · check for updates |
| **Sync** | Files and folders every synced folder leaves out · what happens to identical conflict copies |
| **Apps** | Which program opens which kind of file · how the search launcher opens |
| **Storage** | Cache size limit · clear the cache · files kept available offline |
The account menu shows the storage you use and holds **Sign Out…**. Settings that are not in the
app are described in [Configuration](CONFIGURATION.md).