Skip to content
Klutch.sh Docs

Deploying Open QuarterMaster

Introduction

Open QuarterMaster is an open-source inventory and supply chain management system designed to help organizations track, manage, and optimize their physical assets and supplies. Whether you are managing a warehouse, workshop, hackerspace, or organizational supplies, Open QuarterMaster provides the tools to maintain accurate inventory records and streamline operations.

The platform offers features for tracking items across multiple storage locations, managing item categories and attributes, generating reports, and integrating with barcode scanners for efficient inventory operations.

Key features of Open QuarterMaster include:

  • Multi-Location Inventory: Track items across multiple storage locations and containers
  • Barcode Support: Generate and scan barcodes for quick item lookup and management
  • Category System: Organize items with customizable categories and attributes
  • Transaction History: Complete audit trail of all inventory movements
  • Low Stock Alerts: Automated notifications when items reach minimum thresholds
  • Search and Filtering: Powerful search capabilities across all inventory data
  • User Management: Role-based access control for team environments
  • Import/Export: Bulk data operations via CSV import and export
  • Mobile Friendly: Responsive interface for inventory checks on mobile devices
  • API Access: RESTful API for integration with other systems

This guide walks through deploying Open QuarterMaster on Klutch.sh using Docker.

Why Deploy Open QuarterMaster on Klutch.sh

Deploying Open QuarterMaster on Klutch.sh provides reliable inventory management:

Centralized Access: Access your inventory from anywhere with a web-based interface instead of spreadsheets or local software.

Persistent Storage: Store inventory data and images with persistent volumes that survive updates.

HTTPS by Default: Secure access to your inventory system with automatic SSL certificates.

Team Access: Multiple team members can access and update inventory simultaneously.

Custom Domains: Use a memorable domain for easy access to your inventory system.

Prerequisites

Before deploying Open QuarterMaster on Klutch.sh, ensure you have:

Deploying Open QuarterMaster on Klutch.sh

    Create Your Dockerfile

    Create a Dockerfile in your repository:

    FROM openjdk:17-slim
    

    # Install dependencies
    RUN apt-get update && apt-get install -y \
        curl \
        && rm -rf /var/lib/apt/lists/*
    

    # Download Open QuarterMaster
    WORKDIR /app
    RUN curl -L https://github.com/Epic-Breakfast-Productions/OpenQuarterMaster/releases/latest/download/open-quartermaster.jar -o app.jar
    

    # Create data directories
    RUN mkdir -p /data/db /data/files
    

    ENV JAVA_OPTS="-Xmx512m"
    

    EXPOSE 8080
    

    CMD ["java", "-jar", "app.jar"]

    Push to GitHub

    Commit and push your Dockerfile to your GitHub repository.

    Create a New Project on Klutch.sh

    Navigate to the Klutch.sh dashboard and create a new project.

    Create and Configure the App

    Create a new app and connect it to your GitHub repository.

    Configure HTTP Traffic

    Set the traffic type to HTTP with an internal port of 8080.

    Set Environment Variables

    Configure environment variables as needed:

    VariableDescription
    JAVA_OPTSJVM memory settings
    OQM_ADMIN_PASSWORDInitial admin password

    Attach Persistent Volumes

    Add persistent storage:

    Mount PathRecommended SizePurpose
    /data/db10 GBDatabase storage
    /data/files20 GBUploaded images and attachments

    Deploy Your Application

    Click Deploy to build and launch your Open QuarterMaster instance.

    Access Your Inventory System

    Once deployed, access your Open QuarterMaster instance and create your first inventory locations and categories.

Additional Resources