Skip to main content

Getting Started Guide

Page 2.1.1: Accessing the Web Interface

Introduction

Welcome to the Inventory Management System! This guide will help you access the web interface so you can start managing your inventory efficiently.

Prerequisites

  • System Setup: Ensure that the Inventory Management System is installed and running on your local machine or server.
  • Network Access: Confirm that your device is connected to the same network as the server hosting the system if accessing remotely.
  • Web Browser: Use a modern web browser such as Google Chrome, Mozilla Firefox, Microsoft Edge, or Safari for optimal performance.

Steps to Access the Web Interface

  1. Open Your Web Browser

    • Launch your preferred web browser on your computer or mobile device.
  2. Navigate to the Web Interface URL

    • Local Access:
      • Enter the following URL in the address bar:
        http://127.0.0.1:8080
      • This URL is used when the system is running on your local machine.
    • Remote Access:
      • Replace 127.0.0.1 with the IP address or domain name of the server where the system is hosted:
        http://your-server-ip:8080
      • Ensure that port 8080 is open and accessible.
  3. Verify the Connection

    • Press Enter after typing the URL.
    • You should see the login page or the administrator account setup page if it's your first time accessing the system.

Troubleshooting

  • Cannot Access the Web Interface

    • Check Server Status: Ensure the server or local instance is running. If using Docker, verify that the containers are up by running: docker-compose ps
    • Firewall Settings: Make sure that your firewall or security software is not blocking port 8080.
    • Network Issues: Confirm that your device is connected to the correct network and that there are no connectivity issues.
  • Browser Compatibility

    • Update your browser to the latest version.
    • Clear your browser's cache and cookies.
    • Try accessing the interface using a different browser.
  • Incorrect URL

    • Double-check the URL for typos.
    • Ensure that you are using the correct IP address or domain name for remote access.

Page 2.1.2: Creating an Administrator Account

Introduction

An administrator account is required to manage system configurations, users, and advanced settings. This account has full access to all features and permissions within the Inventory Management System.

Steps to Create an Administrator Account

  1. Access the Web Interface

    • Open your web browser and navigate to the system's URL:
      http://127.0.0.1:8080
  2. Initiate Administrator Account Setup

    • Since this is your first time accessing the system and no users exist yet, you will be automatically prompted to create an administrator account.
  3. Fill Out the Registration Form

    • Username: Choose a unique username for your administrator account.
    • Password: Create a strong password that meets the following criteria:
      • At least 8 characters long.
      • Includes uppercase and lowercase letters.
      • Contains numbers and special characters.
    • Confirm Password: Re-enter your password to confirm it matches.
  4. Submit the Form

    • Click the "Create Account" or "Register" button to proceed.
  5. Configure System Settings (Optional)

    • After account creation, you may be directed to initial configuration settings where you can:
      • Enable User Enrollment: Allow other users to sign up independently.
      • Set Inventory Access: Choose between password-protected or read-only access for non-authenticated users.
      • Configure Other Preferences: Set default language, time zone, and notification settings.
  6. Log In

    • If not automatically logged in, you will be redirected to the login page.
    • Enter your administrator username and password to log in.

Security Recommendations

  • Protect Your Credentials

    • Do not share your administrator credentials with others.
    • Avoid using easily guessable usernames or passwords.
  • Password Management

    • Consider using a reputable password manager to store your credentials securely.
    • Change your password regularly and avoid reusing passwords from other accounts.
  • Enable Two-Factor Authentication (2FA)

    • If the system supports it, enable 2FA for an extra layer of security.

Troubleshooting

  • Unable to Create Account

    • Ensure all required fields are filled out correctly.
    • Check for any error messages indicating issues with the database or server.
    • Restart the server or Docker containers if necessary.
  • System Does Not Prompt for Account Creation

    • There may already be an existing administrator account.
    • Try logging in with the default credentials if provided.
    • If you have access to the server, you may need to reset the system's user database.