⚡
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

Docker Deployment

Welcome to the Docker Deployment section for LightningUserVault. Docker offers a consistent and reproducible environment, making it a breeze to set up and run LightningUserVault

PreviousQuickstart GuideNextLocal Deployment

Last updated 1 year ago

🐳 Getting Started with Docker

In the LightningUserVault repository, you'll find a dedicated docker folder that contains everything you need to get started with Docker deployment. Here's the link to the for your convenience.

Inside this folder, there are two essential files:

  1. Dockerfile: This file contains the instructions to build the LightningUserVault Docker image. It sets up the Go environment, copies your application files, and compiles the application.

  2. docker-compose.yaml: This file defines and configures the services you'll need to run LightningUserVault. It ensures that all the components of your application run in harmony.

🚀 What's Bootstrapped Using Docker?

  1. Webapp (LightningUserVault): This is the core application responsible for user data storage and retrieval functionalities.

  2. Postgres: An advanced relational database system. If you opt for the SQL storage method, user data will be stored here.

  3. Memcached: An in-memory key-value store known for its high performance. It's used in LigningUserVault to cache data, significantly speeding up data retrieval operations.

  4. Prometheus: An open-source monitoring and alerting toolkit. It's integrated to collect and store metrics from the application, providing insights into its performance.

  5. Grafana: A popular open-source platform for monitoring and observability. It visualizes the metrics collected by Prometheus, offering detailed dashboards for better understanding and analysis of the application's performance.

⚙️ Configuration and Customization

By default, the Docker deployment uses a set of predefined parameters. However, if you wish to customize these settings, you can easily do so by modifying the docker-compose.yaml file. The environment section under the webapp service contains various parameters like LOG_LEVEL, SERVER_ADDRESS, and more. Adjust these values as per your requirements before starting the Docker containers.

📝 How to (from docker folder):

Start the Docker Services:
docker-compose up -d

Stop the Docker Services:
docker-compose down

folder