31 lines
1.5 KiB
Markdown
31 lines
1.5 KiB
Markdown
# CryptPad
|
|
|
|
CryptPad is a privacy-first, end-to-end encrypted collaboration suite. Documents are encrypted in the browser before being stored — the server never sees plaintext content.
|
|
|
|
## Configuration
|
|
|
|
Key settings in `config.yaml`:
|
|
|
|
- **domain** - Main domain for CryptPad
|
|
- **sandboxDomain** - Sandbox subdomain for secure iframe isolation (default: `cryptpad-sandbox.{your-cloud-domain}`)
|
|
- **storage** - Persistent volume size (default: `2Gi`)
|
|
|
|
## Usage
|
|
|
|
No account is required to create documents. Just visit the app URL and start creating spreadsheets, code pads, presentations, or rich-text documents. Share the document URL with collaborators.
|
|
|
|
## Admin Setup
|
|
|
|
To access the admin panel, you need to register an account and then link it to the `adminKey` secret:
|
|
|
|
1. Register an account at the app URL
|
|
2. Go to your user settings and copy your **Public Signing Key**
|
|
3. The `adminKey` in `secrets.yaml` should match this key — it is pre-populated with a generated value, but you must replace it with your actual account's public signing key after registering
|
|
4. Once set, the **Admin** link will appear in the user menu
|
|
|
|
## Notes
|
|
|
|
- Both the main domain and the sandbox domain must be accessible — CryptPad uses the sandbox domain for secure iframe isolation, and the app will not function correctly if one is missing
|
|
- All encryption keys are generated client-side — if you lose your account passphrase, documents cannot be recovered
|
|
- The instance can be configured to require registration before creating documents (via the admin panel)
|