🎉 V-Portal 0.6.2 is released! Read more
Skip to Content
Quick StartSetup V-Portal

Setup V-Portal

This guide walks you through installing V‑Portal in your environment and completing the initial setup required to get up and running.

System Requirements

Ensure the target environment meets the following requirements before installing V‑Portal:

Operating System

Any Docker supported OS (Ubuntu 20.04+ recommended)

DockerVersion 20.10+
Docker ComposeCompose**: Version 2.0+
RAMMinimum 4GB, recommended 8GB+
Disk SpaceMinimum 10GB free

Steps to Install

  1. Download the V-Portal Installer
  2. Prepare the target host/environment
    • Ensure the OS and platform match the prerequisites listed above.
  3. Copy the V-Portal installer to the target server, place it in a directory where you can acquire root access.
  4. Ensure dependencies are installed (Docker)
  5. Run the installer using the commands below:
chmod +x v-portal-installer.run ./v-portal-installer.run
  1. Verify the installation
    • Access the V-Portal webpage from a browser using your device’s IP and confirm the login page loads.

Perform a basic smoke test (login, navigate to 1–2 key screens, verify no obvious errors).

Post-Installation

After installation, proceed to Login and First-time Access to begin using V-Portal.

Initial Setup Steps

Complete these steps to configure your V-Portal instance for first use.

User Management Setup

  1. Create Additional Users

    • Navigate to Settings → User Management
    • Add team members with appropriate roles
  2. Configure Roles

    • Define user roles and permissions
    • Assign roles to users

System Configuration

Network Settings

Configure network access:

  • Port configurations
  • Proxy settings (if applicable)
  • SSL/TLS certificates (for production)

Module Installation

Install required modules for your use case:

  1. Navigate to Modules section
  2. Upload module files (.vmod)
  3. Configure module settings
  4. Enable modules

Creating Your First Page

  1. Go to Pages
  2. Click “Create New Page”
  3. Add widgets to your page
  4. Save and view your page

Next Steps

Last updated on