> For the complete documentation index, see [llms.txt](https://glink.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://glink.gitbook.io/docs/install.md).

# Install

Glink 基于 Flink 1.12.x 版本进行扩展，在使用 Glink 之前需要先安装 Flink 1.12.x，并将 Glink 的相关 Jar 包复制到 Flink 的 classpath 路径下。Flink 的安装这里不再赘述，只讲述如何配置 Glink 所需的依赖。

Glink 目前仅支持从源码编译安装，首先下载Flink源码。

```
git clone https://github.com/traj-explorer/glink.git
```

编译源码。

```
cd glink
mvn clean package -DskipTests
```

编译完成后在 `glink-dist/target` 目录下会生成一个安装包 `glink-0.2-SNAPSHOT-bin.tar.gz`。解压后目录结构如下:

```
glink-x.x.x
    |----jar
    |----examples
    |----README.md
```

其中 Glink 的相关依赖均在 `jar`文件夹下。通过如下命令复制到 `$FLINK_HOME/lib` 目录下。

```
sudo cp jar/*.jar $FLINK_HOME/lib
```

## Glink on Zepplin

Glink SQL 可配合 Apache Zepplin 使用，在使用前需先配置 Flink on Zepplin。在 Zepplin 中使用 Glink SQL 与直接使用 Flink SQL 的方法是相同的，关于具体如何配置和使用请参考 [Flink on Zeppli](https://www.yuque.com/jeffzhangjianfeng/gldg8w)[n](https://www.yuque.com/jeffzhangjianfeng/gldg8w)。这里只讲述如何在 Zepplin 中快速配置 Glink 所需的相关依赖。如果相关 Jar 包依赖已经在上述步骤中完成配置则不需要重复配置。

{% hint style="info" %}
由于 Flink 和 Zepplin 都处于快速迭代中，且 Zepplin 的官方发布版本比较滞后，最新版本的 Zepplin 下载可参考 [Flink on Zepplin FAQ](https://www.yuque.com/jeffzhangjianfeng/gldg8w/yf63y7)。
{% endhint %}

### Glink Connecter

如果需要在 Zepplin 中使用 Glink 扩展的 SQL Connecter，需要将相关的 Jar 包放置在 Flink 的 classpath 路径下，最简单的方法是将所需 Connecter 的 Jar 包下载到 `$FLINK_HOME/lib` 目录下，并重启Flink集群。

| Maven dependency        | Jar file                          |
| ----------------------- | --------------------------------- |
| glink-connecter-geomesa | glink-connector-geomesa-x.x.x.jar |

### Glink SQL

如果需要在 Zepplin 中使用 Glink 提供的 Spatial SQL 函数，需要将如下 Jar 包放置在 Flink 的 classpath 路径下，最简单的方法是将下述 Jar 包下载到 `$FLINK_HOME/lib` 目录下，并重启Flink集群。

| Maven dependency | Jar file            |
| ---------------- | ------------------- |
| glink-sql        | glink-sql-x.x.x.jar |

此外，需要在 Zepplin 的 Flink Interpreter 中添加如下配置。

| Name                    | Value                                |
| ----------------------- | ------------------------------------ |
| flink.udf.jars          | $FLINK\_HOME/lib/glink-sql-x.x.x.jar |
| flink.udf.jars.packages | com.github.tm.glink.sql.udf          |