介绍
指南
API 文档
常见问题
介绍
指南
API 文档
常见问题

配置说明

本文档详细介绍了 XinAdmin 项目的前后端配置项，帮助您根据实际需求进行定制化配置。

后端配置

后端基于 Laravel 框架，配置文件位于 config/ 目录下。所有敏感配置信息应通过 .env 文件进行设置。

应用配置

应用配置位于 config/app.php，主要包含以下内容：

  • 应用名称: APP_NAME - 应用的显示名称
  • 应用环境: APP_ENV - 设置为 local、staging 或 production
  • 调试模式: APP_DEBUG - 开发环境设为 true，生产环境必须为 false
  • 应用时区: APP_TIMEZONE - 默认为 'UTC'，建议设置为 'Asia/Shanghai'
  • 本地化配置: APP_LOCALE - 设置默认语言，支持 'zh' 和 'en'
  • 加密密钥: APP_KEY - 通过 php artisan key:generate 命令生成

示例配置：

APP_NAME=XinAdmin
APP_ENV=production
APP_DEBUG=false
APP_TIMEZONE=Asia/Shanghai
APP_LOCALE=zh
APP_KEY=base64:your-generated-key-here
WARNING

在生产环境中，建议将 APP_DEBUG 设置为 false，并使用适当的日志级别以保护敏感信息。

数据库配置

数据库配置位于 config/database.php，支持多种数据库系统：

  • 默认连接: DB_CONNECTION - 可选 mysql、mariadb、pgsql、sqlite 等
  • 主机地址: DB_HOST - 数据库服务器地址
  • 端口: DB_PORT - 数据库端口，默认 MySQL 为 3306
  • 数据库名: DB_DATABASE - 使用的数据库名称
  • 用户名: DB_USERNAME - 数据库用户名
  • 密码: DB_PASSWORD - 数据库密码
  • 字符集: DB_CHARSET - 推荐使用 'utf8mb4'
  • 排序规则: DB_COLLATION - 推荐使用 'utf8mb4_unicode_ci'

示例配置：

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=xinadmin
DB_USERNAME=root
DB_PASSWORD=your_password
DB_CHARSET=utf8mb4
DB_COLLATION=utf8mb4_unicode_ci

缓存配置

缓存配置位于 config/cache.php，支持多种缓存驱动：

  • 默认驱动: CACHE_DRIVER - 可选 redis、file、database、array 等
  • Redis 配置:
    • REDIS_CLIENT - 默认为 'phpredis'
    • REDIS_HOST - Redis 服务器地址
    • REDIS_PASSWORD - Redis 密码
    • REDIS_PORT - Redis 端口，默认 6379
    • REDIS_DB - Redis 数据库编号
    • REDIS_CACHE_DB - 专用缓存数据库编号

示例配置：

CACHE_DRIVER=redis
REDIS_CLIENT=phpredis
REDIS_HOST=127.0.0.1
REDIS_PASSWORD=null
REDIS_PORT=6379
REDIS_DB=0
REDIS_CACHE_DB=1
TIP

在生产环境中，推荐使用 Redis 作为缓存驱动以获得更好的性能。

前端配置

前端基于 React + Vite，配置文件位于项目根目录。

环境变量

前端使用 .env 文件管理环境变量，主要配置项包括：

  • 基础 URL: VITE_BASE_URL - 后端 API 的基础地址
  • 应用标题: VITE_APP_TITLE - 应用的标题
  • API 超时: VITE_API_TIMEOUT - API 请求超时时间
  • 分页大小: VITE_DEFAULT_PAGE_SIZE - 默认分页大小

示例配置：

VITE_BASE_URL=http://127.0.0.1:8000
VITE_APP_TITLE=XinAdmin
VITE_API_TIMEOUT=30000
VITE_DEFAULT_PAGE_SIZE=10

主题配置

主题配置基于 Ant Design，支持多种主题定制：

  • 主题模式: 支持亮色和暗色主题
  • 主色调: 可自定义品牌色
  • 组件尺寸: 支持紧凑和正常尺寸
  • 布局模式: 支持侧边栏、混合、多栏等多种布局
  • 导航模式: 支持顶部导航和侧边导航

主题配置通过 Zustand 状态管理，在 src/stores/global/slices/theme.ts 中管理，可在用户个人设置中动态切换。

ON THIS PAGE