octo-im-plugins

中文: README.zh-CN.md

A plugin collection for WuKongIM, maintained by Mininglamp-OSS as part of the octo-im plugin family.

Plugins

Plugin	Path	Status	Description
Kafka forwarder	plugins/kafka	0.1.0	Forward persisted WuKongIM messages to Apache Kafka asynchronously.

Repository layout

.
├── plugins/
│   └── kafka/             # Each plugin lives in its own directory
│       ├── main.go        # Plugin entry (PluginNo: wk.plugin.kafka)
│       ├── internal/      # Plugin-private packages
│       ├── Makefile
│       ├── Dockerfile
│       ├── README.md
├── go.mod                 # Single Go module for the whole repo
├── LICENSE                # Apache-2.0 (applies to all plugins)
├── CONTRIBUTING.md
├── CODE_OF_CONDUCT.md
├── CHANGELOG.md
└── .github/               # Repo-wide CI and templates

This repo uses a single Go module (github.com/Mininglamp-OSS/octo-im-plugins). All plugins share the same dependency versions to stay aligned with a given WuKongIM PDK release.

Build a plugin

Each plugin owns its own Makefile. From the repo root:

cd plugins/kafka
make build      # cross-compiles a static linux/amd64 binary: wk.plugin.kafka.wkp
make image      # builds a local Docker image (no public image is published)

WuKongIM scans <RootDir>/plugins/ for .wkp files. See the per-plugin README for installation details.

Requirements

• Go 1.23+
• A reachable WuKongIM instance that loads .wkp plugins
• Plugin-specific dependencies (e.g., a Kafka cluster for the Kafka forwarder)

Adding a new plugin

1. Create plugins/<name>/ with main.go, Makefile, Dockerfile, internal/, README.md
2. Use module path github.com/Mininglamp-OSS/octo-im-plugins/plugins/<name>/internal for internal packages
3. Run go mod tidy and go vet ./... from the repo root
4. Add an entry to the table above and to CHANGELOG.md

License

Apache-2.0. See LICENSE, CONTRIBUTING.md.