⚡
LightningUserVault
  • Introduction
  • GETTING STARTED
    • Quickstart Guide
      • Docker Deployment
      • Local Deployment
    • Server Commands
  • Architecture
    • Overview
    • API Server
    • Data Storage:
      • Key-Value Databases
        • Pebbel DB
      • SQL Databases
        • PostgreSQL
    • Caching Mechanism:
      • MEMCACHE
  • Additional Features
    • Swagger
    • Postman Collection
    • Prometheus
    • Grafana
  • Releases
  • Contribution
Powered by GitBook
On this page
  1. GETTING STARTED
  2. Quickstart Guide

Local Deployment

Welcome to the fast lane! If you're looking to ran Lightning User Vault right on your machine, you're in the right place. Let's get you set up and running in no time!

🛠️ Prerequisites:

  1. Ensure you have git installed to clone the repository.

  2. For caching and database functionalities, you'll need to have PostgreSQL and Memcached preinstalled. If you don't want to use these services, you can disable caching and use the Pebble database instead.

📝 Steps:

Clone the Repository:

git clone git@github.com:Aleksao998/LightningUserVault.git
cd LightningUserVault

Build the Binary:

make build

Run the Server:

./build/lightning_user_vault server

⚙️ Configuration:

The server runs with default parameters, but you can override them in two ways:

  1. Using Flags: You can provide flags when starting the server to override default configurations. For a detailed list of available flags, refer to this link.

  2. Using Environment Variables: You can set environment variables to configure the server. For a detailed list of available environment variables, refer to this linkthis link.

Note: If both flags and environment variables are provided, the environment variables will take priority.

PreviousDocker DeploymentNextServer Commands

Last updated 1 year ago