Generate opengraph images automatically, update configuration defaults with new logos

hyperglass/examples/hyperglass.yaml

@@ -0,0 +1,194 @@
+# cache:
+#   database: 1
+#   host: localhost
+#   port: 6379
+#   show_text: true
+#   timeout: 120
+# cors_origins: []
+# debug: true
+# developer_mode: true
+# docs:
+#   base_url: https://lg.example.net
+#   communities:
+#     description: List of BGP communities.
+#     summary: BGP Communities List
+#     title: BGP Communities
+#   description: ''
+#   devices:
+#     description:
+#       List of all devices/locations with associated identifiers, display
+#       names, networks, & VRFs.
+#     summary: Devices List
+#     title: Devices
+#   enable: true
+#   mode: redoc
+#   openapi_uri: /openapi.json
+#   queries:
+#     description: List of supported query types.
+#     summary: Query Types
+#     title: Supported Queries
+#   query:
+#     description: Request a query response per-location.
+#     summary: Query the Looking Glass
+#     title: Submit Query
+#   title: '{site_title} API Documentation'
+#   uri: /api/docs
+# listen_address: 0.0.0.0
+# listen_port: 8001
+# logging:
+#   directory: /tmp
+#   format: text
+#   http: null
+#   max_size: 50000000
+#   syslog: null
+# messages:
+#   acl_denied: '{target} is a member of {denied_network}, which is not allowed.'
+#   acl_not_allowed: '{target} is not allowed.'
+#   authentication_error: Authentication error occurred.
+#   connection_error: 'Error connecting to {device_name}: {error}'
+#   feature_not_enabled: '{feature} is not enabled.'
+#   general: Something went wrong.
+#   invalid_field: '{input} is an invalid {field}.'
+#   invalid_input: '{target} is not a valid {query_type} target.'
+#   no_input: '{field} must be specified.'
+#   no_output: The query completed, but no matching results were found.
+#   no_response: No response.
+#   parsing_error: An error occurred while parsing the query output.
+#   request_timeout: Request timed out.
+#   vrf_not_associated: VRF {vrf_name} is not associated with {device_name}.
+#   vrf_not_found: VRF {vrf_name} is not defined.
+# netmiko_delay_factor: 0.1
+# org_name: Beloved Hyperglass User
+# primary_asn: '65001'
+# queries:
+#   bgp_aspath:
+#     display_name: BGP AS Path
+#     enable: true
+#     pattern:
+#       asdot: ^(\^|^\_)((\d+\.\d+)\_|(\d+\.\d+)\$|(\d+\.\d+)\(\_\.\+\_\))+$
+#       asplain: .*
+#       mode: asplain
+#   bgp_community:
+#     communities:
+#       - community: 14525:5001
+#         description: Phoenix, AZ Metro Aggregate Routes
+#         display_name: 14525:5001
+#     display_name: BGP Community
+#     enable: true
+#     mode: select
+#     pattern:
+#       decimal: ^[0-9]{1,10}$
+#       extended_as: ^([0-9]{0,5})\:([0-9]{1,5})$
+#       large: ^([0-9]{1,10})\:([0-9]{1,10})\:[0-9]{1,10}$
+#   bgp_route:
+#     display_name: BGP Route
+#     enable: true
+#   ping:
+#     display_name: Ping
+#     enable: true
+#   traceroute:
+#     display_name: Traceroute
+#     enable: true
+# request_timeout: 90
+# site_description: Beloved Hyperglass User Network Looking Glass
+# site_keywords:
+#   - Beloved Hyperglass User
+#   - bgp
+#   - communities
+#   - community
+#   - dev hyperglass
+#   - hyperglass
+#   - internet service provider
+#   - ip
+#   - ipv4
+#   - ipv6
+#   - isp
+#   - lg
+#   - looking glass
+#   - network
+#   - peer
+#   - peering
+#   - routing
+#   - transit
+# site_title: dev hyperglass
+# structured:
+#   communities:
+#     items:
+#       - 14525:\d{4}
+#     mode: permit
+#   rpki:
+#     mode: external
+# web:
+#   credit:
+#     enable: true
+#   dns_provider:
+#     name: cloudflare
+#     url: https://cloudflare-dns.com/dns-query
+#   external_link:
+#     enable: true
+#     title: PeeringDB
+#     url: https://www.peeringdb.com/asn/{primary_asn}
+#   greeting:
+#     button: Continue
+#     enable: false
+#     file: null
+#     required: false
+#     title: Welcome
+#   help_menu:
+#     enable: true
+#     file: null
+#     title: Help
+#   logo:
+#     dark: /Users/ml/dev/hyperglass/hyperglass/images/hyperglass-dark.svg
+#     favicon: /Users/ml/dev/hyperglass/hyperglass/images/hyperglass-icon.svg
+#     height: null
+#     light: /Users/ml/dev/hyperglass/hyperglass/images/hyperglass-light.svg
+#     width: 75%
+#   opengraph:
+#     height: null
+#     image: /Users/ml/dev/hyperglass/hyperglass/images/hyperglass-opengraph.jpg
+#     width: null
+#   terms:
+#     enable: true
+#     file: null
+#     title: Terms
+#   text:
+#     cache_icon: Cached from {time} UTC
+#     cache_prefix: 'Results cached for '
+#     complete_time: Completed in {seconds}
+#     fqdn_tooltip: Use {protocol}
+#     query_location: Location
+#     query_target: Target
+#     query_type: Query Type
+#     query_vrf: Routing Table
+#     rpki_invalid: Invalid
+#     rpki_unknown: No ROAs Exist
+#     rpki_unverified: Not Verified
+#     rpki_valid: Valid
+#     subtitle: really really really really really long subtitle
+#     title: hyperglass
+#     title_mode: logo_subtitle
+#   theme:
+#     colors:
+#       black: '#121212'
+#       blue: '#314cb6'
+#       cyan: '#118ab2'
+#       danger: '#d84b4b'
+#       error: '#ff6b35'
+#       gray: '#c1c7cc'
+#       green: '#35b246'
+#       orange: '#ff6b35'
+#       pink: '#f2607d'
+#       primary: '#118ab2'
+#       purple: '#8d30b5'
+#       red: '#d84b4b'
+#       secondary: '#314cb6'
+#       success: '#35b246'
+#       teal: '#35b299'
+#       warning: '#edae49'
+#       white: '#f5f6f7'
+#       yellow: '#edae49'
+#     default_color_mode: null
+#     fonts:
+#       body: Nunito
+#       mono: Fira Code