安装指南

本指南将帮助您快速安装和部署短链接平台。

系统要求

• PHP 7.4 或更高版本
• MySQL 5.7 或更高版本
• Apache 或 Nginx
• Composer
• 支持的PHP扩展：mbstring, openssl, pdo_mysql, curl, json

安装步骤

1. 下载源码

   从官网下载最新版本的源码包，并解压到服务器根目录。

2. 安装依赖

   composer install

3. 运行安装脚本

   访问 http://your-domain.com/install 开始安装过程。

4. 填写数据库信息

   按照安装向导填写数据库连接信息：

   • 数据库主机
   • 数据库名称
   • 数据库用户名
   • 数据库密码
5. 创建管理员账户

   设置管理员用户名和密码。

6. 完成安装

   点击"完成安装"按钮，系统会自动创建数据库表结构并初始化数据。

7. 登录管理后台

   访问 http://your-domain.com/admin 登录管理后台。

API文档

短链接平台提供完整的RESTful API，支持第三方应用集成。

API基础

• API基础URL：http://your-domain.com/api
• 请求方法：GET, POST
• 认证方式：API密钥

API端点

1. 创建短链接

端点： /api/create.php

方法： POST

参数：

• url：原始URL（必填）
• custom：自定义短码（可选）
• api_key：API密钥（必填）

响应：

{
    "success": true,
    "short_url": "http://your-domain.com/abc123",
    "short_code": "abc123"
}

2. 获取链接信息

端点： /api/info.php

方法： GET

参数：

• code：短链接代码（必填）
• api_key：API密钥（必填）

3. 列出用户链接

端点： /api/list.php

方法： GET

参数：

• api_key：API密钥（必填）
• page：页码（可选，默认1）
• limit：每页数量（可选，默认10）

模板开发

短链接平台支持自定义模板，您可以根据需要创建自己的模板。

模板结构

templates/
└── your-template/
    ├── template.xml          # 模板配置文件
    ├── header.php            # 头部文件
    ├── footer.php            # 底部文件
    ├── css/                  # CSS文件夹
    │   └── style.css         # 样式文件
    └── pages/                # 页面文件夹
        ├── index.php         # 首页
        ├── about.php         # 关于页面
        └── ...               # 其他页面

模板配置文件 (template.xml)

<?xml version="1.0" encoding="UTF-8"?>
<template>
    <name>模板名称</name>
    <description>模板描述</description>
    <version>1.0.0</version>
    <author>作者名称</author>
    <preview>preview.png</preview>
</template>

模板文件开发

• header.php：包含HTML头部、导航栏等
• footer.php：包含页脚信息、版权声明等
• pages/：存放各个页面的内容

数据库结构

短链接平台使用MySQL数据库，主要包含以下表结构：

主要表结构

• shortlinks：存储短链接信息
  • id：自增主键
  • original_url：原始URL
  • short_code：短链接代码
  • user_id：用户ID
  • created_at：创建时间
  • clicks：点击次数
• users：存储用户信息
  • id：自增主键
  • username：用户名
  • email：邮箱
  • password：密码（加密存储）
  • role：用户角色
  • created_at：创建时间
• api_keys：存储API密钥
  • id：自增主键
  • user_id：用户ID
  • api_key：API密钥
  • created_at：创建时间
  • expires_at：过期时间
• clicks：存储点击记录
  • id：自增主键
  • shortlink_id：短链接ID
  • ip：访问IP
  • user_agent：用户代理
  • referer：来源地址
  • created_at：点击时间

PHPMailer配置

短链接平台使用PHPMailer发送邮件，您需要正确配置邮件设置。

安装PHPMailer

composer require phpmailer/phpmailer

配置邮件设置

在管理后台的"系统设置"中配置邮件参数：

• SMTP服务器：您的邮件服务器地址
• SMTP端口：通常为25、465（SSL）或587（TLS）
• SMTP用户名：您的邮箱地址
• SMTP密码：您的邮箱密码或应用专用密码
• 发件人邮箱：显示的发件人邮箱地址
• 发件人名称：显示的发件人名称

故障排除

常见问题及解决方案：

安装问题

• 数据库连接失败

  检查数据库服务器地址、用户名、密码是否正确，确保数据库服务正在运行。

• 权限不足

  确保web服务器用户对项目目录有写权限，特别是对includes/和public/templates/目录。

运行问题

• 短链接无法访问

  检查服务器重写规则是否正确配置，确保.htaccess文件（Apache）或Nginx配置文件中的重写规则正确。

• 邮件发送失败

  检查SMTP设置是否正确，确保服务器允许发送邮件，检查防火墙设置。