documentation/mkdocs.yml at main · apisec-inc/documentation · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
site_name: Documentation
site_url: https://apisec-inc.github.io/documentation/
nav:
    - APIsec Overview: index.md
    - Getting Started: GettingStarted.md
    - 1. Register an API:
         - Register API: RegisterAPI.md
         - Add Endpoints - UI: AddingEndpointsManually.md
         - Add Endpoints - CLI: adding-endpoints-via-cli.md
    - 2. Register an API Gateway:
         - API Gateway Overview: RegisterGateway.md
         - Postman Set Up: setup-postman.md
         - Azure API Gateway: Configuring Azure API Management Gateway.md
         - Mulesoft API Gateway: Configuring Mulesoft API Gateway.md
    - 3. Projects Section: ProjectSection.md
    - 4. Project Dashboard: ProjectDashboard.md
    - 5. Configurations:
        - Overview: Configurations Overview.md
        - Integrations:
             - Overview: Integrations.md
             - Github Issue Tracker Set up: SetupGithubTracker.md
             - Jira Issue Tracker Set up: SetupJiraTracker.md
             - JupiterOne IT Integration: jupiter-one-integration.md
             - Linear IT Configuration: linear-it-configuration.md
             - Wrike IT Configuration: wrike-it-configuration.md
             - Synopsis Code DX Integration: synopsis-code-dx.md
             - Playbook Backup and Restore: Configure GitHub for Playbooks Backup.md
             - AWS Fargate Scanner Deployment: fargate-scanner.md
             - AWS Fargate Scanner with EFS: efs-fargate-scanner.md
        - Groups: APIGroups.md
        - Teams: Teams.md
        - SSO:
            - Okta SSO: OktaSSOConfig.md
            - Azure AD SSO:
                - Open ID Connect: AzureSSOConfig.md
                - OAuth2.0 - PKCE with Confidential Client: OAuth2.0CC.md
                - OAuth2.0 - PKCE with Public Client for SPA: OAuth2.0PC.md
            - JumpCloud SSO: JumpCloudSSOConfig.md
    - 6. Reports: Reports.md
    - 7. Deploy Scanners: DeployScanners.md
    - 8. Vault: Vault.md
    - 9. Security Categories:
         - APIsec Categories: SecurityCategories.md
         - Categories Use: SecurityCategoriesUse.md
    - 10. Security Center: SecurityCenter.md
    - 11. Spec Analysis: SpecAnalysis.md
    - 12. Global Dashboard: GlobalDashboard.md
    - 13. View Notifications: Notifications.md
    - 14. Profile:
          - Set up the Profile: SetupProfile.md
          - Two-Factor Auth: 2fa.md
    - 15. Sign up for Free Account: FreeAccount.md

    - Knowledge Base:
      - Generating OpenAPI Specification (OAS): Generating OAS.md
      - How to Add Token Generation Code: Token Generation Code.md
      - Scan APIs locally with APIsec CLI: APIsec CLI.md
      - How to Call APIsec APIs: Call APIsec APIs.md
      - Registering APIs from AWS Gateway via script: AddAPIFromAWSGateway.md
      - Securing APIsec Service Account Credentials in Vault: SecuringCredentialsExternally.md
      - Resolving Service Unavailable Error Upon User Login: UserLoginServiceUnavailable.md
      - On-Premises Sanity Test Guide: On-PremisesSanityTestGuide.md
      - Getting OAS from IBM DataPower: oas-ibm-datapower.md
      - Scanner Sizing Recommendations: scanner-sizing.md
      - Scanner Architecture: KB_ScannerNetwork.md
      - APIsec IP Acceptlist: IP-Acceptlist.md
      - K8s Scanner Deployment: k8s-scanner-deployment.md
      - Docker Swarm Scanner Deployment: docker-scanner-deployment.md
      - Add Self-Signed certificates to APIsec-scanner: add-ca-certificate.md
      - AWS Fargate Scanner Deployment: fargate-scanner.md
      - AWS Fargate Scanner with EFS Volume Deployment: efs-fargate-scanner.md
      - Role permissions: UserPermissions.md
    - Maintenance Window: maintenance-window.md
    - Service Level Agreement: ServiceLevelAgreement.md
#plugins:
 # - search
  #- git-authors


# Google Analytics
analytics:
    gtag: G-MCT52689D6

extra_css:
  - docs/Chatbot/styles.css

extra_javascript:
  - docs/Chatbot/scripts.js
theme:
    name: material

    favicon: favicon.png
    logo: logo.png
    palette:
      scheme: slate
      primary: teal
repo_url: https://github.com/apisec-inc/documentation
repo_name: apisec-in/documentation
edit_uri: ""
extra:
  generator: false
  social:
    - icon: fontawesome/solid/paper-plane
      link: https://www.apisec.ai/
copyright: Copyright &copy; APisec Inc.
static_templates:
    - 404.html