openim-server/tools
cui fliter 6a5a2dcc17
fix function name on comment (#1940)
Signed-off-by: cui fliter <imcusg@gmail.com>
2024-02-21 12:41:15 +00:00
..
changelog 🚀 Enhancements in Offline Deployment Documentation, CICD Process Upgrades, Deployment Optimization, and Additional Fixes (#1721) 2024-01-12 10:04:06 +00:00
component cicd: bump League Patch (#1874) 2024-02-04 02:40:26 +00:00
data-conversion chore(deps): bump golang.org/x/crypto in /tools/data-conversion (#1580) 2024-01-28 10:30:51 +00:00
formitychecker fix function name on comment (#1940) 2024-02-21 12:41:15 +00:00
imctl feat(main): 🚀 Database Name Correction and S3 Module Int32 Overflow Fix with Go Routine Integration for Automated Checks and Script Optimization (#1799) 2024-01-26 02:02:53 +00:00
infra feat: Add OpenIM server, environment support for Docker Compose, and Kubernetes deployment. (#1559) 2023-12-18 02:24:12 +00:00
ncpu cicd: bump League Patch (#1874) 2024-02-04 02:40:26 +00:00
openim-web feat: add openim docker compose deployment github comment (#1769) 2024-01-15 08:39:44 +00:00
up35 🚀 Enhancements in Offline Deployment Documentation, CICD Process Upgrades, Deployment Optimization, and Additional Fixes (#1721) 2024-01-12 10:04:06 +00:00
url2im chore(deps): bump google.golang.org/grpc in /tools/url2im (#1283) 2024-01-28 10:32:34 +00:00
versionchecker docs: add openim cluster helm chart (#1291) 2023-10-30 02:16:37 +00:00
yamlfmt 🚀 Enhancements in Offline Deployment Documentation, CICD Process Upgrades, Deployment Optimization, and Additional Fixes (#1721) 2024-01-12 10:04:06 +00:00
README.md feat: set docs openim-server url address fix (#1043) 2023-09-08 07:20:30 +00:00

README.md

Notes about go workspace

As openim is using go1.18's workspace feature, once you add a new module, you need to run go work use -r . at root directory to update the workspace synced.

Create a new extensions

  1. Create your tools_name directory in pkg /tools first and cd into it.
  2. Init the project.
  3. Then go work use -r . at current directory to update the workspace.
  4. Create your tools

You can execute the following commands to do things above:

# edit the CRD_NAME and CRD_GROUP to your own
export OPENIM_TOOLS_NAME=<Changeme>

# copy and paste to create a new CRD and Controller
mkdir tools/${OPENIM_TOOLS_NAME}
cd tools/${OPENIM_TOOLS_NAME}
go mod init github.com/openimsdk/open-im-server/tools/${OPENIM_TOOLS_NAME}
go mod tidy
go work use -r .
cd ../..