Overview
- Full name
docker.io/openim/openim-api- Registry
- docker.io
- Namespace
- openim
- Repository
- openim-api
- Cached tags
- 91
- Last synced
- 07/06/2026, 08:44 AM
Introduction
OpenIM API 网关镜像，对外 REST/gRPC 入口，路由至各 RPC 微服务，需 OpenIM 全栈同网段部署。
Details
openim/openim-api 作为 OpenIM north-south API 层，鉴权并转发至 rpc-msg/user 等。定位为 API 网关微服务，需 JWT 与 config；K8s Deployment + Ingress。
快速启动
docker run -d --name openim-api \
-p 10002:10002 \
-v $(pwd)/config:/config:ro \
docker.io/openim/openim-api:latest
推荐实践
docker run -d --name openim-api \
--restart unless-stopped \
-p 10002:10002 \
-v /opt/openim/config:/config:ro \
docker.io/openim/openim-api:v3.8.0
核心参数说明
-p 10002:10002— OpenIM API HTTP/gRPC 端口-v .../config:...— 统一配置--restart unless-stopped— API 持续在线- 固定 tag — 与 SDK 版本 pin
Kubernetes
apiVersion: apps/v1
kind: Deployment
metadata:
name: openim-api
spec:
replicas: 3
selector:
matchLabels:
app: openim-api
template:
metadata:
labels:
app: openim-api
spec:
containers:
- name: api
image: docker.io/openim/openim-api:v3.8.0
ports:
- containerPort: 10002
volumeMounts:
- name: config
mountPath: /config
readOnly: true
volumes:
- name: config
configMap:
name: openim-config
---
apiVersion: v1
kind: Service
metadata:
name: openim-api
spec:
selector:
app: openim-api
ports:
- port: 10002
targetPort: 10002
Ingress TLS 暴露客户端 SDK；HPA 按连接数扩缩。