README file from
GithubMeld Encrypt Plugin for Obsidian
Create Encrypted Notes Within Your Obsidian.md Vault
Meld Encrypt is a community plugin that lets you encrypt and decrypt your notes in Obsidian. You can choose to encrypt an entire note or just selected text within a note.
While you view or edit an encrypted note, the plugin keeps its saved contents encrypted. Choosing Decrypt note or Decrypt in-place, or exporting through the CLI, writes plaintext that may be synced or backed up.
[!WARNING] ⚠️ Use at Your Own Risk ⚠️
- Passwords are normally remembered only in memory for the current session. External file mode reads a password from a file you provide. Without the correct password, encrypted content cannot be recovered.
- The encryption methods used have not been independently audited. Unauthorized access may be possible if someone gains access to your files.
- Bugs may be introduced at any time. You are solely responsible for maintaining backups of your notes.
Installation
Requires Obsidian 1.13.0 or later. Meld Encrypt supports desktop and mobile.
- Open your vault in Obsidian and go to Settings → Community plugins.
- Turn on community plugins if prompted, then click Browse.
- Search for Meld Encrypt, select it, and click Install.
- Click Enable. Configure password confirmation and password remembering under Settings → Meld Encrypt.
Basic usage
Open the command palette with Ctrl+P on Windows/Linux or Cmd+P on macOS, or use Obsidian's Open command palette action on mobile. Search for the Meld Encrypt commands below.
Encrypt an entire note
- Run Meld Encrypt: Create new encrypted note.
- Enter and confirm a password, optionally add a hint, and click Confirm.
- Write your note. Its saved contents are encrypted in a
.mdencfile. - Run Meld Encrypt: Lock and close all open encrypted notes when finished.
- To read or edit it later, open the encrypted file and enter its password when prompted.
To encrypt an existing Markdown note, right-click it in the file explorer and select Encrypt note, or open it and run Meld Encrypt: Convert to or from an encrypted note. Using that command on an encrypted note converts it back to plaintext.
Encrypt selected text
- Open a Markdown note in the editor and select the text to encrypt. If Expand selection to whole line? is enabled under Settings → Meld Encrypt, partial selections expand to include the whole line.
- Run Meld Encrypt: Encrypt selection, enter and confirm a password, and click Confirm.
- To reveal the text, place the cursor inside the encrypted block and run Meld Encrypt: Decrypt. Enter the password when prompted.
- Edit the revealed text and click Save to re-encrypt your changes. Decrypt in-place replaces the encrypted block with plaintext in the note.
See the guides for whole encrypted notes, selected-text encryption, and settings for more details.
Ongoing Maintenance and Development
If you find this plugin useful please support the ongoing maintenance and development by:
Thank you for your support 😊
Latest Changes
Information about the latest release can be found on the release notes page.
Report any bugs or features requests here.
Documentation
Documentation can be found here