mirror of
https://github.com/narrrl/proton-drive-linux.git
synced 2026-11-03 16:41:26 +01:00
nvrl
9c30ff8276
- scripts/publish-wiki.sh publishes every page listed in SECTIONS, copies images, writes a sectioned sidebar and footer, and removes stale pages. --check fails on links to missing files or headings and on docs pages that are neither published nor excluded. - New wiki.yml runs the check on pull requests and pushes to main, and publishes when release.yml calls it or when started by hand. - Split USER_GUIDE.md into topic pages (files, synced folders, photos, sharing, computers, launcher and tray); add Getting started and FAQ. - Make the COPR repository the main Fedora path, with update and uninstall steps for every package type. - Fix the stale CAPTCHA note in CLI.md, document pdfs unlock and lock, and drop the broken AGENTS.md link from CONTRIBUTING.md.
60 lines
2.9 KiB
Markdown
60 lines
2.9 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 |
|
|
| **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).
|