{"id":31710132,"url":"https://github.com/emqx/emqx-elixir-plugin","last_synced_at":"2025-10-09T00:11:10.350Z","repository":{"id":40947225,"uuid":"91527974","full_name":"emqx/emqx-elixir-plugin","owner":"emqx","description":"An Example Plugin for EMQX in Elixir","archived":false,"fork":false,"pushed_at":"2024-06-18T13:41:22.000Z","size":61,"stargazers_count":24,"open_issues_count":3,"forks_count":8,"subscribers_count":22,"default_branch":"emqx50","last_synced_at":"2025-09-29T22:58:33.574Z","etag":null,"topics":["elixir","elixir-plugin","emqx","emqx-plugin"],"latest_commit_sha":null,"homepage":"https://emqx.io","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/emqx.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-05-17T03:06:57.000Z","updated_at":"2024-09-24T19:29:50.000Z","dependencies_parsed_at":"2024-06-18T16:22:24.987Z","dependency_job_id":"55d7be6c-fa93-4925-8bd9-1cbe57c4ce0e","html_url":"https://github.com/emqx/emqx-elixir-plugin","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/emqx/emqx-elixir-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emqx%2Femqx-elixir-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emqx%2Femqx-elixir-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emqx%2Femqx-elixir-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emqx%2Femqx-elixir-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/emqx","download_url":"https://codeload.github.com/emqx/emqx-elixir-plugin/tar.gz/refs/heads/emqx50","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emqx%2Femqx-elixir-plugin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279000745,"owners_count":26082879,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-08T02:00:06.501Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["elixir","elixir-plugin","emqx","emqx-plugin"],"created_at":"2025-10-09T00:10:20.993Z","updated_at":"2025-10-09T00:11:10.342Z","avatar_url":"https://github.com/emqx.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Example EMQX Elixir Plugin Template\n\nAn example Mix project that can be used to build an EMQX 5.7.0 plugin.\n\n## Quickstart\n\n1. `make` or `MIX_ENV=prod mix release --overwrite`\n2. Copy `_build/prod/plugrelex/elixir_plugin_template/elixir_plugin_template-0.1.0.tar.gz` to the `plugins` directory in your EMQX installation.\n3. ```sh\n   emqx ctl plugins install elixir_plugin_template-0.1.0\n   emqx ctl plugins enable elixir_plugin_template-0.1.0\n   emqx ctl plugins start elixir_plugin_template-0.1.0\n   ```\n4. In a console in your broker (`emqx remote_console`):\n\n   ```elixir\n   :emqx.subscribe(\"topic\")\n   :emqx.publish(:emqx_message.make(\"topic\", \"payload\"))\n   ```\n\n   You should see your message printed by the plugin.\n\n   ```elixir\n   emqx_msg: %{\n     extra: [],\n     flags: %{},\n     from: :undefined,\n     headers: %{},\n     id: \u003c\u003c0, 5, 216, 140, 219, 62, 202, 170, 244, 66, 0, 0, 10, 211, 0, 0\u003e\u003e,\n     payload: \"payload\",\n     qos: 0,\n     timestamp: 1645474368899,\n     topic: \"topic\"\n   }\n   ```\n\n## Custom configuration schema\n\nEMQX 5.7.0 introduced the Avro configuration schema feature which allows plugins to define their own config schema to be used and managed.  In order to use this feature:\n\n- Be sure to use EMQX 5.7.0 or newer;\n- Rename and edit the following files:\n  - `priv/config.hocon.example` -\u003e `priv/config.hocon`\n  - `priv/config_i18n.json.example` -\u003e `priv/config_i18n.json`\n  - `priv/config_schema.avsc.example` -\u003e `priv/config_schema.avsc`\n    - Refer to `priv/config_schema.avsc.enterprise.example` if using EMQX Enterprise\n      Edition.\n- Set `:with_config_schema?` to `true` under the `emqx_plugin_opts` release config in\n  `mix.exs`.\n- Add `:emqx_plugins` as a dependency by uncommenting the line containing `emqx_dep.(:emqx_plugins)` in `mix.exs`'s dependencies.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femqx%2Femqx-elixir-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Femqx%2Femqx-elixir-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femqx%2Femqx-elixir-plugin/lists"}