Skip to content

This is a password plugin for protecting your private notes and diary, no encrypt, no decrypt.

License

Notifications You must be signed in to change notification settings

qing3962/password-protection

Repository files navigation

Password Protection Plugin

Purpose

I developed this plugin to prevent my girlfriend from peeking my private notes or diaries.

What does this plugin do?

No encrypt, no decrypt, This plugin doesn't modify your notes, it will not do anything with your notes.

If the protected folder you set is the root folder (/), when you launch Obsidian, a password verification box will present, enter the correct password, you can just open a note.

If the protected folder you set is a sub-folder (/xxx), when you open a note that located in the sub-folder, a password verification box will pop up, enter the correct password, you can open the note.

Once you have entered the correct password, you will not be asked to enter it again when opening other protected notes.

If you want to turn on protection again, you may invoke the command panel, type "pass", find the command - Password Protection: Open, run it, when you open a protected note, the password verification box will pop up again.

In Obsidian for Windows, a Password Protection Button locates on the left-bar. Click on it to execute protecting or unprotecting action.

Installation, Configruation, and Usage

  1. Download the latest release zip of the Password Protection plugin from the website.

  2. Open the folder for community plugins of Obsidian, usually locate in .obsidian/plugins of the your vault folder.

  3. Unzip the release zip, a new folder appear named "password-protection", two files in the folder: main.js, manifest.json.

  4. Relaunch Obsidian, click "Settings", choice "Community Plugins", you can see the "Password Protection" in installed plugins list, enable the plugin.

  5. See the left-down part of the Settings, the “Password Protection” will appear, click it, the setting page of the plugin is opened, type the path you want to protect, default path is root path.

  6. Enable the button of password protection, a Password Input Modal will popup, enter your password, click "OK".

  7. the password protection plugin start work, when you open a note in the protected path you set, a Password Verify Modal will popup, enter the right password, you just open the note.

License

This project is licensed under the MIT License.


中文版说明 (For chinese)

目的

我开发这个插件的目的是,防止我的女朋友偷看我的私人笔记或日记。

这个插件做了什么?

这个插件不会加密和解密你的笔记,也不会修改你的笔记,它不会对你的笔记做任何事。

如果你设置的受保护路径是根路径(/),当你启动 Obsidian,你将会看到一个密码验证框,只有输入正确的密码,你才能打开任何一篇笔记。

如果你设置的受保护路径是子路径(/xxx),当你要打开的笔记位于这个子路径,就会弹出一个密码验证框,只有输入正确的密码,你才能继续打开这篇笔记。

一旦输入过一次正确的密码,那么再打开其他受保护的笔记时,不会要求再次输入。

如果你想再次开启保护,可以调出命令面板,输入“pass”,找到命令 - Password Protection: Open,执行它,那么再要打开受保护的笔记,会再次弹出密码验证框。

在 Windows 版的 Obsidian 里,左侧的工具栏会出现一个密码保护按钮,点击它也可以执行保护或不保护动作。

安装、配置和使用

  1. 下载这个插件的最新 Release 版本 zip 包; 下载地址

  2. 找到你的 Obsidian 配置文件夹的插件文件夹:plugins,一般在你的笔记库所在的目录:.obsidian/plugins;

  3. 在插件文件夹中,解压这个插件 zip 包,得到一个目录:.obsidian/plugins/password-protection,里面有两个文件: main.js 和 manifest.json;

  4. 重新启动 Obsidian,在 Settings 中选择“第三方插件”,在右侧下方的“已安装插件”中,可以看到 Password Protection,点击右侧的启用按钮;

  5. 在 Settings 中左侧下方“第三方插件”列表中,可以看到“Password Protection”,点击后右侧打开插件设置页面,设置一个要保护的路径,默认是根路径(/);

  6. 点击插件的启用按钮,弹出密码设置框,输入两遍密码,插件启用成功;

  7. 当你打开一个位于保护路径下的笔记,将弹出密码验证弹窗,只有输入正确的密码,你才能继续打开笔记。

许可证

本插件使用 MIT 许可证。 MIT License


Obsidian Downloads


Buy me a coffee?

About

This is a password plugin for protecting your private notes and diary, no encrypt, no decrypt.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •