Skip to content

Home

Jump to bottom
Janus edited this page Jul 1, 2023 · 3 revisions

Locksidian

Welcome to the Locksidian wiki! Locksidian is a basic plugin for Obsidian that adds a lock screen to protect your vault and enhance security. This wiki provides a comprehensive guide to using Locksidian and its features.

Table of Contents

  1. Introduction
  2. Installation
  3. Getting Started
  4. Lock Screen
  5. Sidebar Shortcut
  6. Lock Vault Command
  7. New Features to be added
  8. FAQs
  9. Support
  10. Contributing
  11. License

Introduction

Locksidian is a plugin for Obsidian that adds an extra layer of security to your vault. It allows you to set up a lock screen that appears when you launch Obsidian or when you trigger the lock vault command. This lock screen ensures that unauthorized users cannot access your vault without entering the correct password.

Installation

To install Locksidian, follow these steps:

  1. Open Obsidian and navigate to the "Community Plugins" tab in the settings.
  2. Search for "Locksidian" in the plugin search bar.
  3. Click the "Install" button next to Locksidian.
  4. Once installed, activate the plugin by toggling the switch next to its name.

Lock Screen Settings

Enabling the Lock Screen

The lock screen feature allows you to protect your Obsidian vault with a password. To enable the lock screen:

  1. Open the Locksidian plugin settings.
  2. Toggle the "Enable Lock Screen" option to enable the feature.
  3. Save the settings.

Once enabled, the lock screen will appear when you launch Obsidian or trigger the lock vault command.

Setting a Username

You can customize the username displayed on the lock screen. This username can be your name, alias, or any identifier you prefer. To set the username:

  1. Open the Locksidian plugin settings.
  2. Enter your desired username in the "Username" field.
  3. Save the settings.

The lock screen will now display the specified username.

Changing the Password

The password is the key to unlocking your vault and accessing your notes. It's important to set a strong and secure password. To change the password:

  1. Open the Locksidian plugin settings.
  2. Enter your new password in the "Password" field.
  3. Save the settings.

Make sure to choose a strong password that combines uppercase and lowercase letters, numbers, and special characters. Avoid using common words or easily guessable phrases.

Sidebar Shortcut

Locksidian provides a convenient sidebar shortcut to quickly lock your vault. This shortcut allows you to trigger the lock screen with a single click, providing an efficient way to secure your notes.

To use the sidebar shortcut:

  1. Look for the "Lock Vault" icon in the sidebar.
  2. Click the icon to trigger the lock screen.

The lock screen will appear, requiring you to enter the password to unlock the vault.

Lock Vault Command

In addition to the sidebar shortcut, Locksidian also provides a lock vault command that you can execute using the command palette or by assigning a custom keyboard shortcut.

To lock the vault using the lock vault command:

  1. Open the command palette by pressing "Cmd/Ctrl + P".
  2. Search for the "Lock Vault" command.
  3. Select the command to trigger the lock screen.

The lock screen will be displayed, prompting you to enter the password to unlock the vault.

Features ToDo

  • Offline video background
  • Encrypt + Decrypt
  • Wallpaper options + settings
  • Opacity and Blur settings

FAQs

Q: Can I customize the appearance of the lock screen? Yes, Locksidian allows you to customize the lock screen's appearance by modifying the 'styles.css' file. You can adjust the font, colours, background, and other visual aspects according to your preferences.

Q: Can I use a local video or image for the lock screen background? No, Locksidian (as of now) does not support using local videos or images as the lock screen background. (This feature is soon to be added)

Q: How can I reset my password if I forget it? To reset your password, you can uninstall and reinstall the Locksidian plugin. This will reset all plugin settings, including the password. However, keep in mind that this will also remove any other customizations and configurations you've made.

Support

If you encounter any issues or have questions regarding Locksidian, please reach out for support. You can find the following support channels:

Feel free to open bug reports, feature requests, or general inquiries in the appropriate channels. The community and I will be happy to assist you.

Contributing

Locksidian is an open-source project, and contributions are welcome! If you have ideas for improvements, bug fixes, or new features, you can contribute to the plugin's development.

To contribute to Locksidian:

  1. Fork the Locksidian GitHub repository.
  2. Make your desired changes or additions.
  3. Submit a pull request with your changes.

I'll review your contribution and merge it if appropriate. Contributions help improve the plugin and benefit the entire community.

License

Locksidian is distributed under the MIT License. You can find the detailed license information in the plugin's GitHub repository.

Clone this wiki locally