# 短链接生成器

**Repository Path**: cyj0/short

## Basic Information

- **Project Name**: 短链接生成器
- **Description**: 支持自定义短码
- **Primary Language**: PHP
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://so.iarc.top
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-06-17
- **Last Updated**: 2024-02-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 短链接生成

在线演示: [so.iarc.top](http://so.iarc.top)

又一个基于 PHP 简单实现的短链接在线生成工具，简单配置，快速搭建。

![截图](https://cdn.jsdelivr.net/gh/QingDi2/iarcfile/uploads/2023/06/17/1686989483.png)

## 配置

### 安装
#### 1. 下载源码，部署至服务器，环境 `PHP >= 5.6`，需安装 `PDO` 扩展。
#### 2. 配置 Nginx，参考如下：
```conf
server {
    listen  80;
    server_name  so.iarc.top;
    root   /www/so.iarc.top;
    index  index.php index.html index.htm;
    
    

    # 伪静态 必须
    location / {
        try_files $uri $uri/ /index.php?$query_string;
    }

    # sqlite 数据库文件禁止访问 必须
    location ~ /(data\.db) {
        deny all;
    }

    location ~ \.php$ {
        fastcgi_pass   unix:/dev/shm/php-cgi.sock;
        include        fastcgi-php.conf;
        include        fastcgi_params;
    }
}
```
#### 3. 配置数据库，支持 MySQL 和 SQLite。

##### 3.1 MySQL 配置

###### 3.1.1 编辑 index.php

```
<?php
// 数据库连接字符串 host 主机名; dbname 数据库名; charset 字符集编码
define('DB_DSN', 'mysql:host=localhost;dbname=short;charset=utf8mb4');

// 数据库用户名
define('DB_USER', 'root');

// 数据库密码
define('DB_PASSWD', '123456');
```

###### 3.1.2 导入数据库表结构
使用工具（Navicat、PHPMyAdmin等）连接 MySQL 服务，创建数据库 `short`，并导入 `mysql.db.sql`

##### 3.2 SQLite 配置：

###### 3.2.1 编辑 index.php

```
<?php
// 数据库连接字符串 host 主机名; dbname 数据库名; charset 字符集编码
define('DB_DSN', 'sqlite:data.db');

// 数据库用户名
define('DB_USER', null);

// 数据库密码
define('DB_PASSWD', null);
```

###### 3.2.2 创建数据库文件
复制 `sqlite.db.exp` 为 `data.db`

### 4. 配置短链接字符长度

```php
// 生成短链接随机字符长度 默认 6 位 不超过 32 位
define('CODE_LENGTH', 6);
```

## API

### 生成短链接
你可以通过域名访问页面或使用接口生成 URL，地址为 `/`，请求方式为 `POST`，参数为 `url` 即你的长链接；`code` 为自定义短链接（可选）。

```bash
# 自动生成短链接
$ curl -X POST -d 'url=http://gitee.com' http://so.iarc.top
{
  "code": 0,
  "msg": "OK",
  "data": {
    "short": "so.iarc.top/R6gF99",
    "generic": "http://so.iarc.top/R6gF99",
    "long": "https://so.iarc.top/R6gF99"
  }
}

# 自定义短链接
$curl -X POST -d 'url=http://gitee.com&code=gitee' http://so.iarc.top
{
  "code": 0,
  "msg": "OK",
  "data": {
    "short": "so.iarc.top/gitee",
    "generic": "http://so.iarc.top/gitee",
    "long": "https://so.iarc.top/gitee"
  }
}
```

| 字段 | 协议 | 兼容性 | 字符长度 |
| ---- | ---- | ---- | ---- | 
| short | 自动识别 | 较差 | 最短 |
| generic  | http | 较好 | 较短 |
| long  | https | 好 | 较长 |

## TODO List
- 后台管理
- 域名黑名单
- 密码访问