Locksidian

Locksidian is an add-on for the Obsidian note-taking app that adds a password prompt when entering your vault. You can find my blog post on it here.

This plugin does NOT add local file protection

Installation

1. Download the latest release of the Locksidian add-on from the Releases page.
2. In Obsidian, go to Settings > Third-party Plugins.
3. Enable Community Plugins if you haven't already.
4. Open the folder for community plugins.
5. Create a new folder inside called 'locksidian'
6. Copy the 3 downloaded files into the folder.
7. Restart Obsidian.
8. Locksidian should now appear in the list of installed plugins in the Obsidian settings.

Usage

1. Upon launching Obsidian or opening a vault, Locksidian will display a password prompt.
2. Enter the correct password to unlock access to the vault.
3. If the password is incorrect, Locksidian will display an error message and prompt for the password again.
4. Once the correct password is entered, the password prompt will be closed, and you can access your vault.

Configuration

Currently, Locksidian uses a hardcoded password ('password123') for demonstration purposes. To change the password:

1. Open the Obsidian settings for Locksidian
2. Locate the 'Password' section
3. Replace 'password123' with your desired password.

Development

To build and modify the Locksidian code:

1. Clone this repository: git clone https://github.com/SineCrepusculum/locksidian.git.
2. Navigate to the project directory: cd locksidian.
3. Install the dependencies: npm install.
4. Make the desired modifications to the code.
5. Build the project: npm run build.
6. The compiled main.js file will be generated in the dist directory.
7. Follow the installation steps above to install the modified Locksidian add-on in Obsidian.

Contributing

Contributions to Locksidian are welcome! If you find any bugs or have suggestions for improvements, please open an issue or submit a pull request.

License

This project is licensed under the MIT License.