mirror of
https://github.com/openimsdk/open-im-server.git
synced 2025-04-05 20:11:14 +08:00
fb74453c18
* Code adaptation k8s: service discovery and registration adaptation, configuration adaptation * Initial submission of the help charts script for openim API * change the help charts script * change the help charts script * change helm chart codes * change dockerfiles script * change chart script:add configmap mounts * change chart script:change repository * change chart script:msggateway add one service * change config.yaml * roll back some config values * change chart script:change Ingress rule with a rewrite annotation * add mysql charts scrible * change chart script:add mysql.config.yaml * add nfs provisioner charts * change chart script:add nfs.config.yaml * add ingress-nginx charts * change chart script:add ingress-nginx.config.yaml * add redis &mongodb charts * add kafka&minio charts * change chart script:change redis.values.yaml * change chart script:add redis.config.yaml * change chart script:change redis.config.yaml * change chart script:change mongodb.value.yaml * change chart script:change mongodb.value.yaml * change chart script:add mongodb.config.yaml * change chart script:change minio.values.yaml * change chart script:add minio.config.yaml * change chart script:change kafka.values.yaml * change chart script:add kafka.config.yaml * change chart script:change services.config.yaml * bug fix:Delete websocket's Port restrictions * bug fix:change port value * change chart script:Submit a stable version script * fix bug:Implement option interface * fix bug:change K8sDR.Register * change config.yaml * change chats script:minio service add ingress * change chats script:minio service add ingress * change chats script:kafka.replicaCount=3& change minio.api ingress * delete change chats script * change config.yaml * change openim.yaml * merge go.sum * Add monitoring function and struct for Prometheus on gin and GRPC * Add GRPC and gin server monitoring logic * Add GRPC and gin server monitoring logic2 * Add GRPC and gin server monitoring logic3 * Add GRPC and gin server monitoring logic4 * Add GRPC and gin server monitoring logic5 * Add GRPC and gin server monitoring logic6 * Add GRPC and gin server monitoring logic7 * delete:old monitoring code * add for test * fix bug:change packname * fix bug:delete getPromPort funciton * fix bug:delete getPromPort funciton * fix bug:change logs * fix bug:change registerName logic in GetGrpcCusMetrics function * add getPrometheus url api * fix:config path logic * fix:prometheus enable function * fix:prometheus enable function * fix:transfer Multi process monitoring logic * del:del not using manifest * fix:openim-msgtransfer.sh * fix:openim-msgtransfer.sh * cicd: robot automated Change * delete not using files * add prometheus docker-compose for monitor * fix prometheus.yaml * fix environment.sh * fix init-config.sh * fix init-config.sh * fix env_template.yaml * fix docker-compose.yml * fix docker-compose.yml * add openim_admin_front service * change openim-admin-front * del not using files * add node-exporter-dashaboard.yaml * cicd: robot automated Change * cicd: robot automated Change * feature: add alertmanager function * feature: add alertmanager function * feature: add alertmanager function * feature: add alertmanager function * feature: add alertmanager function * del:delete not using files * del:delete not using files * change:change to personal email info * feat: deployment and design of management backend and monitoring Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com> * feat: deployment and design of management backend and monitoring Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com> * feat: deployment and design of management backend and monitoring Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com> --------- Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com> Co-authored-by: lin.huang <lin.huang@apulis.com> Co-authored-by: xuexihuang <1339326187@qq.com> Co-authored-by: xuexihuang <xuexihuang@users.noreply.github.com> Co-authored-by: cubxxw <cubxxw@users.noreply.github.com>
OpenIM Server Docs
Welcome to the OpenIM Documentation hub! This center provides a comprehensive range of guides and manuals designed to help you get the most out of your OpenIM experience.
Table of Contents
- Contrib - Guidance on contributing and configurations for developers
- Conversions - Coding conventions, logging policies, and other transformation tools
Contrib
This section offers developers a detailed guide on how to contribute code, set up their environment, and follow the associated processes.
- Code Conventions - Rules and conventions for writing code in OpenIM.
- Development Guide - A guide on how to carry out development within OpenIM.
- Git Cherry Pick - Guidelines on cherry-picking operations.
- Git Workflow - The git workflow in OpenIM.
- Initialization Configurations - Guidance on setting up and initializing OpenIM.
- Docker Installation - How to install Docker on your machine.
- Linux Development Environment - Guide to set up the development environment on Linux.
- Local Actions - Guidelines on how to carry out certain common actions locally.
- Offline Deployment - Methods of deploying OpenIM offline.
- Protoc Tools - Guide on using protoc tools.
- Go Tools - Tools and libraries in OpenIM for Go.
- Makefile Tools - Best practices and tools for Makefile.
- Script Tools - Best practices and tools for scripts.
Conversions
This section introduces various conventions and policies within OpenIM, encompassing code, logs, versions, and more.
- API Conversions - Guidelines and methods for API conversions.
- Logging Policy - Logging policies and conventions in OpenIM.
- CI/CD Actions - Procedures and conventions for CI/CD.
- Commit Conventions - Conventions for code commits in OpenIM.
- Directory Conventions - Directory structure and conventions within OpenIM.
- Error Codes - List and descriptions of error codes.
- Go Code Conversions - Conventions and conversions for Go code.
- Docker Image Strategy - Management strategies for OpenIM Docker images, spanning multiple architectures and image repositories.
- Logging Conventions - Further detailed conventions on logging.
- Version Conventions - Naming and management strategies for OpenIM versions.
For Developers, Contributors, and Community Maintainers
Developers & Contributors
If you're a developer or someone keen on contributing:
- Familiarize yourself with our Code Conventions and Git Workflow to ensure smooth contributions.
- Dive into the Development Guide to get a hang of the development practices in OpenIM.
Community Maintainers
As a community maintainer:
- Ensure that contributions align with the standards outlined in our documentation.
- Regularly review the Logging Policy and Error Codes to stay updated.
For Users
Users should pay particular attention to:
- Docker Installation - Necessary if you're planning to use Docker images of OpenIM.
- Docker Image Strategy - To understand the different images available and how to choose the right one for your architecture.