feat: update openim-web

Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com>
2026-05-09 03:25:59 +08:00 · 2023-08-30 17:10:13 +08:00
parent b465caa4d7
commit 80c985ae12
11 changed files with 138 additions and 17 deletions
@@ -0,0 +1,33 @@
+# 使用官方Go镜像作为基础镜像
+FROM golang:1.21 AS build-env
+ENV CGO_ENABLED=0
+# 设置工作目录
+WORKDIR /app
+
+# 安装curl和unzip工具
+#RUN apt-get update && apt-get install -y curl unzip
+
+# 从GitHub下载并解压dist.zip
+#RUN curl -LO https://github.com/OpenIMSDK/dist.zip \
+ #   && unzip dist.zip -d ./ \
+ #   && rm dist.zip
+
+# 复制Go代码到容器
+COPY . .
+
+# 编译Go代码
+RUN go build -o openim-web
+
+# 使用轻量级的基础镜像
+FROM debian:buster-slim
+
+# 将编译好的二进制文件和dist资源复制到新的容器
+WORKDIR /app
+COPY --from=build-env /app/openim-web /app/openim-web
+COPY --from=build-env /app/dist /app/dist
+
+# 开放容器的20001端口
+EXPOSE 20001
+
+# 指定容器启动命令
+ENTRYPOINT ["/app/openim-web"]
@@ -0,0 +1,79 @@
+# OpenIM Web Service
+
+- [OpenIM Web Service](#openim-web-service)
+  - [Overview](#overview)
+  - [User](#user)
+  - [Docker Deployment](#docker-deployment)
+    - [Build the Docker Image](#build-the-docker-image)
+    - [Run the Docker Container](#run-the-docker-container)
+  - [Configuration](#configuration)
+  - [Contributions](#contributions)
+
+
+OpenIM Web Service is a lightweight containerized service built with Go. The service serves static files and allows customization via environment variables.
+
+## Overview
+
+- Built using Go.
+- Deployed as a Docker container.
+- Serves static files from a directory which can be set via an environment variable.
+- The default port for the service is `20001`, but it can be customized using an environment variable.
+
+## User
+
+example：
+
+```bash
+$ ./openim-web -h
+Usage of ./openim-web:
+  -distPath string
+        Path to the distribution (default "/app/dist")
+  -port string
+        Port to run the server on (default "20001")
+```
+
+Variables can be set as above, Environment variables can also be set
+
+example:
+
+```bash
+$ export OPENIM_WEB_DIST_PATH="/app/dist"
+$ export OPENIM_WEB_PPRT="11001"
+```
+
+Initialize the env configuration file:
+
+```bash
+$ make init
+```
+
+## Docker Deployment
+
+### Build the Docker Image
+
+Even though we've implemented automation, it's to make the developer experience easier:
+
+To build the Docker image for OpenIM Web Service:
+
+```bash
+$ docker build -t openim-web .
+```
+
+### Run the Docker Container
+
+To run the service:
+
+```bash
+$ docker run -e DIST_PATH=/app/dist -e PORT=20001 -p 20001:20001 openim-web
+```
+
+## Configuration
+
+You can configure the OpenIM Web Service using the following environment variables:
+
+- **DIST_PATH**: The path to the directory containing the static files. Default: `/app/dist`.
+- **PORT**: The port on which the service listens. Default: `11001`.
+
+## Contributions
+
+We welcome contributions from the community. If you find any bugs or have feature suggestions, please create an issue or send a pull request.
@@ -0,0 +1,7 @@
+module github.com/OpenIMSDK/Open-IM-Server/tools/openim-web
+
+go 1.18
+
+require gopkg.in/yaml.v2 v2.4.0
+
+require github.com/NYTimes/gziphandler v1.1.1 // indirect
@@ -0,0 +1,10 @@
+github.com/NYTimes/gziphandler v1.1.1 h1:ZUDjpQae29j0ryrS0u/B8HZfJBtBQHjqw2rQ2cqUQ3I=
+github.com/NYTimes/gziphandler v1.1.1/go.mod h1:n/CVRwUEOgIxrgPvAQhUUr9oeUtvrhMomdKFjzJNB0c=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
+gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
@@ -0,0 +1,49 @@
+package main
+
+import (
+	"flag"
+	"log"
+	"net/http"
+	"os"
+
+	"github.com/NYTimes/gziphandler"
+)
+
+var (
+	distPathFlag string
+	portFlag     string
+)
+
+func init() {
+	flag.StringVar(&distPathFlag, "distPath", "/app/dist", "Path to the distribution")
+	flag.StringVar(&portFlag, "port", "11001", "Port to run the server on")
+}
+
+func main() {
+	flag.Parse()
+
+	distPath := getConfigValue("DIST_PATH", distPathFlag, "/app/dist")
+	fs := http.FileServer(http.Dir(distPath))
+
+	withGzip := gziphandler.GzipHandler(fs)
+
+	http.Handle("/", withGzip)
+
+	port := getConfigValue("PORT", portFlag, "11001")
+	log.Printf("Server listening on port %s in %s...", port, distPath)
+	err := http.ListenAndServe(":"+port, nil)
+	if err != nil {
+		log.Fatal(err)
+	}
+}
+
+func getConfigValue(envKey, flagValue, fallback string) string {
+	envVal := os.Getenv(envKey)
+	if envVal != "" {
+		return envVal
+	}
+	if flagValue != "" {
+		return flagValue
+	}
+	return fallback
+}
@@ -0,0 +1,57 @@
+package main
+
+import (
+	"os"
+	"testing"
+)
+
+func TestGetConfigValue(t *testing.T) {
+	tests := []struct {
+		name       string
+		envKey     string
+		envValue   string
+		flagValue  string
+		fallback   string
+		wantResult string
+	}{
+		{
+			name:       "environment variable set",
+			envKey:     "TEST_KEY",
+			envValue:   "envValue",
+			flagValue:  "",
+			fallback:   "default",
+			wantResult: "envValue",
+		},
+		{
+			name:       "flag set and environment variable not set",
+			envKey:     "TEST_KEY",
+			envValue:   "",
+			flagValue:  "flagValue",
+			fallback:   "default",
+			wantResult: "flagValue",
+		},
+		{
+			name:       "nothing set, use fallback",
+			envKey:     "TEST_KEY",
+			envValue:   "",
+			flagValue:  "",
+			fallback:   "default",
+			wantResult: "default",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if tt.envValue != "" {
+				os.Setenv(tt.envKey, tt.envValue)
+				defer os.Unsetenv(tt.envKey)
+			}
+
+			got := getConfigValue(tt.envKey, tt.flagValue, tt.fallback)
+
+			if got != tt.wantResult {
+				t.Errorf("getConfigValue(%s, %s, %s) = %s; want %s", tt.envKey, tt.flagValue, tt.fallback, got, tt.wantResult)
+			}
+		})
+	}
+}