This document provides comprehensive installation instructions for ZeroVault across all supported platforms.

• Automatic Installation
• Platform-Specific Installation
  • Windows
  • Linux
  • MacOS
• Installation Verification
• Troubleshooting
• Building from Source
• Uninstallation

ZeroVault features a self-installation mechanism that automatically sets everything up the first time you run it.

1. Download the executable for your platform
2. Run any ZeroVault command
3. The program automatically:
   • Copies itself to ~/.zerovault/bin/ (or %USERPROFILE%\.zerovault\bin on Windows)
   • Adds this location to your PATH
   • Continues executing your original command

You'll see a brief message during this process:

✔ ZeroVault installed to /Users/username/.zerovault/bin
⟳ Relaunching …

After this one-time setup, you can run zerovault from anywhere without specifying the path.

1. Download the executable:

   curl.exe -L -o zerovault.exe https://github.com/ParleSec/zerovault/releases/latest/download/zerovault-windows-amd64.exe

   Or download directly from your browser: zerovault-windows-amd64.exe

2. Run the executable (it will self-install):

   .\zerovault.exe --help

3. Restart your Command Prompt or PowerShell to recognize PATH changes

1. Download the executable as above

2. Create a directory for ZeroVault:

   mkdir "%USERPROFILE%\.zerovault\bin"

3. Move the executable:

   move zerovault.exe "%USERPROFILE%\.zerovault\bin"

4. Add to PATH (in PowerShell):

   $env:Path += ";$env:USERPROFILE\.zerovault\bin"
   [Environment]::SetEnvironmentVariable("Path", $env:Path, "User")

1. Download the appropriate executable:

   Maximum compatibility (static binary):

   curl -L -o zerovault https://github.com/ParleSec/zerovault/releases/latest/download/zerovault-linux-musl-amd64

2. Make it executable:

   chmod +x zerovault

3. Run the executable (it will self-install):

   ./zerovault --help

4. Open a new terminal window to recognize PATH changes

1. Download and make executable as above

2. Create the destination directory:

   mkdir -p ~/.zerovault/bin

3. Move the executable:

   mv zerovault ~/.zerovault/bin/

4. Add to your PATH by adding this line to your ~/.bashrc or ~/.profile:

   export PATH="$HOME/.zerovault/bin:$PATH"

5. Reload your shell configuration:

   source ~/.bashrc  # or ~/.profile

Current MacOS support is limited due to me not having a Mac machine. ZeroVault will run on MacOS systems, but will require manually building from source.

• see Building from Source

Verify that ZeroVault is correctly installed:

zerovault --version

You should see output displaying the version number, like:

zerovault 1.0.0

You can also run a self-test:

zerovault test

This will perform encryption/decryption tests to ensure everything is working correctly.

If you get a "command not found" error after installation:

Windows:

1. Restart your Command Prompt/PowerShell

2. Verify the PATH includes ZeroVault:

   $env:Path

3. If needed, manually add to PATH:

   [Environment]::SetEnvironmentVariable("Path", "$env:Path;$env:USERPROFILE\.zerovault\bin", "User")

Linux:

1. Restart your terminal session

2. Verify the PATH includes ZeroVault:

   echo $PATH

3. If needed, manually add to PATH in your shell configuration file:

   echo 'export PATH="$HOME/.zerovault/bin:$PATH"' >> ~/.bashrc
   source ~/.bashrc

Linux:

1. If you get a permission error:

   chmod +x ~/.zerovault/bin/zerovault

If automatic installation fails:

1. Try the manual installation steps for your platform
2. Check file permissions in the destination directory
3. Ensure you have write access to the destination directory
4. For package manager installations, ensure you have admin privileges

• Rust 1.70 or higher
• Cargo build tools
• Git

1. Clone the repository:

   git clone https://github.com/ParleSec/zerovault
   cd zerovault

2. Build and install with Cargo:

   cargo install --path .

3. Verify installation:

   zerovault --version

For optimized performance:

cargo install --path . --release

For cross-compilation to other platforms:

# Install target
rustup target add x86_64-pc-windows-msvc

# Build
cargo build --release --target x86_64-pc-windows-msvc

• Missing dependencies: Install the build essentials for your platform

  • Debian/Ubuntu: sudo apt install build-essential
  • CentOS/RHEL: sudo yum groupinstall "Development Tools"
  • Windows: Install Visual Studio Build Tools

• OpenSSL issues: Install the OpenSSL development package

  • Debian/Ubuntu: sudo apt install libssl-dev pkg-config
  • CentOS/RHEL: sudo yum install openssl-devel

Windows:

1. Delete the directory:

   rmdir /s /q "%USERPROFILE%\.zerovault"

2. Remove from PATH (PowerShell):

   $path = [Environment]::GetEnvironmentVariable("Path", "User")
   $path = $path -replace "$env:USERPROFILE\\\.zerovault\\bin;", ""
   [Environment]::SetEnvironmentVariable("Path", $path, "User")

Linux:

1. Delete the directory:

   rm -rf ~/.zerovault

2. Remove the PATH entry from your shell configuration file (~/.bashrc, ~/.zshrc, or ~/.profile)

Homebrew:

brew uninstall zerovault

Debian/Ubuntu:

sudo dpkg -r zerovault

Cargo Installation:

cargo uninstall zerovault