| site_name: Apache Knox |
| site_description: Documentation for Apache Knox Gateway |
| site_url: https://knox.apache.org/ |
| use_directory_urls: true |
| |
| theme: |
| name: material |
| features: |
| - navigation.tabs |
| - navigation.sections |
| - navigation.expand |
| - navigation.indexes |
| - navigation.top |
| - search.highlight |
| - search.share |
| - toc.follow |
| - content.code.copy |
| palette: |
| - media: "(prefers-color-scheme: light)" |
| scheme: default |
| primary: custom |
| accent: custom |
| toggle: |
| icon: material/brightness-7 |
| name: Switch to dark mode |
| - media: "(prefers-color-scheme: dark)" |
| scheme: slate |
| primary: custom |
| accent: custom |
| toggle: |
| icon: material/brightness-4 |
| name: Switch to light mode |
| font: |
| text: Roboto |
| code: Roboto Mono |
| extra: |
| footer: |
| - '<a href="https://github.com/apache/knox" target="_blank">GitHub</a>' |
| custom_dir: overrides |
| |
| extra_css: |
| - assets/stylesheets/extra.css |
| |
| plugins: |
| - search |
| |
| nav: |
| - Home: index.md |
| - Quick Start: quick_start.md |
| - Client/User Guide: |
| - Knox Shell: knoxshell-guide/knoxshell_user_guide.md |
| - Discovering Resources: book_client-details.md |
| - Troubleshooting: |
| - General Troubleshooting: book_troubleshooting.md |
| - Client-Specific Troubleshooting: client_troubleshooting.md |
| - FAQ: faq.md |
| - Admin Guide: |
| - Knox CLI: knox_cli.md |
| - Gateway Overview: book_gateway-details.md |
| - Configuration: |
| - Gateway Config Overview: config.md |
| - Knox Security Config: config_kerberos.md |
| - High Availability: config_ha.md |
| - Mutual Auth SSL: config_mutual_authentication_ssl.md |
| - Metrics: config_metrics.md |
| - Audit: config_audit.md |
| - Authentication Services: |
| - Providers: |
| - Overview: config_authn.md |
| - LDAP: |
| - LDAP Group Lookup: config_ldap_group_lookup.md |
| - Advanced LDAP: config_advanced_ldap.md |
| - LDAP Authentication Cache: config_ldap_authc_cache.md |
| - PAM Authentication: config_pam_authn.md |
| - Pre-auth SSO: config_preauth_sso_provider.md |
| - SSO Cookie: config_sso_cookie_provider.md |
| - TLS Client Certificate: config_tls_client_certificate_authentication_provider.md |
| - PAC4J: config_pac4j_provider.md |
| - Hadoop Auth: config_hadoop_auth_provider.md |
| - Services/APIs: |
| - Knox SSO: config_knox_sso.md |
| - API Key: config_apikey.md |
| - Client Credentials: config_client_credentials.md |
| - Knox Auth Service: config_knoxauth_service.md |
| - Knox Token: config_knox_token.md |
| - Authorization: config_authz.md |
| - Identity Assertion: config_id_assertion.md |
| - Web App Security: config_webappsec_provider.md |
| - Service-Specific Configurations: |
| - Overview: service_config.md |
| - Default HA: service_default_ha.md |
| - SSL Certificate Trust: service_ssl_certificate_trust.md |
| - Avatica: service_avatica.md |
| - Cloudera Manager: service_cloudera_manager.md |
| - Elasticsearch: service_elasticsearch.md |
| - HBase: service_hbase.md |
| - Hive: service_hive.md |
| - Kafka: service_kafka.md |
| - Livy: service_livy.md |
| - Oozie: service_oozie.md |
| - Service Test: service_service_test.md |
| - Solr: service_solr.md |
| - Storm: service_storm.md |
| - WebHCat: service_webhcat.md |
| - WebHDFS: service_webhdfs.md |
| - YARN: service_yarn.md |
| - Maintenance and Monitoring: |
| - Admin UI: admin_ui.md |
| - Monitoring API: dev-guide/knox_monitoring_api.md |
| - Metrics and Logs: metrics_logs.md |
| - Troubleshooting: |
| - General Troubleshooting: admin_troubleshooting.md |
| - Authentication Issues: auth_troubleshooting.md |
| - Service-Specific Issues: service_troubleshooting.md |
| - Developer Guide: |
| - Overview: dev-guide/book.md |
| - Extending Knox: |
| - Overview: extending_knox.md |
| - KnoxSSO Integration: dev-guide/knoxsso_integration.md |
| - Custom Authentication: dev-guide/custom_authn.md |
| - API Reference: |
| - Admin API: admin_api.md |
| - Monitoring API: dev-guide/knox_monitoring_api.md |
| - Advanced Topics: |
| - SSE Support: sse-support.md |
| - WebSocket Support: websocket-support.md |
| - X-Forwarded Headers: x-forwarded-headers.md |
| - GitHub: https://github.com/apache/knox |
| |
| markdown_extensions: |
| - toc: |
| permalink: true |
| - admonition |
| - pymdownx.details |
| - pymdownx.superfences |
| - pymdownx.highlight: |
| anchor_linenums: true |
| - pymdownx.inlinehilite |
| - pymdownx.snippets |
| - pymdownx.tabbed: |
| alternate_style: true |
| - attr_list |
| - md_in_html |
