LAN Web Overview

This project is a web application that uses Flask to provide an interactive interface to view proxmox servers, virtual machines, and other devices monitored by check_mk. It is designed to run on a local area network (LAN) and provides a StarTrek-themed interface for easy navigation and monitoring.

Features

• View proxmox servers and their virtual machines
• View devices monitored by check_mk and their services
• Interactive and user-friendly interface
• StarTrek-themed design for a unique user experience
• Responsive layout for various screen sizes

Requirements

• Python 3.x
• Flask
• Requests

Installation (Development Setup)

1. Clone the repository:

   git clone <repository-url>
   

2. Navigate to the project directory:

   cd lan-web
   

3. Install the required dependencies:

   pip install -r requirements.txt
   

4. Set up environment variables for configuration (e.g., PROXMOX_API_URL, CHECK_MK_API_URL, etc.).

5. Run the Flask application:

   python app.py
   

6. Open your web browser and navigate to http://localhost:5000.

Installation (Docker Setup)

1. Ensure you have Docker installed on your machine.

2. Clone the repository:

   git clone <repository-url>
   

3. Navigate to the project directory:

   cd lan-web
   

4. Build the Docker image:

   docker build -t lan-web .
   

5. Run the Docker container (the application listens on APP_PORT, default 8081):

   # default image runs gunicorn bound to port 8081
   docker run -d -p 8081:8081 --env-file .env -e APP_PORT=8081 lan-web
   

6. Alternatively, use docker-compose (recommended for development). You can set APP_PORT in your .env file or use the default 8081:

   # with default APP_PORT
   APP_PORT=8081 docker compose up --build -d
   

7. Open your web browser and navigate to http://localhost:8081 (or the port you configured via APP_PORT).

Configuration

The application requires configuration through environment variables. Copy the sample .env.example file in the project root to a new file named .env and fill in the required values.

Usage

1. Start the application using either the development setup or Docker setup.
2. Navigate to the web interface in your browser.
3. Use the navigation menu to explore proxmox servers, virtual machines, and check_mk monitored devices.
4. Click on individual items to view detailed information and status.
5. Use the search functionality to quickly find specific servers or devices.