You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Open-IM-Server/tools
Xinwei Xiong 088b143300
Update README.md (#1265)
9 months ago
..
changelog feat(release-v3.4): Enhanced Build, Deployment, and Configuration Management for Optimized Performance and Automation (#1255) 9 months ago
component feat(release-v3.4): Enhanced Build, Deployment, and Configuration Management for Optimized Performance and Automation (#1255) 9 months ago
data-conversion Update README.md (#1265) 9 months ago
imctl feat(release-v3.4): Enhanced Build, Deployment, and Configuration Management for Optimized Performance and Automation (#1255) 9 months ago
infra feat(release-v3.4): Enhanced Build, Deployment, and Configuration Management for Optimized Performance and Automation (#1255) 9 months ago
ncpu feat(release-v3.4): Enhanced Build, Deployment, and Configuration Management for Optimized Performance and Automation (#1255) 9 months ago
openim-web feat(release-v3.4): Enhanced Build, Deployment, and Configuration Management for Optimized Performance and Automation (#1255) 9 months ago
url2im chore(deps): bump golang.org/x/net from 0.9.0 to 0.17.0 in /tools/url2im (#1189) 9 months ago
versionchecker feat(release-v3.4): Enhanced Build, Deployment, and Configuration Management for Optimized Performance and Automation (#1255) 9 months ago
yamlfmt feat(release-v3.4): Enhanced Build, Deployment, and Configuration Management for Optimized Performance and Automation (#1255) 9 months ago
README.md feat: set docs openim-server url address fix (#1043) 10 months ago

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 ../..