site_name: EdgeX Foundry Documentation
docs_dir: docs_src
site_dir: docs/4.1
site_description: 'Documentation for use of EdgeX Foundry'
site_author: 'Michael Johanson'
site_url: 'https://docs.edgexfoundry.org/4.1'
repo_url: 'https://github.com/edgexfoundry/edgex-go'
repo_name: 'edgex/edgex-go'
copyright: 'Copyright © 2023 EdgeX Foundry'
strict: false   # mkdocs-materials will prevent running on 0.0.0.0 otherwise (or have custom image)
validation:
  nav:
    omitted_files: info
    not_found: warn
    absolute_links: info
  links:
    not_found: warn
    absolute_links: info
    unrecognized_links: ignore
theme:
  name: 'material'
  logo: 'assets/logo_edgex_white.png'
  favicon: 'assets/logo_edgex.png'
  features:
    - navigation.tabs  # changed with version 6 of mkdocs-materials
    - navigation.footer
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: custom 
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
nav:
  - Home:
    - Overview: index.md
    - about.md
    - Getting Started: 
      - Guides: getting-started/index.md
      - getting-started/quick-start/index.md
      - getting-started/Ch-GettingStartedUsers.md
      - getting-started/Ch-GettingStartedDockerUsers.md
      - getting-started/tools/Ch-GUI.md
    - Developer:
        - getting-started/Ch-GettingStartedDevelopers.md
        - getting-started/Ch-GettingStartedGoDevelopers.md
        - getting-started/Ch-GettingStartedCDevelopers.md
        - getting-started/Ch-GettingStartedHybrid.md
        - Native Build and Run Guides:
            - getting-started/native/Ch-BuildRunNative.md
            - getting-started/native/Ch-BuildRunOnLinuxDistro.md
            - getting-started/native/Ch-BuildRunOnArm32.md
            - getting-started/native/Ch-BuildRunOnWindows.md
        - Application Functions SDK - Go: microservices/application/sdk/Purpose.md
        - Application Functions SDK - Python: microservices/application/sdk-python/Purpose.md
        - Device Services:
            - microservices/device/GettingStarted.md
        - getting-started/Ch-GettingStartedUsersNexus.md
        - getting-started/Ch-GettingStartedDTOValidation.md
    - APIs:
        - api/Ch-APIIntroduction.md
        - api/core/Ch-APICoreCommand.md
        - api/core/Ch-APICoredata.md
        - api/core/Ch-APICoreMetadata.md
        - api/core/Ch-APICoreKeeper.md
        - api/core/Ch-APICoreConfigurationAndRegistry.md
        - api/support/Ch-APISupportNotifications.md
        - api/support/Ch-APISupportScheduler.md
        - api/devices/Ch-APIDeviceSDK.md
        - App Services: microservices/application/ApiReference.md
        - api/applications/Ch-APIRulesEngine.md
    - Services:
      - Core: 
        - microservices/core/Ch-CoreServices.md
        - Core Data:
            - Purpose: microservices/core/data/Purpose.md
            - Getting Started: microservices/core/data/GettingStarted.md
            - Configuration: microservices/core/data/Configuration.md
            - API Reference: microservices/core/data/ApiReference.md
            - Source Code: microservices/core/data/SourceCode.md
            - Additional Details:
              - Events and Readings: microservices/core/data/details/EventsAndReadings.md
              - Data Retention: microservices/core/data/details/DataRetention.md
        - Core Metadata:
            - Purpose: microservices/core/metadata/Purpose.md
            - Getting Started: microservices/core/metadata/GettingStarted.md
            - Configuration: microservices/core/metadata/Configuration.md
            - API Reference: microservices/core/metadata/ApiReference.md
            - Source Code: microservices/core/metadata/SourceCode.md
            - Additional Details:
              - Device Profile: microservices/core/metadata/details/DeviceProfile.md
              - Device System Events: microservices/core/metadata/details/DeviceSystemEvents.md
        - Core Command:
            - Purpose: microservices/core/command/Purpose.md
            - Getting Started: microservices/core/command/GettingStarted.md
            - Configuration: microservices/core/command/Configuration.md
            - API Reference: microservices/core/command/ApiReference.md
            - Source Code: microservices/core/command/SourceCode.md
            - Additional Details:
              - Regex Get Command: microservices/core/command/details/RegexGetCommand.md
      - Supporting: 
        - microservices/support/Ch-SupportingServices.md
        - Notifications:
            - Purpose: microservices/support/notifications/Purpose.md
            - Getting Started: microservices/support/notifications/GettingStarted.md
            - How-To Guides:
                - Configure Email Notifications: microservices/support/notifications/HowTo_EmailNotifications.md
            - Configuration: microservices/support/notifications/Configuration.md
            - API Reference: microservices/support/notifications/ApiReference.md
            - Source Code: microservices/support/notifications/SourceCode.md
            - Additional Details:
                - Data Retention: microservices/support/notifications/details/DataRetention.md
        - Scheduler:
            - Purpose: microservices/support/scheduler/Purpose.md
            - Getting Started: microservices/support/scheduler/GettingStarted.md
            - Configuration: microservices/support/scheduler/Configuration.md
            - API Reference: microservices/support/scheduler/ApiReference.md
            - Source Code: microservices/support/scheduler/SourceCode.md
            - Additional Details:
                - Data Retention: microservices/support/scheduler/details/DataRetention.md
        - microservices/support/eKuiper/Ch-eKuiper.md
      - Device:
        - Device Service: microservices/device/DeviceService.md
        - Getting Started: microservices/device/GettingStarted.md
        - How-To Guides:
          - Remote Deployment:
            - Non-Secure Mode: microservices/device/how-to/Ch-RemoteNonSecure.md
            - Secure Mode: microservices/device/how-to/Ch-RemoteSecure.md
        - Configuration: microservices/device/Configuration.md
        - API Reference: microservices/device/ApiReference.md
        - Additional Details:
            - Device Profiles: microservices/device/details/DeviceProfiles.md
            - Device Commands: microservices/device/details/DeviceCommands.md
            - Device Definitions: microservices/device/details/DeviceDefinitions.md
            - Auto Events: microservices/device/details/AutoEvents.md
            - Device Discovery: microservices/device/details/DeviceDiscovery.md
            - Command-line Options: microservices/device/details/CommandLine.md
            - Environment Variables: microservices/device/details/EnvironmentVariables.md
            - Seeding Secrets: microservices/device/details/SeedingSecrets.md
            - Service Metrics: microservices/device/details/ServiceMetrics.md
        - Device Service SDK:
            - Purpose: microservices/device/sdk/Purpose.md
            - Device System Events: microservices/device/sdk/DeviceSystemEvents.md
            - Getting Started:
                - Go SDK: microservices/device/sdk/devicesdk-getting-started/GettingStartedSDK-Go.md
                - C SDK: microservices/device/sdk/devicesdk-getting-started/GettingStartedSDK-C.md
            - APIs:
                - Go SDK:
                    - DeviceServiceSDK: microservices/device/sdk/api/GoDeviceSDK/GoDeviceSDKAPI.md
                    - ProtocolDriver: microservices/device/sdk/api/GoDeviceSDK/GoProtocolDriverAPI.md
                - C SDK:
                    - SDK: microservices/device/sdk/api/CDeviceSDK/CDeviceSDKAPI.md
                    - C Utilities: microservices/device/sdk/api/CDeviceSDK/CUtilities.md
            - Source Code: microservices/device/sdk/SourceCode.md
            - Additional Details:
                - Custom Configuration: microservices/device/sdk/details/CustomConfiguration.md
                - Custom Rest Apis: microservices/device/sdk/details/CustomRestApis.md
                - Custom Service Metrics: microservices/device/sdk/details/CustomServiceMetrics.md
                - Secrets: microservices/device/sdk/details/Secrets.md
        - V3 Migration: microservices/device/V3Migration.md
        - Services:
          - Device BacNet: microservices/device/services/device-bacnet.md
          - Device COAP: microservices/device/services/device-coap.md
          - Device GPIO:
              - Purpose: microservices/device/services/device-gpio/Purpose.md
              - Getting Started: microservices/device/services/device-gpio/GettingStarted.md
              - Configuration: microservices/device/services/device-gpio/Configuration.md
              - Protocol Properties: microservices/device/services/device-gpio/ProtocolProperties.md
              - API Reference: microservices/device/services/device-gpio/ApiReference.md
              - Source Code: microservices/device/services/device-gpio/SourceCode.md
          - Device Modbus: 
              - Purpose: microservices/device/services/device-modbus/Purpose.md
              - Getting Started: microservices/device/services/device-modbus/GettingStarted.md
              - Configuration: microservices/device/services/device-modbus/Configuration.md
              - Protocol Properties: microservices/device/services/device-modbus/ProtocolProperties.md
              - API Reference: microservices/device/services/device-modbus/APIReference.md
              - Source Code: microservices/device/services/device-modbus/SourceCode.md
              - Additional Details:
                - Data Type Conversion: microservices/device/services/device-modbus/details/DataTypeConversion.md             
          - Device MQTT:
            - Purpose: microservices/device/services/device-mqtt/Purpose.md
            - Getting Started: microservices/device/services/device-mqtt/GettingStarted.md
            - How To Guides:
                - How To Add an MQTT Device: microservices/device/services/device-mqtt/Ch-ExamplesAddingMQTTDevice.md
            - Configuration: microservices/device/services/device-mqtt/Configuration.md
            - Protocol Properties: microservices/device/services/device-mqtt/ProtocolProperties.md
            - API Reference: microservices/device/services/device-mqtt/APIReference.md
            - Source Code: microservices/device/services/device-mqtt/SourceCode.md
            - Additional Details:
                - Multi-Level Topics: microservices/device/services/device-mqtt/details/MultiLevelTopics.md
          - Device Onvif Camera:
              - microservices/device/services/device-onvif-camera/General.md
              - microservices/device/services/device-onvif-camera/swagger.md
              - Walkthrough:
                  - microservices/device/services/device-onvif-camera/Walkthrough/setup.md
                  - microservices/device/services/device-onvif-camera/Walkthrough/deployment.md
                  - microservices/device/services/device-onvif-camera/Walkthrough/general-usage.md
                  - microservices/device/services/device-onvif-camera/Walkthrough/custom-build.md
              - Supplementary Information:
                  - ONVIF Protocol:
                      - microservices/device/services/device-onvif-camera/supplementary-info/ONVIF-protocol.md
                      - microservices/device/services/device-onvif-camera/supplementary-info/onvif-user-authentication.md
                  - Features:
                      - microservices/device/services/device-onvif-camera/supplementary-info/custom-metadata-feature.md
                      - microservices/device/services/device-onvif-camera/supplementary-info/friendlyname-mac.md
                      - microservices/device/services/device-onvif-camera/supplementary-info/device-status.md
                      - microservices/device/services/device-onvif-camera/supplementary-info/auto-discovery.md
                      - microservices/device/services/device-onvif-camera/supplementary-info/credentials.md
                      - microservices/device/services/device-onvif-camera/supplementary-info/reboot-needed.md
                  - API Reference:
                      - microservices/device/services/device-onvif-camera/supplementary-info/api-analytic-support.md
                      - microservices/device/services/device-onvif-camera/supplementary-info/api-event-handling.md
                      - microservices/device/services/device-onvif-camera/supplementary-info/api-usage-user-handling.md
                  - Utility:
                      - microservices/device/services/device-onvif-camera/supplementary-info/test-with-postman.md
                      - microservices/device/services/device-onvif-camera/supplementary-info/utility-scripts.md
                  - Miscellaneous:
                      - microservices/device/services/device-onvif-camera/supplementary-info/control-plane-events.md
                      - microservices/device/services/device-onvif-camera/supplementary-info/getting-started-with-docker-security.md
                      - microservices/device/services/device-onvif-camera/supplementary-info/ws-discovery.md
                      - microservices/device/services/device-onvif-camera/supplementary-info/onvif-footnotes.md
          - Device OPC-UA:
              - Purpose: microservices/device/services/device-opc-ua/Purpose.md
              - Getting Started: microservices/device/services/device-opc-ua/GettingStarted.md
              - Configuration: microservices/device/services/device-opc-ua/Configuration.md
              - Protocol Properties: microservices/device/services/device-opc-ua/ProtocolProperties.md
              - API Reference: microservices/device/services/device-opc-ua/ApiReference.md
              - Source Code: microservices/device/services/device-opc-ua/SourceCode.md
          - Device REST:
              - Purpose: microservices/device/services/device-rest/Purpose.md
              - Getting Started: microservices/device/services/device-rest/GettingStarted.md
              - How-To Guides:
                  - Testing: microservices/device/services/device-rest/howto/Testing.md
              - Configuration: microservices/device/services/device-rest/Configuration.md
              - Protocol Properties: microservices/device/services/device-rest/ProtocolProperties.md
              - API Reference: microservices/device/services/device-rest/ApiReference.md
              - Source Code: microservices/device/services/device-rest/SourceCode.md
          - Device RFID LLRP: microservices/device/services/device-rfid-llrp.md
          - Device S7:
              - Purpose: microservices/device/services/device-s7/Purpose.md
              - Getting Started: microservices/device/services/device-s7/GettingStarted.md
              - Configuration: microservices/device/services/device-s7/Configuration.md
              - Protocol Properties: microservices/device/services/device-s7/ProtocolProperties.md
              - API Reference: microservices/device/services/device-s7/ApiReference.md
              - Source Code: microservices/device/services/device-s7/SourceCode.md
              - Additional Details:
                  - microservices/device/services/device-s7/details/DataTypeConversion.md
          - Device SNMP: microservices/device/services/device-snmp.md
          - Device UART:
              - Purpose: microservices/device/services/device-uart/Purpose.md
              - Getting Started: microservices/device/services/device-uart/GettingStarted.md
              - Configuration: microservices/device/services/device-uart/Configuration.md
              - Protocol Properties: microservices/device/services/device-uart/ProtocolProperties.md
              - API Reference: microservices/device/services/device-uart/APIReference.md
              - Source Code: microservices/device/services/device-uart/SourceCode.md
          - Device USB Camera:
              - microservices/device/services/device-usb-camera/General.md
              - Walkthrough:
                  - microservices/device/services/device-usb-camera/walkthrough/setup.md
                  - microservices/device/services/device-usb-camera/walkthrough/deployment.md
                  - microservices/device/services/device-usb-camera/walkthrough/general-usage.md
                  - microservices/device/services/device-usb-camera/walkthrough/custom-build.md
              - Supplementary Information:
                  - microservices/device/services/device-usb-camera/supplementary-info/USB-protocol.md
                  - microservices/device/services/device-usb-camera/supplementary-info/discovery.md
                  - microservices/device/services/device-usb-camera/supplementary-info/advanced-options.md
          - Device Virtual: microservices/device/services/device-virtual/Ch-VirtualDevice.md
      - Application:
        - Application Services: microservices/application/ApplicationServices.md
        - Getting Started: microservices/application/GettingStarted.md
        - Configuration: microservices/application/Configuration.md
        - API Reference: microservices/application/ApiReference.md
        - Additional Details:
            - Command-Line Options: microservices/application/details/CommandLine.md
            - Environment Variables: microservices/application/details/EnvironmentVariables.md
            - Seeding Secrets: microservices/application/details/SeedingSecrets.md
            - Service Metrics: microservices/application/details/ServiceMetrics.md
            - Triggers: microservices/application/details/Triggers.md
        - App Functions SDK - Go:
            - Purpose: microservices/application/sdk/Purpose.md
            - Getting Started: microservices/application/sdk/GettingStarted.md
            - APIs:
                - Application Service: microservices/application/sdk/api/ApplicationServiceAPI.md
                - App Function Context: microservices/application/sdk/api/AppFunctionContextAPI.md
                - Pipeline Functions: microservices/application/sdk/api/BuiltInPipelineFunctions.md
            - Source Code: microservices/application/sdk/SourceCode.md
            - Additional Details:
                - Background Publishing: microservices/application/sdk/details/BackgroundPublishing.md
                - Custom Configuration: microservices/application/sdk/details/CustomConfiguration.md
                - Custom REST APIs: microservices/application/sdk/details/CustomRestApis.md
                - Custom Service Metrics: microservices/application/sdk/details/CustomServiceMetrics.md
                - Pipelines Per Topic: microservices/application/sdk/details/PipelinesPerTopics.md
                - Secrets: microservices/application/sdk/details/Secrets.md
                - Store and Forward: microservices/application/sdk/details/StoreAndForward.md
                - Target Type: microservices/application/sdk/details/TargetType.md
        - App Functions SDK - Python:
            - Purpose: microservices/application/sdk-python/Purpose.md
            - Getting Started: microservices/application/sdk-python/GettingStarted.md
            - APIs:
                - Application Service: microservices/application/sdk-python/api/ApplicationServiceAPI.md
                - App Function Context: microservices/application/sdk-python/api/AppFunctionContextAPI.md
                - Pipeline Functions: microservices/application/sdk-python/api/BuiltInPipelineFunctions.md
            - Source Code: microservices/application/sdk-python/SourceCode.md
            - Additional Details:
                - Custom Configuration: microservices/application/sdk-python/details/CustomConfiguration.md
                - Custom REST APIs: microservices/application/sdk-python/details/CustomRestApis.md
                - Custom Service Metrics: microservices/application/sdk-python/details/CustomServiceMetrics.md
                - Error Handling: microservices/application/sdk-python/details/ErrorHandling.md
                - Pipelines Per Topic: microservices/application/sdk-python/details/PipelinesPerTopics.md
                #- Secrets: microservices/application/sdk-python/details/Secrets.md
                - Store and Forward: microservices/application/sdk-python/details/StoreAndForward.md
                - Target Type: microservices/application/sdk-python/details/TargetType.md
        - V3 Migration: microservices/application/V3Migration.md
        - Services:
            - App Service Configurable:
                - Purpose: microservices/application/services/AppServiceConfigurable/Purpose.md
                - Getting Started: microservices/application/services/AppServiceConfigurable/GettingStarted.md
                - Configuration: microservices/application/services/AppServiceConfigurable/Configuration.md
                - API Reference: microservices/application/services/AppServiceConfigurable/ApiReference.md
                - Source Code: microservices/application/services/AppServiceConfigurable/SourceCode.md
                - Additional Details:
                  - Pipeline Per Topics: microservices/application/services/AppServiceConfigurable/details/PipelinePerTopics.md
                  - Available Pipeline Functions: microservices/application/services/AppServiceConfigurable/details/AvailablePipelineFunctions.md
                  - Available Profiles: microservices/application/services/AppServiceConfigurable/details/Profiles.md
                  - Target Type: microservices/application/services/AppServiceConfigurable/details/TargetType.md
            - App RFID LLRP Inventory:
               - Purpose: microservices/application/services/AppLLRPInventory/Purpose.md
               - Getting Started: microservices/application/services/AppLLRPInventory/GettingStarted.md
               - Configuration: microservices/application/services/AppLLRPInventory/Configuration.md
               - API Reference: microservices/application/services/AppLLRPInventory/ApiReference.md
               - Source Code: microservices/application/services/AppLLRPInventory/SourceCode.md
               - Additional Details:
                   - Inventory Events: microservices/application/services/AppLLRPInventory/details/InventoryEvents.md
                   - Tag Location Algorithm: microservices/application/services/AppLLRPInventory/details/TagLocationAlgorithm.md
                   - Location Aliases: microservices/application/services/AppLLRPInventory/details/LocationAliases.md
                   - Behaviors: microservices/application/services/AppLLRPInventory/details/Behaviors.md
                   - Mobility Profile: microservices/application/services/AppLLRPInventory/details/MobilityProfile.md
            - App Record & Replay :
                - Purpose: microservices/application/services/AppRecordReplay/Purpose.md
                - Getting Started: microservices/application/services/AppRecordReplay/GettingStarted.md
                - Configuration: microservices/application/services/AppRecordReplay/Configuration.md
                - API Reference: microservices/application/services/AppRecordReplay/ApiReference.md
                - Source Code: microservices/application/services/AppRecordReplay/SourceCode.md
      - Configuration & Registry:
        - microservices/configuration/ConfigurationAndRegistry.md
        - microservices/configuration/CommonConfiguration.md
        - microservices/configuration/CommonCommandLineOptions.md
        - microservices/configuration/CommonEnvironmentVariables.md
        - V3 Migration: microservices/configuration/V3MigrationCommonConfig.md
      - microservices/general/index.md
      - microservices/general/messagebus.md
      - Database:
        # - microservices/general/database/Ch-Redis.md
        - microservices/general/database/Ch-Postgres.md
    - Security:
      - Security Services: security/Ch-Security.md
      - security/Ch-SecretStore.md
      - security/Ch-SecretStoreSetup.md
      - security/Ch-Authenticating.md
      - security/Ch-SecretProviderApi.md
      - security/Ch-APIGateway.md
      - security/Ch-Secure-MessageBus.md
      - security/Ch-Secure-Postgres.md
      - security/Ch-Configuring-Add-On-Services.md
      - security/Ch-Secure-Consul.md
      - security/Ch-SecurityIssues.md
      - security/secrets-config.md
      - security/secrets-config-proxy.md
      - security/SeedingServiceSecrets.md
      - security/Ch-CORS-Settings.md
      - security/Ch-DelayedStartServices.md
      - security/Ch-RemoteDeviceServices.md
      - security/Rootless-Docker.md
      - V3 Migration: security/V3Migration.md
      - Threat Models:
        - threat-models/secret-store/README.md
        - threat-models/stride-model/EdgeX-STRIDE.md
        - threat-models/stride-model/EdgeXFoundryThreatReportV2.2.md
    - Migration:
      - V3.0 Migration:
        - General Migration: V3TopLevelMigration.md
        - Security Migration: security/V3Migration.md
        - Configuration Migration: microservices/configuration/V3MigrationCommonConfig.md
        - Device Service Migration: microservices/device/V3Migration.md
        - Application Service Migration: microservices/application/V3Migration.md
    - Tutorials:
      - examples/Ch-ExamplesVirtualDeviceService.md
      - examples/Ch-ExamplesSendingAndConsumingBinary.md
      - examples/Ch-CommandingDeviceThroughRulesEngine.md
      - Adding a Device:
        - examples/Ch-ExamplesAddingSNMPDevice.md
        - microservices/device/services/device-mqtt/Ch-ExamplesAddingMQTTDevice.md
      - Walkthrough:
        - walk-through/Ch-Walkthrough.md
        - walk-through/Ch-WalkthroughSetup.md
        - walk-through/Ch-WalkthroughUseCase.md
        - walk-through/Ch-WalkthroughDeviceProfile.md
        - walk-through/Ch-WalkthroughProvision.md
        - walk-through/Ch-WalkthroughCommands.md
        - walk-through/Ch-WalkthroughReading.md
        - walk-through/Ch-WalkthroughExporting.md
    - Examples:
      - Code Examples: examples/index.md
      - App Service Examples:
        - examples/AppServiceExamples.md
  - Reference:
    - general/Definitions.md
    - general/PlatformRequirements.md
    - general/ServicePorts.md
    - general/ContainerNames.md
    - general/ServiceConfiguration.md
    - general/EdgeX_CN.md
  - Use Case & Design:
    - Process: design/Process.md
    - Documents: design/TOC.md
    - Legacy:
      - Designs: design/legacy-design/README.md
      - Requirements: design/legacy-requirements/README.md
markdown_extensions:
  - codehilite
  - admonition
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.mark
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - attr_list
  - md_in_html
  - tables
  # - mdx_truly_sane_lists
extra:
  version:
    provider: mike
  # - make edgexversion the latest version for repository tree references
  social:
    - icon: 'fontawesome/brands/github-alt'
      link: 'https://github.com/edgexfoundry'
    - icon: 'fontawesome/brands/twitter'
      link: 'https://twitter.com/edgexfoundry'
    - icon: 'fontawesome/brands/linkedin'
      link: 'https://www.linkedin.com/company/edgexfoundry'
  analytics:
    provider: google
    property: G-38531ZZHBN
extra_css:
- assets/stylesheets/version-select.css
- assets/stylesheets/branding.css
- assets/stylesheets/edgey.css
- assets/stylesheets/newexample.css
- assets/stylesheets/extra.css
plugins:
  - search
  - swagger-ui-tag
  - macros:
      include_yaml:
        - template_macros.yaml
      on_error_fail: true
  - htmlproofer:
      enabled: !ENV [ENABLED_HTMLPROOFER, false]
      raise_error: false
      url_ignore:
        - https://www.gnu.org/prep/standards/html_node/Program-Behavior.html
        - https://linuxtv.org/wiki/index.php/V4l-utils
      raise_error_excludes:
        400: ['https://help.axis.com/en-us/axis-os-hardening-guide#onvif-replay-attack-protection']
        403: ['https://www.collinsdictionary.com/us/dictionary/english/unit-of-measurement',
              'https://www.pcmag.com/encyclopedia/term/run-native','https://www.vmware.com/topics/glossary/content/kubernetes-cluster.html',
              'https://app.getpostman.com/','https://www.raspberrypi.com/products/raspberry-pi-3-model-b/',
              'https://www.raspberrypi.com/software/','https://linuxize.com/post/how-to-install-and-configure-redis-on-ubuntu-20-04/','https://linuxize.com/post/how-to-install-gcc-on-ubuntu-20-04/',
              'https://linuxize.com/post/how-to-install-and-configure-redis-on-ubuntu-20-04/','https://stackoverflow.com/questions/19091087/open-redis-port-for-remote-connections',
              'https://serverfault.com/questions/861519/how-to-turn-off-protected-mode-in-redis','https://stackoverflow.com/questions/5180192/onvif-authentication-failure-with-axis-p3301-using-onvif-protocol ']
        404: ['https://support.google.com/accounts/answer/185833?hl=en','https://support.google.com/accounts/answer/6010255?hl=en',
              'https://github.com/IOTechSystems/app-functions-sdk-python/blob/main/src/app_functions_sdk_py/contracts/clients/interfaces/deviceprofile.py','https://github.com/IOTechSystems/app-functions-sdk-python/blob/main/src/app_functions_sdk_py/contracts/clients/interfaces/command.py',
              'https://github.com/IOTechSystems/app-functions-sdk-python/blob/main/src/app_functions_sdk_py/contracts/clients/interfaces/event.py','https://github.com/IOTechSystems/app-functions-sdk-python/blob/main/src/app_functions_sdk_py/contracts/clients/interfaces/deviceservice.py',
              'https://github.com/IOTechSystems/app-functions-sdk-python/blob/main/src/app_functions_sdk_py/contracts/clients/interfaces/device.py','https://github.com/IOTechSystems/app-functions-sdk-python/blob/main/src/app_functions_sdk_py/contracts/clients/interfaces/reading.py',
              'https://github.com/IOTechSystems/app-functions-sdk-python/tree/main/examples/custom-trigger','https://github.com/IOTechSystems/app-functions-sdk-python/tree/main/examples/custom-config',
              'https://github.com/IOTechSystems/app-functions-sdk-python/blob/main/examples/custom-config/main.py#L76-L96','https://github.com/IOTechSystems/app-functions-sdk-python/blob/main/examples/custom-config/main.py#L12-L30',
              'https://github.com/IOTechSystems/app-functions-sdk-python/tree/main/examples/custom-rest-api']
        429: ['*']
        -1: ['https://www.rfc-editor.org/rfc/rfc7519',
             'https://tools.ietf.org/html/rfc5869','https://docs.iotaap.io/docs-rest/','https://unece.org/fileadmin/DAM/cefact/recommendations/rec20/rec20_rev3_Annex2e.pdf']
        500: [https://packages.ubuntu.com/bionic/build-essential]