Vaultify Wiki ‐ Installation Guide - Vault-Tek/Vaultify GitHub Wiki

Overview

Vaultify is a locally hosted password manager, meaning it runs directly on your device without relying on cloud storage. This guide will walk you through installing Vaultify on your system, setting up dependencies, and ensuring everything is configured correctly.

Prerequisites

Before installing Vaultify, make sure your system meets the following requirements:

System Requirements

✔️ Operating System: Windows, macOS, Linux (Debian-based recommended)
✔️ Processor: x86_64 or ARM64 architecture
✔️ Memory: Minimum 2GB RAM (4GB recommended)
✔️ Storage: At least 100MB of free disk space

Required Dependencies

Ensure you have the following installed before proceeding:

🔹 Python 3.9+ – Required for running Vaultify’s backend processes
🔹 Node.js (Optional) – Needed for certain UI customizations
🔹 Git – For cloning the repository
🔹 pip – Python package manager
🔹 cryptography & bcrypt libraries – Required for encryption handling

You can install these dependencies using the following commands:

Windows (PowerShell)

winget install Python.Python.3
winget install Git.Git

Then, install required Python libraries:

pip install cryptography bcrypt

Linux (Debian-based)

sudo apt update && sudo apt install python3 python3-pip git
pip3 install cryptography bcrypt

macOS (Homebrew)

brew install python git
pip3 install cryptography bcrypt

Installation Methods

1. Installing via Git (Recommended)

The easiest way to install Vaultify is by cloning the repository from GitHub:

git clone https://github.com/Vault-Tek/Vaultify.git
cd vaultify

Once cloned, set up the environment:

pip install -r requirements.txt  # Install dependencies

Then, start Vaultify:

python vaultify.py

2. Running as a Standalone Executable (Pre-Built Binary)

For users who don’t want to install dependencies manually, a pre-built executable is available.

  1. Download the latest release from the Releases Page.
  2. Extract the downloaded ZIP file.
  3. Run the Vaultify executable:
    • Windows: Double-click vaultify.exe
    • Linux/macOS: Open a terminal in the extracted folder and run: 
      ./vaultify

3. Running Vaultify as a Docker Container

If you prefer a containerized setup, you can run Vaultify using Docker.

  1. Install Docker if you haven’t already:

  2. Pull the Vaultify Docker image:

    docker pull yourusername/vaultify:latest

  3. Run the container:

    docker run -d --name vaultify -p 8080:8080 Vault-Tek/vaultify

Vaultify will now be accessible at http://localhost:8080.

Post-Installation Setup

Creating Your First Vault

Once Vaultify is installed, follow these steps to set up your first password vault:

  1. Launch Vaultify using the preferred method above.
  2. Create an account when prompted.
  3. Set up a Master Password – This will be used to encrypt and access your stored credentials.
  4. Configure security settings such as auto-lock timeout and 2FA options (if available).
  5. Start adding and managing your passwords securely!

Uninstallation

If you ever need to remove Vaultify from your system, follow these steps:

Windows

Remove-Item -Recurse -Force C:\Path\To\Vaultify

Linux/macOS

rm -rf ~/vaultify

If installed via Docker, remove the container:

docker stop vaultify && docker rm vaultify
docker rmi yourusername/vaultify

Next Steps

🔹 Getting Started – Learn how to use Vaultify effectively.
🔹 Customization – Modify UI, themes, and keyboard lighting.
🔹 Security Features – Understand Vaultify’s encryption and authentication mechanisms.

📌 Need help? Visit our Troubleshooting or open an issue on GitHub.