mkdocs.yml

site_name: 'JumpServer 文档'
site_url: 'https://docs.jumpserver.org'
site_author: '飞致云'
site_description: "JumpServer 在线文档"

repo_name: 'jumpserver/jumpserver'
repo_url: 'https://github.com/jumpserver/jumpserver'
edit_uri: ''

theme:
  name: 'material'
  logo: 'img/logo.png'
  favicon: 'img/favicon.ico'
  language: 'zh'
  palette:
    - scheme: default
      accent: 'red'
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - scheme: slate
      accent: 'red'
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  features:
    - navigation.tracking
    - navigation.indexes
    - navigation.top
    - search.suggest
    - search.highlight
    - search.share
    - header.autohide
  font: false
  custom_dir: 'theme'
  icon:
    repo: fontawesome/brands/github

nav:
  - 产品介绍: index.md
  - 版本对比: https://jumpserver.org/features.html 
  - 快速入门: quick_start.md
  - 安装部署:
    - Linux 单机部署:
        - 环境要求: installation/setup_linux_standalone/requirements.md
        - 安装指南: installation/setup_linux_standalone/offline_install.md
        - 升级指南: installation/setup_linux_standalone/offline_upgrade.md
    - Linux 集群模式部署:
        - 准备工作: installation/setup_linux_lb/requirements.md
        - 部署 NFS 服务: installation/setup_linux_lb/nfs_install.md
        - 部署 PostgreSQL 服务: installation/setup_linux_lb/pgsql_install.md
        - 部署 Redis 服务: installation/setup_linux_lb/redis_install.md
        - 部署 JumpServer 01 节点: installation/setup_linux_lb/installation_node01.md
        - 部署 JumpServer 02 节点: installation/setup_linux_lb/installation_node02.md
        - 部署 HAProxy 服务: installation/setup_linux_lb/haproxy_install.md
        - 部署 MinIO 服务: installation/setup_linux_lb/minio_install.md
        - 部署 Elasticsearch 服务: installation/setup_linux_lb/elasticsearch_install.md
        - 注意事项: installation/setup_linux_lb/linux_lb_upgrade.md
    - 1Panel 模式部署:
        - 安装指南: installation/1panel_setup/setup_js.md
        - 运维指南: installation/1panel_setup/config_js.md
    - Kubernetes  Helm 模式部署:
        - 安装指南: installation/setup_kubernetes/helm_online_install.md
        - 升级指南: installation/setup_kubernetes/helm_online_upgrade.md
    - 网络端口说明: installation/network_port.md  
    - 数据备份以及恢复指南: installation/backup_recovery.md
    - 参数说明: manual/env.md
  
  
  - 用户手册:
    - 管理员手册:
      - 个人设置: manual/admin/profile.md
      - 控制台:
        - 用户管理:
          - 用户列表: manual/admin/console/users/users.md
          - 用户组: manual/admin/console/users/user-groups.md
        - 资产管理: 
          - 资产列表: manual/admin/console/assets/assets_list.md
          - 网域列表: manual/admin/console/assets/net_list.md
          - Web资产: manual/admin/console/assets/web_assets.md
        - 账号管理: 
          - 账号列表: manual/admin/console/account_management/account_list.md
          - 账号模板: manual/admin/console/account_management/account_template.md
        - 授权管理:
          - 资产授权: manual/admin/console/authorization_manage/assets_authorization.md
          - 访问控制: manual/admin/console/access_control/acls.md
          - 会话分享: manual/admin/console/authorization_manage/session_sharing.md
        - 标签列表: manual/admin/console/else/tag_list.md
      - PAM:
        - 自动化:
          - 账号发现: manual/admin/pam/automation/account_discovery.md
          - 账号推送: manual/admin/pam/automation/account_push.md
          - 账号备份: manual/admin/pam/automation/account_backup.md
        - 安全设置:
          - 账号改密: manual/admin/pam/security/change_secrets.md
          - 风险检测: manual/admin/pam/security/risk_detection.md
        - 应用管理: manual/admin/pam/applications_manage.md  
      - 审计台:
        - 会话审计:
          - 会话记录: manual/admin/audit/session_audit/session_record.md
          - 会话命令: manual/admin/audit/session_audit/session_command.md
          - 文件传输: manual/admin/audit/session_audit/file_transfer.md
          - 在线用户: manual/admin/audit/session_audit/online_user.md
        - 日志审计:
          - 登录日志: manual/admin/audit/session_audit/log_audit/login_logs.md
          - 改密日志: manual/admin/audit/session_audit/log_audit/password_change_logs.md
          - 操作日志: manual/admin/audit/session_audit/log_audit/operation_logs.md
        - 作业审计:
          - 作业列表: manual/admin/audit/session_audit/job_audit/job_list.md
          - 作业日志: manual/admin/audit/session_audit/job_audit/job_logs.md  
        - 工单审计: manual/admin/audit/session_audit/ticket_audit.md
        - 报表: manual/admin/audit/session_audit/reports.md    
      - 工作台: 
        - 我的资产: 
          - 连接资产: manual/admin/workbench/my_assets/assets_connect.md
          - Web终端: manual/admin/workbench/my_assets/web_terminal.md
          - 文件传输: manual/admin/workbench/my_assets/file_transfer.md
          - 文件管理: manual/admin/workbench/my_assets/file_explorer.md
        - 作业中心: 
          - 快捷命令: manual/admin/workbench/job_center/adhoc.md
          - 作业管理: manual/admin/workbench/job_center/jobs_management.md
          - 模板管理: manual/admin/workbench/job_center/templates_management.md
          - 执行历史: manual/admin/workbench/job_center/execute_history.md
        - 其他: 
          - 系统工具: manual/admin/workbench/other/system_tool.md
      - 系统设置:
        - 概览: manual/admin/system_settings/overview.md      
        - 基本设置: manual/admin/system_settings/basic_settings.md
        - 组织管理: manual/admin/system_settings/organization_manage.md
        - 角色列表: manual/admin/system_settings/role_list.md
        - 平台列表: manual/admin/system_settings/platforms.md
        - 通知设置: manual/admin/system_settings/notification_settings.md        
        - 功能设置: manual/admin/system_settings/feature_settings.md
        - 认证设置:
          - 基本设置: manual/admin/system_settings/authentication_settings/basic_settings.md
          - LDAP: manual/admin/system_settings/authentication_settings/LDAP.md
          - Passkey: manual/admin/system_settings/authentication_settings/Passkey.md
          - CAS: manual/admin/system_settings/authentication_settings/CAS.md
          - LDAP HA (X-Pack): manual/admin/system_settings/authentication_settings/LDAPHA.md
          - OIDC (X-Pack): manual/admin/system_settings/authentication_settings/OIDC.md
          - OAuth2 (X-Pack): manual/admin/system_settings/authentication_settings/OAuth2.md
          - SAML2 (X-Pack): manual/admin/system_settings/authentication_settings/SAML2.md
          - 企业微信 (X-Pack): manual/admin/system_settings/authentication_settings/WeCom.md
          - 钉钉 (X-Pack): manual/admin/system_settings/authentication_settings/DingTalk.md
          - 飞书 (X-Pack): manual/admin/system_settings/authentication_settings/Feishu.md
          - Lark (X-Pack): manual/admin/system_settings/authentication_settings/Lark.md
          - Slack (X-Pack): manual/admin/system_settings/authentication_settings/Slack.md
          - Radius (X-Pack): manual/admin/system_settings/authentication_settings/Radius.md
        - 存储设置: manual/admin/system_settings/storage.md
        - 组件设置: manual/admin/system_settings/components.md
        - 远程应用: manual/admin/system_settings/remote_apps.md
        - 虚拟应用: manual/admin/system_settings/virtual_apps.md
        - 安全设置: manual/admin/system_settings/security.md
        - 界面设置: manual/admin/system_settings/appearance.md
        - 系统工具: manual/admin/system_settings/tools.md
        - 系统任务: manual/admin/system_settings/system_tasks.md
        - 许可证: manual/admin/system_settings/licenses.md
      - 其他设置:
        - 人脸识别 (X-Pack): manual/admin/others/MFA_Facelive.md
    - 审计员手册:
      - 审计台:
        - 会话审计:
            - 会话记录: manual/admin/audit/session_audit/session_record.md
            - 会话命令: manual/admin/audit/session_audit/session_command.md
            - 文件传输: manual/admin/audit/session_audit/file_transfer.md
            - 在线用户: manual/admin/audit/session_audit/online_user.md
        - 日志审计:
            - 登录日志: manual/admin/audit/session_audit/log_audit/login_logs.md
            - 改密日志: manual/admin/audit/session_audit/log_audit/password_change_logs.md
            - 操作日志: manual/admin/audit/session_audit/log_audit/operation_logs.md
        - 作业审计:
            - 作业列表: manual/admin/audit/session_audit/job_audit/job_list.md
            - 作业日志: manual/admin/audit/session_audit/job_audit/job_logs.md  
        - 工单审计: manual/admin/audit/session_audit/ticket_audit.md
      - 报表: manual/admin/audit/session_audit/reports.md

    - 普通用户手册:
      - 个人设置: manual/user/profile.md
      - 工作台: 
        - 我的资产: 
          - 连接资产: manual/admin/workbench/my_assets/assets_connect.md
          - Web终端: manual/admin/workbench/my_assets/web_terminal.md
          - 文件传输: manual/admin/workbench/my_assets/file_transfer.md
          - 文件管理: manual/admin/workbench/my_assets/file_explorer.md
      - 工单: manual/user/ticket.md
      - 客户端使用:
        - 客户端下载与安装: manual/client/client_installation.md
        - 资产连接: manual/client/asset_connection.md
        - 连接设置: manual/client/connection_settings.md



  - 常见问题:
    - 产品 FAQ: faq/faq.md
    - 安全建议: faq/security.md
    - 企业版: https://www.jumpserver.org/enterprise.html
  - 开发文档:
    - API 文档: dev/rest_api.md
    - 交互命令: dev/shell.md
  - 用户案例: user_stories.md
  - 更新日志: change_log.md
  - 联系我们: contact.md

markdown_extensions:
  - admonition
  - abbr
  - attr_list
  - def_list
  - footnotes
  - meta
  - toc:
      permalink: ⚓︎
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
      options:
        custom_icons:
          - theme/.icons
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.saneheaders
  - pymdownx.magiclink:
      repo_url_shortener: true
      repo_url_shorthand: true
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

extra:
  jumpserver:
    tag: v4.10.16
    client_tag: 4.1.2
  search:
    separator: '[\s\-\.]+'
    language: 'zh'
    Content-Encoding: gzip
    boost: 100
  generator: false
  version:
    default: master
    provider: mike
  analytics:
    provider: google
    property: UA-147297392-3
  social:
    - icon: Bilibili_Logo_Blue
      link: https://space.bilibili.com/510493147?spm_id_from=333.337.0.0
    - icon: fontawesome/brands/github
      link: https://github.com/jumpserver
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/jumpserver/
    - icon: fontawesome/solid/envelope
      link: mailto:support@fit2cloud.com
    - icon: fontawesome/brands/skype
      link: tel://400-052-0755

extra_css:
  - css/extra.css
  - css/termynal.css
  - css/custom.css
  - stylesheets/extra.css

extra_javascript:
  - js/termynal.js
  - js/custom.js

copyright: Copyright &copy; 2014-2025 <a href="https://www.fit2cloud.com">杭州飞致云信息科技有限公司</a>, All Rights Reserved. <a href="http://www.beian.miit.gov.cn" target="_blank">京ICP备15023818号</a>
plugins:
    - search:
        lang:
          - en
          - zh
        separator: '[\s\-\.]+'
    - macros
    - i18n:
        docs_structure: suffix
        fallback_to_default: true
        reconfigure_material: true
        languages:
          - locale: zh
            name: 中文
            build: true
            default: true
          - locale: en
            name: English
            build: true
            site_name: JumpServer Documentation
            nav_translations:
              参数说明: Configuration Parameters 
              产品介绍: Product Introduction
              快速入门: Quick Start
              安装部署: Installation
              Linux 单机部署: Linux Standalone
              环境要求: Requirements
              安装指南: Installation Guide
              升级指南: Upgrade Guide
              Linux 集群模式部署: Linux Cluster
              准备工作: Preparation
              部署 NFS 服务: Deploy NFS
              部署 PostgreSQL 服务: Deploy PostgreSQL
              部署 Redis 服务: Deploy Redis
              部署 JumpServer 01 节点: Deploy Node 01
              部署 JumpServer 02 节点: Deploy Node 02
              部署 HAProxy 服务: Deploy HAProxy
              部署 MinIO 服务: Deploy MinIO
              部署 Elasticsearch 服务: Deploy Elasticsearch
              注意事项: Upgrade Notes
              1Panel 模式部署: 1Panel Setup
              运维指南: Operation Guide
              Kubernetes  Helm 模式部署: K8s Helm Setup
              网络端口说明: Network Ports
              数据备份以及恢复指南: Backup & Recovery
              用户手册: User Manual
              管理员手册: Admin Manual
              控制台: Console
              用户管理: User Management
              用户列表: User List
              用户组: User Groups
              资产管理: Asset Management
              资产列表: Asset List
              网域列表: Gateway List
              Web资产: Web Assets
              账号管理: Account Management
              账号列表: Account List
              账号模板: Account Templates
              授权管理: Authorization
              资产授权: Asset Grants
              访问控制: Access Control
              会话分享: Session Sharing
              标签列表: Tags
              PAM: PAM
              自动化: Automation
              账号发现: Account Discovery
              账号推送: Account Push
              账号备份: Account Backup
              安全设置: Security
              账号改密: Change Password
              风险检测: Risk Detection
              应用管理: App Management
              审计台: Audit Console
              会话审计: Session Audit
              会话记录: Session Records
              会话命令: Session Commands
              文件传输: File Transfers
              在线用户: Online Users
              日志审计: Log Audit
              登录日志: Login Logs
              改密日志: Password Change Logs
              操作日志: Operation Logs
              作业审计: Job Audit
              作业列表: Job List
              作业日志: Job Logs
              工单审计: Ticket Audit
              报表: Reports
              工作台: Workbench
              我的资产: My Assets
              连接资产: Connect Assets
              Web终端: Web Terminal
              文件管理: File Manager
              作业中心: Job Center
              快捷命令: Adhoc Commands
              作业管理: Job Management
              模板管理: Templates
              执行历史: History
              其他: Others
              系统工具: System Tools
              系统设置: System Settings
              概览: Overview
              基本设置: Basic Settings
              组织管理: Organization Management
              角色列表: Role List
              平台列表: Platform List
              通知设置: Notifications
              功能设置: Feature Settings
              认证设置: Authentication
              认证: Authentication
              存储设置: Storage
              组件设置: Components
              远程应用: Remote Apps
              虚拟应用: Virtual Apps
              界面设置: Appearance
              系统任务: System Tasks
              许可证: License
              其他设置: Other Settings
              人脸识别 (X-Pack): MFA Face ID (X-Pack)
              审计员手册: Auditor Manual
              普通用户手册: User Manual
              个人设置: Profile
              工单: Tickets
              客户端使用: Client Usage
              客户端下载与安装: Download & Install
              资产连接: Asset Connection
              连接设置: Preferences
              常见问题: FAQ
              产品 FAQ: Product FAQ
              安全建议: Security Advice
              企业版: Enterprise Edition
              开发文档: Development
              API 文档: API Docs
              交互命令: Shell Commands
              用户案例: User Stories
              更新日志: Change Log
              联系我们: Contact Us
              企业微信 (X-Pack): WeCom (X-Pack)
              钉钉 (X-Pack): DingTalk (X-Pack)
              飞书 (X-Pack): Feishu (X-Pack)