Skip to main content

Network Configuration

Arvist is delivered as an on-premises solution via a Docker network. This Docker-based architecture allows for a flexible and secure deployment that can be tailored to meet specific customer needs. The Docker network hosts several key services that can be exposed based on customer requirements.

Arvist is designed to work seamlessly with a wide range of cameras, providing flexibility while ensuring optimal performance. Below are the recommended camera specifications and setup guidelines to achieve the best results with the Arvist platform.

1. IP Cameras (RTSP)​

  • Recommendation: For the best performance and integration with Arvist, we recommend using IP cameras that support RTSP (Real-Time Streaming Protocol) and are configured according to the following specifications:

    Main Stream (Recording & RTSP)​

    • Encode Mode: H.264
    • Resolution: 2688x1520
    • Frame Rate (FPS): 15
    • I Frame Interval: 30

    Sub Stream (Detection)​

    • Enable: Sub Stream 2
    • Encode Mode: H.264
    • Resolution: 1280x720
    • Frame Rate: 5
    • I Frame Interval: 5

  • Functionality: These settings ensure high-quality recording on the main stream while optimizing the sub stream for efficient detection without overloading network or storage resources.

2. HTTP-Based Cameras​

  • Use Cases: In certain limited scenarios, HTTP-based cameras like Reolink can be integrated into the Arvist platform.
  • Functionality: These cameras utilize HTTP for streaming, making them suitable for specific situations where RTSP might not be necessary or available.
  • Considerations: While supported, HTTP-based cameras may not deliver the same level of performance or compatibility as those using RTSP, particularly with the recommended specifications.

3. USB Devices (Webcams)​

  • Compatibility: Arvist also supports connecting to USB devices, such as webcams, when directly hooked up to the camera system.
  • Use Cases: This setup is useful for small-scale installations or particular use cases that benefit from direct USB connections.
  • Considerations: USB devices typically offer more basic functionality and may lack the resolution, frame rate, and scalability of IP cameras configured with the recommended specifications.

Available Services​

1. MQTT (Message Queuing Telemetry Transport)​

  • Purpose: An IoT layer designed for delivering event-driven applications.
  • Functionality: MQTT can be used for external services to trigger other internal processes, both inside and outside the Arvist platform.
  • Use Cases: Ideal for integrating IoT devices and other event-driven applications with the Arvist ecosystem.

2. Arvist HTTP API​

  • Purpose: A RESTful API for interacting with the Arvist platform.
  • Functionality: Allows for the retrieval and submission of data to the Arvist platform via JSON.
  • Use Cases: Useful for integrating external systems with Arvist, enabling automation, data analysis, and reporting.

3. Arvist NVR (Network Video Recorder)​

  • Purpose: A service that manages video streams and related data.
  • Functionality: Provides MQTT publications, HTTP services, RTSP restreams, and more.
  • Use Cases: Offers lower-level access to Arvist, facilitating advanced integrations and custom setups.

4. PostgreSQL (SQL)​

  • Purpose: A powerful, open-source relational database management system.
  • Functionality: Provides robust data storage, retrieval, and management capabilities for Arvist's various data needs.
  • Use Cases: Ideal for storing and querying large datasets, supporting complex queries, and integrating with other Arvist services to maintain structured data.

5. Arvist Dashboard​

  • Purpose: A comprehensive web-based interface for managing and monitoring the Arvist platform.
  • Functionality: Provides access to various tools, modules, and settings within the Arvist ecosystem, including real-time monitoring, configuration management, and user administration.
  • Use Cases: Ideal for daily operations, allowing users to interact with the platform's features, manage devices, review footage, configure modules, and access reports and analytics.

Connecting to Arvist Outside Facility​

1. Cloudflare Zero Trust VPN Network​

  • Recommendation: Devices are highly recommended to connect to Arvist’s Cloudflare Zero Trust VPN network. This setup is essential for enabling remote premium support and seamless updates.
  • Configuration: No network configurations are required on the customer’s side for these services to function.
  • Limited Access: Customers can request limited connections to specific services via our VPN as needed.

2. Public Access Considerations​

  • Reverse Proxy Recommendation: If public access to services is required, we strongly recommend using a reverse proxy such as Apache, nginx, or traefik. This setup helps encrypt and control traffic, ensuring only the necessary ports are exposed.
  • Security Warning: Directly forwarding our services to the open internet without an intermediary, such as a reverse proxy, is strongly discouraged. Our services do not have built-in encryption, and exposing them directly could lead to significant security risks.

Additional Resources​