史上最全的 Keycloak 部署与启动教程

Keycloak 是一个开源的身份和访问管理解决方案，可以实现单点登录(SSO)、社交登录、用户管理和权限控制等功能。本文将详细介绍如何在本地环境中部署和启动 Keycloak，包括必要的步骤和代码示例，以帮助您快速上手。

一、环境准备

在开始之前，您需要确保计算机上安装了以下软件：

1. Java 8 或更高版本：Keycloak 是基于 Java 的，您需要安装 Java 开发工具包(JDK)。
2. Docker（可选）：如果您希望通过 Docker 部署 Keycloak，可以忽略 JDK 的安装。
3. Maven：如果准备从源代码构建 Keycloak，则需要安装 Maven。

二、使用 Docker 部署 Keycloak

使用 Docker 是部署 Keycloak 的最简单方法。下面是通过 Docker 启动 Keycloak 的步骤：

1. 拉取 Keycloak 镜像

打开终端，执行以下命令来拉取最新的 Keycloak 镜像：

docker pull jboss/keycloak

2. 启动 Keycloak 容器

使用下面的命令启动一个 Keycloak 实例：

docker run -d -p 8080:8080 --name keycloak \
-e KEYCLOAK_USER=admin \
-e KEYCLOAK_PASSWORD=admin \
jboss/keycloak

在上面的命令中： - -d 表示后台运行容器。 - -p 8080:8080 将容器的 8080 端口映射到主机的 8080 端口。 - KEYCLOAK_USER 和 KEYCLOAK_PASSWORD 用于设置初始管理用户的用户名和密码。

3. 访问 Keycloak 控制台

在浏览器中打开 http://localhost:8080，您将看到 Keycloak 登录页面。使用上面设置的用户名和密码（admin/admin）登录。

三、手动从源代码部署 Keycloak

如果您希望手动构建并部署 Keycloak，可以遵循以下步骤：

1. 下载源代码

您可以从 Keycloak 的 GitHub 仓库 下载源代码或使用 Git 克隆：

git clone https://github.com/keycloak/keycloak.git
cd keycloak

2. 构建 Keycloak

使用 Maven 构建 Keycloak：

mvn clean install -DskipTests

3. 启动 Keycloak

在构建完成后，您可以在 distribution/server-dist/target 目录找到 Keycloak 的分发包。切换到该目录，执行以下命令启动 Keycloak：

cd distribution/server-dist/target/keycloak-<version>/bin
./standalone.sh

4. 访问 Keycloak

同样，您可以在浏览器中访问 http://localhost:8080 以登录管理控制台。

四、配置 Keycloak

登录后，您可以通过以下步骤配置 Keycloak：

1. 创建一个新域（Realm），点击左侧导航栏的 "Add Realm"。
2. 配置用户，点击 "Users" -> "Add User"。
3. 配置客户端，点击 "Clients" -> "Create"。

您可以根据具体需求对 Keycloak 进行更多的定制和调整。

结论

通过本文，您应该能够成功部署并启动 Keycloak，不论是通过 Docker 还是从源代码构建。Keycloak 是一个功能强大且灵活的身份管理解决方案，适合各种规模的应用程序。希望这份教程能对您有所帮助！