Skip to content

Commit 88c13ff

Browse files
cubxxwcubxxw
committed
feat: add openim-docker design
Signed-off-by: Xinwei Xiong(cubxxw-openim) <[email protected]>
1 parent f75fc34 commit 88c13ff

File tree

235 files changed

+29345
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

235 files changed

+29345
-0
lines changed

‎Makefile

+236
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,236 @@
1+
# ==============================================================================
2+
# define the default goal
3+
#
4+
5+
.DEFAULT_GOAL := help
6+
7+
## all: Run tidy, gen, add-copyright, format, lint, cover, build ✨
8+
.PHONY: all
9+
all: tidy gen add-copyright verify lint cover restart
10+
11+
# ==============================================================================
12+
# Build set
13+
14+
ROOT_PACKAGE=github.com/OpenIMSDK/Open-IM-Server
15+
# TODO: This is version control for the future https://github.com/OpenIMSDK/Open-IM-Server/issues/574
16+
VERSION_PACKAGE=github.com/OpenIMSDK/Open-IM-Server/pkg/version
17+
18+
# ==============================================================================
19+
# Includes
20+
21+
include scripts/make-rules/common.mk # make sure include common.mk at the first include line
22+
include scripts/make-rules/golang.mk
23+
include scripts/make-rules/image.mk
24+
include scripts/make-rules/copyright.mk
25+
include scripts/make-rules/gen.mk
26+
include scripts/make-rules/dependencies.mk
27+
include scripts/make-rules/tools.mk
28+
include scripts/make-rules/release.mk
29+
include scripts/make-rules/swagger.mk
30+
31+
# ==============================================================================
32+
# Usage
33+
34+
define USAGE_OPTIONS
35+
36+
Options:
37+
38+
DEBUG Whether or not to generate debug symbols. Default is 0.
39+
40+
BINS Binaries to build. Default is all binaries under cmd.
41+
This option is available when using: make {build}(.multiarch)
42+
Example: make build BINS="openim-api openim-cmdutils".
43+
44+
PLATFORMS Platform to build for. Default is linux_arm64 and linux_amd64.
45+
This option is available when using: make {build}.multiarch
46+
Example: make multiarch PLATFORMS="linux_s390x linux_mips64
47+
linux_mips64le darwin_amd64 windows_amd64 linux_amd64 linux_arm64".
48+
49+
V Set to 1 enable verbose build. Default is 0.
50+
endef
51+
export USAGE_OPTIONS
52+
53+
# ==============================================================================
54+
# Targets
55+
56+
## init: Initialize openim server project ✨
57+
.PHONY: init
58+
init:
59+
@$(MAKE) gen.init
60+
61+
## demo: Run demo get started with Makefiles quickly ✨
62+
.PHONY: demo
63+
demo:
64+
@$(MAKE) go.demo
65+
66+
## build: Build binaries by default ✨
67+
.PHONY: build
68+
build:
69+
@$(MAKE) go.build
70+
71+
## start: Start openim ✨
72+
.PHONY: start
73+
start:
74+
@$(MAKE) go.start
75+
76+
## stop: Stop openim ✨
77+
.PHONY: stop
78+
stop:
79+
@$(MAKE) go.stop
80+
81+
## restart: Restart openim ✨
82+
.PHONY: restart
83+
restart: clean stop build init start
84+
85+
## multiarch: Build binaries for multiple platforms. See option PLATFORMS. ✨
86+
.PHONY: multiarch
87+
multiarch:
88+
@$(MAKE) go.build.multiarch
89+
90+
## verify: execute all verity scripts. ✨
91+
.PHONY: verify
92+
verify:
93+
@$(MAKE) go.verify
94+
95+
## install: Install deployment openim ✨
96+
.PHONY: install
97+
install:
98+
@$(MAKE) go.install
99+
100+
## check: Check OpenIM deployment ✨
101+
.PHONY: check
102+
check:
103+
@$(MAKE) go.check
104+
105+
## check-component
106+
.PHONY: check-component
107+
check-component:
108+
@$(MAKE) go.check-component
109+
110+
## tidy: tidy go.mod ✨
111+
.PHONY: tidy
112+
tidy:
113+
@$(GO) mod tidy
114+
115+
## vendor: vendor go.mod ✨
116+
.PHONY: vendor
117+
vendor:
118+
@$(GO) mod vendor
119+
120+
## style: code style -> fmt,vet,lint ✨
121+
.PHONY: style
122+
style: fmt vet lint
123+
124+
## fmt: Run go fmt against code. ✨
125+
.PHONY: fmt
126+
fmt:
127+
@$(GO) fmt ./...
128+
129+
## vet: Run go vet against code. ✨
130+
.PHONY: vet
131+
vet:
132+
@$(GO) vet ./...
133+
134+
## lint: Check syntax and styling of go sources. ✨
135+
.PHONY: lint
136+
lint:
137+
@$(MAKE) go.lint
138+
139+
## format: Gofmt (reformat) package sources (exclude vendor dir if existed). ✨
140+
.PHONY: format
141+
format:
142+
@$(MAKE) go.format
143+
144+
## test: Run unit test. ✨
145+
.PHONY: test
146+
test:
147+
@$(MAKE) go.test
148+
149+
## cover: Run unit test and get test coverage. ✨
150+
.PHONY: cover
151+
cover:
152+
@$(MAKE) go.test.cover
153+
154+
## updates: Check for updates to go.mod dependencies. ✨
155+
.PHONY: updates
156+
@$(MAKE) go.updates
157+
158+
## imports: task to automatically handle import packages in Go files using goimports tool. ✨
159+
.PHONY: imports
160+
imports:
161+
@$(MAKE) go.imports
162+
163+
## clean: Remove all files that are created by building. ✨
164+
.PHONY: clean
165+
clean:
166+
@$(MAKE) go.clean
167+
168+
## image: Build docker images for host arch. ✨
169+
.PHONY: image
170+
image:
171+
@$(MAKE) image.build
172+
173+
## image.multiarch: Build docker images for multiple platforms. See option PLATFORMS. ✨
174+
.PHONY: image.multiarch
175+
image.multiarch:
176+
@$(MAKE) image.build.multiarch
177+
178+
## push: Build docker images for host arch and push images to registry. ✨
179+
.PHONY: push
180+
push:
181+
@$(MAKE) image.push
182+
183+
## push.multiarch: Build docker images for multiple platforms and push images to registry. ✨
184+
.PHONY: push.multiarch
185+
push.multiarch:
186+
@$(MAKE) image.push.multiarch
187+
188+
## tools: Install dependent tools. ✨
189+
.PHONY: tools
190+
tools:
191+
@$(MAKE) tools.install
192+
193+
## gen: Generate all necessary files. ✨
194+
.PHONY: gen
195+
gen:
196+
@$(MAKE) gen.run
197+
198+
## swagger: Generate swagger document. ✨
199+
.PHONY: swagger
200+
swagger:
201+
@$(MAKE) swagger.run
202+
203+
## serve-swagger: Serve swagger spec and docs. ✨
204+
.PHONY: swagger.serve
205+
serve-swagger:
206+
@$(MAKE) swagger.serve
207+
208+
## verify-copyright: Verify the license headers for all files. ✨
209+
.PHONY: verify-copyright
210+
verify-copyright:
211+
@$(MAKE) copyright.verify
212+
213+
## add-copyright: Add copyright ensure source code files have license headers. ✨
214+
.PHONY: add-copyright
215+
add-copyright:
216+
@$(MAKE) copyright.add
217+
218+
## advertise: Project introduction, become a contributor ✨
219+
.PHONY: advertise
220+
advertise:
221+
@$(MAKE) copyright.advertise
222+
223+
## release: release the project ✨
224+
.PHONY: release
225+
release: release.verify release.ensure-tag
226+
@scripts/release.sh
227+
228+
## help: Show this help info. ✨
229+
.PHONY: help
230+
help: Makefile
231+
$(call makehelp)
232+
233+
## help-all: Show all help details info. ✨
234+
.PHONY: help-all
235+
help-all: go.help copyright.help tools.help image.help dependencies.help gen.help release.help swagger.help help
236+
$(call makeallhelp)

‎openim-chat/main/config/config.yaml

+104
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
# Copyright © 2023 OpenIM open source community. All rights reserved.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
# 需要先启动OpenIMServer
16+
zookeeper:
17+
schema: openim
18+
zkAddr:
19+
- 127.0.0.1:2181
20+
username: ""
21+
password: ""
22+
23+
chatApi:
24+
openImChatApiPort: [ 10008 ]
25+
listenIP:
26+
27+
adminApi:
28+
openImAdminApiPort: [ 10009 ]
29+
listenIP:
30+
31+
rpc:
32+
registerIP: #作为rpc启动时，注册到zookeeper的IP，api/gateway能访问到此ip和对应的rpcPort中的端口
33+
listenIP: #默认为0.0.0.0
34+
35+
rpcPort:
36+
openImAdminPort: [ 30200 ]
37+
openImChatPort: [ 30300 ]
38+
rpcRegisterName:
39+
openImAdminName: admin
40+
openImChatName: chat
41+
42+
# 没有配置表示和OpenIM一致
43+
mysql:
44+
# address: [ 127.0.0.1:13306 ] #目前仅支持单机
45+
# username: root #用户名
46+
# password: openIM123 #密码
47+
# database: openIM_v2 #不建议修改
48+
# maxOpenConn: 1000 #最大连接数
49+
# maxIdleConn: 100 #最大空闲连接数
50+
# maxLifeTime: 60 #连接可以重复使用的最长时间（秒）
51+
# logLevel: 4 #日志级别 1=slient 2=error 3=warn 4=info
52+
# slowThreshold: 500 #慢语句阈值 （毫秒）
53+
database: openim_enterprise
54+
55+
# 没有配置表示和OpenIM一致
56+
log:
57+
storageLocation: ../logs/ #存放目录
58+
# rotationTime: 24 #日志旋转时间
59+
# remainRotationCount: 2 #日志数量
60+
# remainLogLevel: 6 #日志级别 6表示全都打印，
61+
# isStdout: false
62+
# isJson: false
63+
# withStack: false
64+
65+
# secret: openIM123
66+
#tokenPolicy:
67+
# expire: 86400
68+
69+
verifyCode:
70+
validTime: 300 # 验证码有效时间
71+
validCount: 5 # 验证码有效次数
72+
uintTime: 86400 # 单位时间间隔
73+
maxCount: 10 # 单位时间内最大获取次数
74+
superCode: "666666" # 超级验证码(只有use为空时使用)
75+
len: 6 # 验证码长度
76+
use: "" # 使用的验证码服务(use: "ali")
77+
ali:
78+
endpoint: "dysmsapi.aliyuncs.com"
79+
accessKeyId: ""
80+
accessKeySecret: ""
81+
signName: ""
82+
verificationCodeTemplateCode: ""
83+
84+
# 获取ip的header,没有配置直接获取远程地址
85+
#proxyHeader: "X-Forwarded-For"
86+
87+
adminList:
88+
- adminID: admin1
89+
nickname: chat1
90+
imAdmin: openIM123456
91+
- adminID: admin2
92+
nickname: chat2
93+
imAdmin: openIM654321
94+
- adminID: admin3
95+
nickname: chat3
96+
imAdmin: openIMAdmin
97+
98+
99+
openIMUrl: "http://127.0.0.1:10002"
100+
101+
redis:
102+
address: [ 127.0.0.1:16379 ]
103+
username:
104+
password: openIM123

0 commit comments

Comments
 (0)