boxboat/okta-nginx

boxboat

自动构建

集成Okta OIDC JWT验证的NGINX Docker镜像，用于通过Okta身份认证及JWT令牌验证保护Web应用或API访问。

4 次收藏下载次数: 0状态：自动构建维护者：boxboat仓库类型：镜像最近更新：1 年前

让 AI 帮你使用轩辕镜像？ · 展开查看说明 · 点击收起说明

如果你使用 DeepSeek、元宝 AI、Copilot、ChatGPT 等 AI 工具，协助配置轩辕镜像、编写 docker pull 命令、修改 Docker Compose 镜像地址、配置镜像加速、排查镜像拉取失败、分析报错日志等问题，请先让 AI 阅读并遵守轩辕镜像的规则文档。

只需在 AI 对话中先发送下面这句话即可：

请先完整阅读并严格遵守以下文档中的全部规则与要求：

https://xuanyuan.cloud/agents.md

在未充分阅读并理解该文档前，不要生成任何命令、配置、修改建议、故障排查方案或技术回答。后续所有输出都必须严格以该文档中的规范为最高优先级执行。

查看 agents.md 用法指南与完整示范。国内用户首推元宝 AI、DeepSeek 的深度思考模式，不推荐豆包 AI；Cursor 等编辑器可在对话 @ 该链接，或加入 User Rules。若 AI 无法访问外链，可打开说明文档复制全文粘贴。文档会随站点更新，复制内容可能过期，建议定期检查。

镜像标签列表与下载命令

okta-nginx

镜像概述和主要用途

okta-nginx 是一个 Docker 镜像，通过 Okta OpenID Connect 授权码流程（Authorization Code flow）保护上游服务器（upstream server）。该镜像基于 NGINX，集成 Okta OIDC 认证机制，实现对上游应用的身份验证与授权控制，确保只有通过 Okta 认证的用户才能访问受保护资源。

核心功能和特性

Okta OIDC 认证集成：基于 Okta 授权码流程实现用户认证，支持 JWT（JSON Web Token）验证
反向代理能力：将认证通过的请求代理至指定上游服务器
灵活的访问控制：可配置受保护路径（LOCATIONS_PROTECTED）与无需保护路径（LOCATIONS_UNPROTECTED）
动态配置更新：支持通过脚本（UPDATE_SCRIPT）定期刷新配置
自定义请求头传递：可向上游服务器传递基于 JWT 断言（claims）的自定义请求头
多服务器支持：通过环境变量后缀（如 _2、_N）配置多个独立的 NGINX 虚拟主机
令牌自动刷新：默认注入 JavaScript 实现 Identity Token 过期前自动刷新（可通过 INJECT_REFRESH_JS 禁用）

使用场景和适用范围

需要通过 Okta 进行身份验证的 Web 应用或 API 服务
需对特定路径实施访问控制的上游服务（如管理后台、敏感数据接口）
多域名或多端口场景下的统一认证入口
需要向上游传递用户身份信息（如用户名、用户组）的场景

前提条件

Okta 开发者账户
支持 授权码流程 的 OpenID Connect 应用（在 Okta 开发者控制台创建）

使用方法和配置说明

环境变量

必填环境变量

变量名	描述
`PROXY_PASS`	上游服务器地址，需包含协议、主机和端口，例如 `http://localhost:8080`
`CLIENT_ID`	Okta OIDC 应用的客户端 ID，可在 Okta 应用「General」标签页获取
`CLIENT_SECRET`	Okta OIDC 应用的客户端密钥，可在 Okta 应用「General」标签页获取
`ISSUER`	Okta 授权服务器 URL，格式为 `{Okta 组织 URL}/oauth2/default`，例如 `https://xxxxx.oktapreview.com/oauth2/default`（组织 URL 可在 Okta 控制台首页右上角获取）
`LOGIN_REDIRECT_URL`	登录回调 URL，必须在 Okta 应用「General」标签页的「登录重定向 URI」中配置。默认路径为 `/sso/authorization-code/callback`，若设置 `SSO_PATH` 则为 `${SSO_PATH}/authorization-code/callback`

可选环境变量

变量名	默认值	描述
`APP_POST_LOGIN_URL`	-	认证完成后重定向的应用特定 URL，原始请求 URL 通过 `state` 查询参数传递
`COOKIE_DOMAIN`	当前域名	Cookie 作用域，设置后可支持子域名共享（例如 `.example.com`）
`COOKIE_NAME`	`okta-jwt`	存储 Identity Token 的 Cookie 名称
`INJECT_REFRESH_JS`	`true`	是否注入自动刷新 Token 的 JavaScript，设为 `false` 禁用
`ENDPOINT_AUTHORIZE`	`${ISSUER}/v1/authorize`	授权端点 URL
`ENDPOINT_LOGOUT`	`${ISSUER}/v1/logout`	登出端点 URL
`ENDPOINT_TOKEN`	`${ISSUER}/v1/token`	Token 获取端点 URL
`LISTEN`	`80`	NGINX 监听端口，支持 TLS 或 Unix 套接字（参考 http://nginx.org/en/docs/http/ngx_http_core_module.html#listen%EF%BC%89
`LOCATIONS_PROTECTED`	`/`	需保护的路径列表（逗号分隔），例如 `/api,/admin`
`LOCATIONS_UNPROTECTED`	禁用	无需保护的路径列表（逗号分隔），直接代理至上游服务器
`LOGOUT_REDIRECT_URL`	应用源 URL（origin）	登出后重定向 URL（可相对或绝对路径），登出路径为 `/sso/logout` 或 `${SSO_PATH}/logout`
`PROXY_SET_HEADER_NAMES`	无	需传递给上游的请求头名称列表（逗号分隔），需与 `PROXY_SET_HEADER_VALUES` 配合使用
`PROXY_SET_HEADER_VALUES`	无	与 `PROXY_SET_HEADER_NAMES` 对应的头值列表（逗号分隔），支持基于断言的 Go 模板（例如 `{{.groups}}`，可使用 http://masterminds.github.io/sprig/ 函数）
`REQUEST_TIMEOUT`	`30`	调用 Okta 端点的超时时间（秒）
`SERVER_NAME`	`_`	NGINX 虚拟主机名称（参考 http://nginx.org/en/docs/http/ngx_http_core_module.html#server_name%EF%BC%89
`SSO_PATH`	`/sso/`	SSO 错误和刷新端点的路径，需包含首尾斜杠（例如 `/okta-sso/`）
`UPDATE_SCRIPT`	无	配置更新脚本路径（可执行 shell 脚本），首次更新传递参数 `true`，后续传递 `false`
`UPDATE_PERIOD_SECONDS`	`60`	若设置 `UPDATE_SCRIPT`，脚本的执行周期（秒，启动时执行一次，之后按周期执行）
`VALIDATE_CLAIMS_TEMPLATE`	禁用	断言验证模板（Go 模板），需返回 `true` 或 `1`，例如 `{{if has "admin" .groups}}true{{else}}false{{end}}`（支持 sprig 函数）

使用方法和配置说明（续）

部署示例

Docker Run 命令

bash
docker run -d \
  -p 80:80 \
  -e PROXY_PASS="http://upstream-app:8080" \
  -e CLIENT_ID="your-okta-client-id" \
  -e CLIENT_SECRET="your-okta-client-secret" \
  -e ISSUER="https://your-okta-domain.com/oauth2/default" \
  -e LOGIN_REDIRECT_URL="https://your-app-domain.com/sso/authorization-code/callback" \
  -e LOCATIONS_PROTECTED="/api,/admin" \
  -e LOCATIONS_UNPROTECTED="/public" \
  docker.xuanyuan.run/okta-nginx:latest

Docker Compose 配置

yaml
version: '3'
services:
  okta-nginx:
    image: docker.xuanyuan.run/okta-nginx:latest
    ports:
      - "80:80"
    environment:
      - PROXY_PASS=http://upstream-app:8080
      - CLIENT_ID=your-okta-client-id
      - CLIENT_SECRET=your-okta-client-secret
      - ISSUER=https://your-okta-domain.com/oauth2/default
      - LOGIN_REDIRECT_URL=https://your-app-domain.com/sso/authorization-code/callback
      - LOCATIONS_PROTECTED=/api,/admin
      - LOCATIONS_UNPROTECTED=/public
      - LISTEN=80
      - SERVER_NAME=your-app-domain.com
    depends_on:
      - upstream-app

  upstream-app:
    image: docker.xuanyuan.run/your-upstream-app:latest
    # 上游应用配置...

从源码构建（可选）

若需从源码构建镜像，执行以下步骤：

构建容器：

bash
./docker-build.sh

在 vars.env 中设置环境变量（参考上文环境变量说明）
运行容器：
```
bash
./docker-run.sh
```

传递给上游服务器的认证头

认证通过后，镜像会向上游服务器传递以下标准头：

X-Forwarded-User：用户唯一标识，取自 JWT 断言中的 sub 字段

自定义 NGINX 配置

添加配置至 `http` 块

将自定义配置文件（.conf 后缀）挂载至 /etc/nginx/conf.d 目录，文件内容会被包含到 NGINX 的 http 块中。

添加配置至 `server` 块

创建文件 /etc/nginx/includes/default-server.conf，其内容会被包含到默认 server 块中，用于自定义服务器级配置（如 SSL 证书、额外的 location 块等）。

多服务器支持

通过为环境变量添加数字后缀（从 2 开始），可配置多个独立的 NGINX 虚拟主机（server）。

服务器 2 配置示例（必填变量）

LISTEN_2：服务器 2 的监听端口（必填）
SERVER_NAME_2：服务器 2 的虚拟主机名称（必填）
PROXY_PASS_2：服务器 2 的上游地址（必填）
LOGIN_REDIRECT_URL_2：服务器 2 的登录回调 URL（必填）

服务器 2 配置示例（可选变量）

APP_POST_LOGIN_URL_2
COOKIE_DOMAIN_2
COOKIE_NAME_2
LOCATIONS_PROTECTED_2
LOCATIONS_UNPROTECTED_2
LOGOUT_REDIRECT_URL_2
PROXY_SET_HEADER_NAMES_2
PROXY_SET_HEADER_VALUES_2
VALIDATE_CLAIMS_TEMPLATE_2

服务器 N 通用规则

对于第 N 个服务器（N ≥ 2）：

所有与服务器相关的环境变量需添加 _N 后缀（如 LISTEN_N、SERVER_NAME_N）
自定义服务器 N 的 server 块配置需挂载至 /etc/nginx/includes/default-server.N.conf

镜像拉取方式

您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本，请访问标签列表页面。

轩辕镜像加速拉取命令点我查看更多 okta-nginx 镜像标签

docker pull docker.xuanyuan.run/boxboat/okta-nginx:<标签>

使用方法：

DockerHub 原生拉取命令

docker pull boxboat/okta-nginx:<标签>

轩辕镜像配置手册

按平台快速找到配置文档

一键安装

一键安装 Docker

Linux Docker 一键安装

AI

用 AI 使用轩辕镜像

agents.md · AI 对话 · 提示词

Docker

登录仓库拉取

登录认证 · 私有仓库

专属域名拉取

免登录 · 高速拉取

Linux

Docker 镜像配置

Windows / Mac

Docker Desktop 配置

MacOS OrbStack

OrbStack 容器

Apple Container

macOS 原生容器

Docker Compose

Compose 项目配置

NAS

群晖

Synology 配置

飞牛

fnOS 镜像配置

绿联

绿联 NAS

威联通

QNAP 配置

极空间

极空间 NAS

Unraid

Unraid NAS

企业仓库

其他仓库

ghcr · Quay · nvcr

Harbor 镜像源

Proxy Repository 对接

Portainer 镜像源

Registries 配置

Nexus 镜像源

Docker Proxy 缓存

开发工具

Dev Containers

VS Code 开发容器

Podman

Podman 配置指南

Singularity / Apptainer

HPC 科学计算容器

Kubernetes

K8s Containerd

Kubernetes · Containerd

K3s

轻量级集群

面板 / 网络

爱快路由

iKuai 镜像加速

宝塔面板

一键配置镜像源

需要其他帮助？请查看我们的常见问题Docker 镜像访问常见问题解答或提交工单

镜像拉取常见问题

功能

版本功能对比

功能对比 · 版本选择

支持的镜像仓库

Docker Hub · GCR · GHCR

新手拉取配置

docker search 限制

专属域名 · Hub 搜索

不支持 push

仅支持 pull · 不支持

拉取速度原因

带宽 · 缓存 · 冷热镜像

错误码

402 与流量用尽

402 · 流量包 · 充值

401 认证失败

401 · docker login

manifest unknown

标签错误 · 镜像不存在

410 Gone 排查

410 · Docker 升级

429 限流

免费版 · 专业版 · 企业版 · 请求频率

其他报错

DNS 超时

DNS 解析 · 网络超时

TLS 证书失败

no matching manifest（架构）

账号

失败是否计费

manifest · blob · 计费

申请开发票（企业 / 个人）

企业 · 个人 · 工单

修改登录密码

网站 · 仓库 · 重置

注销账户

工单 · 数据 · 注销

原理

mirrors 不生效

daemon.json · 重启

去掉域名前缀

docker tag · 重命名

指定架构拉取

ARM64 · AMD64 · 多架构

latest 与「最新」

digest · 版本号 · 标签

查看全部问题→

用户好评

来自真实用户的反馈，见证轩辕镜像的优质服务

oldzhang

运维工程师

Linux服务器

"Docker访问体验非常流畅，大镜像也能快速完成下载。"