Package: zenoh Version: 1.3.3 Architecture: armel Maintainer: zenoh-dev@eclipse.org Installed-Size: 41 Depends: zenoh-plugin-rest (=1.3.3), zenoh-plugin-storage-manager (=1.3.3), zenohd (=1.3.3) Filename: 1.3.3/zenoh_1.3.3_armel.deb Size: 17552 MD5sum: 91b4b52dbd2e20cee46edaf411215388 SHA1: d76df7af39f0c1f9762708c39e4771f49b4f4399 SHA256: 14616672e4e3780b50f70ecf022a296a4df2ce3099e78289b0a1230dc726b03b Section: net Priority: optional Homepage: http://zenoh.io Description: Zenoh: The Zero Overhead Pub/Sub/Query Protocol. . [![CI](https://github.com/eclipse-zenoh/zenoh/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/eclipse-zenoh/zenoh/actions?query=workflow%3ACI+branch%3Amain++) [![Documentation Status](https://readthedocs.org/projects/zenoh-rust/badge/?version=latest)](https://zenoh-rust.readthedocs.io/en/latest/?badge=latest) [![codecov](https://codecov.io/github/eclipse-zenoh/zenoh/branch/main/graph/badge.svg?token=F8T4C8WPZD)](https://codecov.io/github/eclipse-zenoh/zenoh) [![Discussion](https://img.shields.io/badge/discussion-on%20github-blue)](https://github.com/eclipse-zenoh/roadmap/discussions) [![Discord](https://img.shields.io/badge/chat-on%20discord-blue)](https://discord.gg/2GJ958VuHs) [![License](https://img.shields.io/badge/License-EPL%202.0-blue)](https://choosealicense.com/licenses/epl-2.0/) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) . # Eclipse Zenoh . The Eclipse Zenoh: Zero Overhead Pub/sub, Store/Query and Compute. . Zenoh (pronounce _/zeno/_) unifies data in motion, data at rest and computations. It carefully blends traditional pub/sub with geo-distributed storages, queries and computations, while retaining a level of time and space efficiency that is well beyond any of the mainstream stacks. . Check the website [zenoh.io](http://zenoh.io) and the [roadmap](https://github.com/eclipse-zenoh/roadmap) for more detailed information. . ------------------------------- . ## Getting Started . Zenoh is extremely easy to learn, the best place to master the fundamentals is our [getting started guide](https://zenoh.io/docs/getting-started/first-app/). . ------------------------------- . ## How to install it . To install the latest release of the Zenoh router (`zenohd`) and its default plugins (REST API plugin and Storages Manager plugin) you can do as follows: . ### Manual installation (all platforms) . All release packages can be downloaded from [https://download.eclipse.org/zenoh/zenoh/latest/](https://download.eclipse.org/zenoh/zenoh/latest/). . Each subdirectory has the name of the Rust target. See the platforms each target corresponds to on [https://doc.rust-lang.org/stable/rustc/platform-support.html](https://doc.rust-lang.org/stable/rustc/platform-support.html). . Choose your platform and download the `.zip` file. Unzip it where you want, and run the extracted `zenohd` binary. . ### Linux Debian . Add Eclipse Zenoh private repository to the sources list, and install the `zenoh` package: . ```bash echo "deb [trusted=yes] https://download.eclipse.org/zenoh/debian-repo/ /" | sudo tee -a /etc/apt/sources.list.d/zenoh.list > /dev/null sudo apt update sudo apt install zenoh ``` . Then you can start run `zenohd`. . ### MacOS . Tap our brew package repository and install the `zenoh` formula: . ```bash brew tap eclipse-zenoh/homebrew-zenoh brew install zenoh ``` . Then you can start run `zenohd`. . ------------------------------- . ## Rust API . * [Docs.rs for Zenoh](https://docs.rs/zenoh/latest/zenoh/) . ------------------------------- . ## How to build it . > [!WARNING] > Zenoh and its ecosystem are under active development. When you build from git, make sure you also build from git any other Zenoh repository you plan to use (e.g. binding, plugin, backend, etc.). It may happen that some changes in git are not compatible with the most recent packaged Zenoh release (e.g. deb, docker, pip). We put particular effort in maintaining compatibility between the various git repositories in the Zenoh project. . Install [Cargo and Rust](https://doc.rust-lang.org/cargo/getting-started/installation.html). Zenoh can be successfully compiled with Rust stable (>= 1.75.0), so no special configuration is required from your side. If you already have the Rust toolchain installed, make sure it is up-to-date with: . ```bash rustup update ``` . To build Zenoh, just type the following command after having followed the previous instructions: . ```bash cargo build --release --all-targets ``` . Zenoh's router is built as `target/release/zenohd`. All the examples are built into the `target/release/examples` directory. They can all work in peer-to-peer, or interconnected via the zenoh router. . ------------------------------- . ## Quick tests of your build . ### Peer-to-peer tests . * **pub/sub** * run: `./target/release/examples/z_sub` * in another shell run: `./target/release/examples/z_put` * the subscriber should receive the publication. . * **get/queryable** * run: `./target/release/examples/z_queryable` * in another shell run: `./target/release/examples/z_get` * the queryable should display the log in its listener, and the get should receive the queryable result. . ### Routed tests . > [!NOTE] > **Windows users**: to properly execute the commands below in PowerShell you need to escape `"` characters as `\"`. . * **put / store / get** * run the Zenoh router with a memory storage: . ```sh ./target/release/zenohd --cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/example/**",volume:"memory"}' ``` . * in another shell run: . ```sh ./target/release/examples/z_put` ``` . * then run . ```sh ./target/release/examples/z_get ``` . * the get should receive the stored publication. . * **REST API using `curl` tool** * run the Zenoh router with a memory storage: . ```sh ./target/release/zenohd --cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/example/**",volume:"memory"}' ``` . * in another shell, do a publication via the REST API: . ```sh curl -X PUT -d '"Hello World!"' http://localhost:8000/demo/example/test ``` . * get it back via the REST API: . ```sh curl http://localhost:8000/demo/example/test ``` . * **router admin space via the REST API** * run the Zenoh router with permission to perform config changes via the admin space, and with a memory storage: . ```sh ./target/release/zenohd --rest-http-port=8000 --adminspace-permissions=rw --cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/example/**",volume:"memory"}' ``` . * in another shell, get info of the zenoh router via the zenoh admin space (you may use `jq` for pretty json formatting): . ```sh curl -s http://localhost:8000/@/local/router | jq ``` . * get the volumes of the router (only memory by default): . ```sh curl -s 'http://localhost:8000/@/local/router/**/volumes/*' | jq ``` . * get the storages of the local router (the memory storage configured at startup on '/demo/example/**' should be present): . ```sh curl -s 'http://localhost:8000/@/local/router/**/storages/*' | jq ``` . * add another memory storage on `/demo/mystore/**`: . ```sh curl -X PUT -H 'content-type:application/json' -d '{"key_expr":"demo/mystore/**","volume":"memory"}' http://localhost:8000/@/local/router/config/plugins/storage_manager/storages/mystore ``` . * check it has been created: . ```sh curl -s 'http://localhost:8000/@/local/router/**/storages/*' | jq ``` . ### Configuration options . A Zenoh configuration file can be provided via CLI to all Zenoh examples and the Zenoh router. . * `-c, --config `: a [JSON5](https://json5.org) configuration file. [DEFAULT_CONFIG.json5](DEFAULT_CONFIG.json5) shows the schema of this file and the available options. . See other examples of Zenoh usage in [examples/](examples) . > [!NOTE] > **Zenoh Runtime Configuration**: Starting from version 0.11.0-rc, Zenoh allows for configuring the number of worker threads and other advanced options of the runtime. For guidance on utilizing it, please refer to the [doc](https://docs.rs/zenoh-runtime/latest/zenoh_runtime/enum.ZRuntime.html). . ------------------------------- . ## Zenoh router command line arguments . `zenohd` accepts the following arguments: . * `--adminspace-permissions <[r|w|rw|none]>`: Configure the read and/or write permissions on the admin space. Default is read only. * `-c, --config `: a [JSON5](https://json5.org) configuration file. [DEFAULT_CONFIG.json5](DEFAULT_CONFIG.json5) shows the schema of this file. All properties of this configuration are optional, so you may not need such a large configuration for your use-case. * `--cfg :`: allows you to change specific parts of the configuration right after it has been constructed. VALUE must be a valid JSON5 value, and key must be a path through the configuration file, where each element is separated by a `/`. When inserting in parts of the config that are arrays, you may use indexes, or may use `+` to indicate that you want to append your value to the array. `--cfg` passed values will always override any previously existing value for their key in the configuration. * `-l, --listen ...`: An endpoint on which this router will listen for incoming sessions. Repeat this option to open several listeners. By default, `tcp/[::]:7447` is used. The following endpoints are currently supported: * TCP: `tcp/:` * UDP: `udp/:` * [TCP+TLS](https://zenoh.io/docs/manual/tls/): `tls/:` * [QUIC](https://zenoh.io/docs/manual/quic/): `quic/:` * `-e, --connect ...`: An endpoint this router will try to connect to. Repeat this option to connect to several peers or routers. * `--no-multicast-scouting`: By default zenohd replies to multicast scouting messages for being discovered by peers and clients. This option disables this feature. * `-i, --id `: The identifier (as an hexadecimal string - e.g.: A0B23...) that zenohd must use. **WARNING**: this identifier must be unique in the system! If not set, a random unsigned 128bit integer will be used. * `--no-timestamp`: By default zenohd adds a HLC-generated Timestamp to each routed Data if there isn't already one. This option disables this feature. * `-P, --plugin [ | :]...`: A [plugin](https://zenoh.io/docs/manual/plugins/) that must be loaded. Accepted values: * a plugin name; zenohd will search for a library named `libzenoh_plugin_.so` on Unix, `libzenoh_plugin_.dylib` on MacOS or `zenoh_plugin_.dll` on Windows. * `":"`; the plugin will be loaded from library file at ``. . Repeat this option to load several plugins. * `--plugin-search-dir ...`: A directory where to search for [plugins](https://zenoh.io/docs/manual/plugins/) libraries to load. Repeat this option to specify several search directories'. By default, the plugins libraries will be searched in: `'/usr/local/lib:/usr/lib:~/.zenoh/lib:.'` * `--rest-http-port `: Configures the [REST plugin](https://zenoh.io/docs/manual/plugin-http/)'s HTTP port. Accepted values: * a port number * a string with format `:` (to bind the HTTP server to a specific interface) * `"None"` to deactivate the REST plugin . If not specified, the REST plugin will be active on any interface (`[::]`) and port `8000`. . ------------------------------- . ## Plugins . > [!WARNING] > As Rust doesn't have a stable ABI, the plugins should be built with the exact same Rust version as `zenohd`, and using for `zenoh` dependency the same version (or commit number) as `zenohd` with the same set of features. A plugin compiled with different Rust version or with different set of `zenoh` crate features will be rejected when `zenohd` attempts to load it. Otherwise, incompatibilities in memory mapping of structures shared between `zenohd` and the library could lead to a `"SIGSEGV"` crash. . By default the Zenoh router is delivered or built with 2 plugins. These may be configured through a configuration file, or through individual changes to the configuration via the `--cfg` CLI option or via zenoh puts on individual parts of the configuration. . > [!WARNING] > Since `v0.6`, `zenohd` no longer loads every available plugin at startup. Instead, only configured plugins are loaded (after processing `--cfg` and `--plugin` options). Once `zenohd` is running, plugins can be hot-loaded and, if they support it, reconfigured at runtime by editing their configuration through the adminspace. . **[REST plugin](https://zenoh.io/docs/manual/plugin-http/)** (exposing a REST API): This plugin converts GET and PUT REST requests into Zenoh gets and puts respectively. . Note that to activate the REST plugin on `zenohd` the CLI argument should be passed: `--rest-http-port=8000` (or any other port of your choice). . **[Storages plugin](https://zenoh.io/docs/manual/plugin-storage-manager/)** (managing [backends and storages](https://zenoh.io/docs/manual/plugin-storage-manager/#backends-and-volumes)) This plugin allows you to easily define storages. These will store key-value pairs they subscribed to, and send the most recent ones when queried. Check out [DEFAULT_CONFIG.json5](DEFAULT_CONFIG.json5) for info on how to configure them. . ------------------------------- . ## Troubleshooting . In case of troubles, please first check on [this page](https://zenoh.io/docs/getting-started/troubleshooting/) if the trouble and cause are already known. Otherwise, you can ask a question on the [zenoh Discord server](https://discord.gg/vSDSpqnbkm), or [create an issue](https://github.com/eclipse-zenoh/zenoh/issues). Package: zenoh Version: 1.3.3 Architecture: amd64 Maintainer: zenoh-dev@eclipse.org Installed-Size: 41 Depends: zenoh-plugin-rest (=1.3.3), zenoh-plugin-storage-manager (=1.3.3), zenohd (=1.3.3) Filename: 1.3.3/zenoh_1.3.3_amd64.deb Size: 17552 MD5sum: 4ae9c56f130cef5d177d8f69ae8800fb SHA1: 8c63d2c2659d9bf176877a9c826a515957604495 SHA256: d26d27bb869b1a56fc38f0cffeee4549e0b32da68b131227f9850b9da2de926f Section: net Priority: optional Homepage: http://zenoh.io Description: Zenoh: The Zero Overhead Pub/Sub/Query Protocol. . [![CI](https://github.com/eclipse-zenoh/zenoh/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/eclipse-zenoh/zenoh/actions?query=workflow%3ACI+branch%3Amain++) [![Documentation Status](https://readthedocs.org/projects/zenoh-rust/badge/?version=latest)](https://zenoh-rust.readthedocs.io/en/latest/?badge=latest) [![codecov](https://codecov.io/github/eclipse-zenoh/zenoh/branch/main/graph/badge.svg?token=F8T4C8WPZD)](https://codecov.io/github/eclipse-zenoh/zenoh) [![Discussion](https://img.shields.io/badge/discussion-on%20github-blue)](https://github.com/eclipse-zenoh/roadmap/discussions) [![Discord](https://img.shields.io/badge/chat-on%20discord-blue)](https://discord.gg/2GJ958VuHs) [![License](https://img.shields.io/badge/License-EPL%202.0-blue)](https://choosealicense.com/licenses/epl-2.0/) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) . # Eclipse Zenoh . The Eclipse Zenoh: Zero Overhead Pub/sub, Store/Query and Compute. . Zenoh (pronounce _/zeno/_) unifies data in motion, data at rest and computations. It carefully blends traditional pub/sub with geo-distributed storages, queries and computations, while retaining a level of time and space efficiency that is well beyond any of the mainstream stacks. . Check the website [zenoh.io](http://zenoh.io) and the [roadmap](https://github.com/eclipse-zenoh/roadmap) for more detailed information. . ------------------------------- . ## Getting Started . Zenoh is extremely easy to learn, the best place to master the fundamentals is our [getting started guide](https://zenoh.io/docs/getting-started/first-app/). . ------------------------------- . ## How to install it . To install the latest release of the Zenoh router (`zenohd`) and its default plugins (REST API plugin and Storages Manager plugin) you can do as follows: . ### Manual installation (all platforms) . All release packages can be downloaded from [https://download.eclipse.org/zenoh/zenoh/latest/](https://download.eclipse.org/zenoh/zenoh/latest/). . Each subdirectory has the name of the Rust target. See the platforms each target corresponds to on [https://doc.rust-lang.org/stable/rustc/platform-support.html](https://doc.rust-lang.org/stable/rustc/platform-support.html). . Choose your platform and download the `.zip` file. Unzip it where you want, and run the extracted `zenohd` binary. . ### Linux Debian . Add Eclipse Zenoh private repository to the sources list, and install the `zenoh` package: . ```bash echo "deb [trusted=yes] https://download.eclipse.org/zenoh/debian-repo/ /" | sudo tee -a /etc/apt/sources.list.d/zenoh.list > /dev/null sudo apt update sudo apt install zenoh ``` . Then you can start run `zenohd`. . ### MacOS . Tap our brew package repository and install the `zenoh` formula: . ```bash brew tap eclipse-zenoh/homebrew-zenoh brew install zenoh ``` . Then you can start run `zenohd`. . ------------------------------- . ## Rust API . * [Docs.rs for Zenoh](https://docs.rs/zenoh/latest/zenoh/) . ------------------------------- . ## How to build it . > [!WARNING] > Zenoh and its ecosystem are under active development. When you build from git, make sure you also build from git any other Zenoh repository you plan to use (e.g. binding, plugin, backend, etc.). It may happen that some changes in git are not compatible with the most recent packaged Zenoh release (e.g. deb, docker, pip). We put particular effort in maintaining compatibility between the various git repositories in the Zenoh project. . Install [Cargo and Rust](https://doc.rust-lang.org/cargo/getting-started/installation.html). Zenoh can be successfully compiled with Rust stable (>= 1.75.0), so no special configuration is required from your side. If you already have the Rust toolchain installed, make sure it is up-to-date with: . ```bash rustup update ``` . To build Zenoh, just type the following command after having followed the previous instructions: . ```bash cargo build --release --all-targets ``` . Zenoh's router is built as `target/release/zenohd`. All the examples are built into the `target/release/examples` directory. They can all work in peer-to-peer, or interconnected via the zenoh router. . ------------------------------- . ## Quick tests of your build . ### Peer-to-peer tests . * **pub/sub** * run: `./target/release/examples/z_sub` * in another shell run: `./target/release/examples/z_put` * the subscriber should receive the publication. . * **get/queryable** * run: `./target/release/examples/z_queryable` * in another shell run: `./target/release/examples/z_get` * the queryable should display the log in its listener, and the get should receive the queryable result. . ### Routed tests . > [!NOTE] > **Windows users**: to properly execute the commands below in PowerShell you need to escape `"` characters as `\"`. . * **put / store / get** * run the Zenoh router with a memory storage: . ```sh ./target/release/zenohd --cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/example/**",volume:"memory"}' ``` . * in another shell run: . ```sh ./target/release/examples/z_put` ``` . * then run . ```sh ./target/release/examples/z_get ``` . * the get should receive the stored publication. . * **REST API using `curl` tool** * run the Zenoh router with a memory storage: . ```sh ./target/release/zenohd --cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/example/**",volume:"memory"}' ``` . * in another shell, do a publication via the REST API: . ```sh curl -X PUT -d '"Hello World!"' http://localhost:8000/demo/example/test ``` . * get it back via the REST API: . ```sh curl http://localhost:8000/demo/example/test ``` . * **router admin space via the REST API** * run the Zenoh router with permission to perform config changes via the admin space, and with a memory storage: . ```sh ./target/release/zenohd --rest-http-port=8000 --adminspace-permissions=rw --cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/example/**",volume:"memory"}' ``` . * in another shell, get info of the zenoh router via the zenoh admin space (you may use `jq` for pretty json formatting): . ```sh curl -s http://localhost:8000/@/local/router | jq ``` . * get the volumes of the router (only memory by default): . ```sh curl -s 'http://localhost:8000/@/local/router/**/volumes/*' | jq ``` . * get the storages of the local router (the memory storage configured at startup on '/demo/example/**' should be present): . ```sh curl -s 'http://localhost:8000/@/local/router/**/storages/*' | jq ``` . * add another memory storage on `/demo/mystore/**`: . ```sh curl -X PUT -H 'content-type:application/json' -d '{"key_expr":"demo/mystore/**","volume":"memory"}' http://localhost:8000/@/local/router/config/plugins/storage_manager/storages/mystore ``` . * check it has been created: . ```sh curl -s 'http://localhost:8000/@/local/router/**/storages/*' | jq ``` . ### Configuration options . A Zenoh configuration file can be provided via CLI to all Zenoh examples and the Zenoh router. . * `-c, --config `: a [JSON5](https://json5.org) configuration file. [DEFAULT_CONFIG.json5](DEFAULT_CONFIG.json5) shows the schema of this file and the available options. . See other examples of Zenoh usage in [examples/](examples) . > [!NOTE] > **Zenoh Runtime Configuration**: Starting from version 0.11.0-rc, Zenoh allows for configuring the number of worker threads and other advanced options of the runtime. For guidance on utilizing it, please refer to the [doc](https://docs.rs/zenoh-runtime/latest/zenoh_runtime/enum.ZRuntime.html). . ------------------------------- . ## Zenoh router command line arguments . `zenohd` accepts the following arguments: . * `--adminspace-permissions <[r|w|rw|none]>`: Configure the read and/or write permissions on the admin space. Default is read only. * `-c, --config `: a [JSON5](https://json5.org) configuration file. [DEFAULT_CONFIG.json5](DEFAULT_CONFIG.json5) shows the schema of this file. All properties of this configuration are optional, so you may not need such a large configuration for your use-case. * `--cfg :`: allows you to change specific parts of the configuration right after it has been constructed. VALUE must be a valid JSON5 value, and key must be a path through the configuration file, where each element is separated by a `/`. When inserting in parts of the config that are arrays, you may use indexes, or may use `+` to indicate that you want to append your value to the array. `--cfg` passed values will always override any previously existing value for their key in the configuration. * `-l, --listen ...`: An endpoint on which this router will listen for incoming sessions. Repeat this option to open several listeners. By default, `tcp/[::]:7447` is used. The following endpoints are currently supported: * TCP: `tcp/:` * UDP: `udp/:` * [TCP+TLS](https://zenoh.io/docs/manual/tls/): `tls/:` * [QUIC](https://zenoh.io/docs/manual/quic/): `quic/:` * `-e, --connect ...`: An endpoint this router will try to connect to. Repeat this option to connect to several peers or routers. * `--no-multicast-scouting`: By default zenohd replies to multicast scouting messages for being discovered by peers and clients. This option disables this feature. * `-i, --id `: The identifier (as an hexadecimal string - e.g.: A0B23...) that zenohd must use. **WARNING**: this identifier must be unique in the system! If not set, a random unsigned 128bit integer will be used. * `--no-timestamp`: By default zenohd adds a HLC-generated Timestamp to each routed Data if there isn't already one. This option disables this feature. * `-P, --plugin [ | :]...`: A [plugin](https://zenoh.io/docs/manual/plugins/) that must be loaded. Accepted values: * a plugin name; zenohd will search for a library named `libzenoh_plugin_.so` on Unix, `libzenoh_plugin_.dylib` on MacOS or `zenoh_plugin_.dll` on Windows. * `":"`; the plugin will be loaded from library file at ``. . Repeat this option to load several plugins. * `--plugin-search-dir ...`: A directory where to search for [plugins](https://zenoh.io/docs/manual/plugins/) libraries to load. Repeat this option to specify several search directories'. By default, the plugins libraries will be searched in: `'/usr/local/lib:/usr/lib:~/.zenoh/lib:.'` * `--rest-http-port `: Configures the [REST plugin](https://zenoh.io/docs/manual/plugin-http/)'s HTTP port. Accepted values: * a port number * a string with format `:` (to bind the HTTP server to a specific interface) * `"None"` to deactivate the REST plugin . If not specified, the REST plugin will be active on any interface (`[::]`) and port `8000`. . ------------------------------- . ## Plugins . > [!WARNING] > As Rust doesn't have a stable ABI, the plugins should be built with the exact same Rust version as `zenohd`, and using for `zenoh` dependency the same version (or commit number) as `zenohd` with the same set of features. A plugin compiled with different Rust version or with different set of `zenoh` crate features will be rejected when `zenohd` attempts to load it. Otherwise, incompatibilities in memory mapping of structures shared between `zenohd` and the library could lead to a `"SIGSEGV"` crash. . By default the Zenoh router is delivered or built with 2 plugins. These may be configured through a configuration file, or through individual changes to the configuration via the `--cfg` CLI option or via zenoh puts on individual parts of the configuration. . > [!WARNING] > Since `v0.6`, `zenohd` no longer loads every available plugin at startup. Instead, only configured plugins are loaded (after processing `--cfg` and `--plugin` options). Once `zenohd` is running, plugins can be hot-loaded and, if they support it, reconfigured at runtime by editing their configuration through the adminspace. . **[REST plugin](https://zenoh.io/docs/manual/plugin-http/)** (exposing a REST API): This plugin converts GET and PUT REST requests into Zenoh gets and puts respectively. . Note that to activate the REST plugin on `zenohd` the CLI argument should be passed: `--rest-http-port=8000` (or any other port of your choice). . **[Storages plugin](https://zenoh.io/docs/manual/plugin-storage-manager/)** (managing [backends and storages](https://zenoh.io/docs/manual/plugin-storage-manager/#backends-and-volumes)) This plugin allows you to easily define storages. These will store key-value pairs they subscribed to, and send the most recent ones when queried. Check out [DEFAULT_CONFIG.json5](DEFAULT_CONFIG.json5) for info on how to configure them. . ------------------------------- . ## Troubleshooting . In case of troubles, please first check on [this page](https://zenoh.io/docs/getting-started/troubleshooting/) if the trouble and cause are already known. Otherwise, you can ask a question on the [zenoh Discord server](https://discord.gg/vSDSpqnbkm), or [create an issue](https://github.com/eclipse-zenoh/zenoh/issues). Package: zenoh Version: 1.3.3 Architecture: armhf Maintainer: zenoh-dev@eclipse.org Installed-Size: 41 Depends: zenoh-plugin-rest (=1.3.3), zenoh-plugin-storage-manager (=1.3.3), zenohd (=1.3.3) Filename: 1.3.3/zenoh_1.3.3_armhf.deb Size: 17548 MD5sum: 2e07b30b4941a7434aae4c481d46161d SHA1: 03450c6eb2d554003aab5dad6048a98606994e6e SHA256: 1d5acc39653bb5d626cc7f3b27242d88ab8b8b975c7203e8ca95d299683b9c04 Section: net Priority: optional Homepage: http://zenoh.io Description: Zenoh: The Zero Overhead Pub/Sub/Query Protocol. . [![CI](https://github.com/eclipse-zenoh/zenoh/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/eclipse-zenoh/zenoh/actions?query=workflow%3ACI+branch%3Amain++) [![Documentation Status](https://readthedocs.org/projects/zenoh-rust/badge/?version=latest)](https://zenoh-rust.readthedocs.io/en/latest/?badge=latest) [![codecov](https://codecov.io/github/eclipse-zenoh/zenoh/branch/main/graph/badge.svg?token=F8T4C8WPZD)](https://codecov.io/github/eclipse-zenoh/zenoh) [![Discussion](https://img.shields.io/badge/discussion-on%20github-blue)](https://github.com/eclipse-zenoh/roadmap/discussions) [![Discord](https://img.shields.io/badge/chat-on%20discord-blue)](https://discord.gg/2GJ958VuHs) [![License](https://img.shields.io/badge/License-EPL%202.0-blue)](https://choosealicense.com/licenses/epl-2.0/) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) . # Eclipse Zenoh . The Eclipse Zenoh: Zero Overhead Pub/sub, Store/Query and Compute. . Zenoh (pronounce _/zeno/_) unifies data in motion, data at rest and computations. It carefully blends traditional pub/sub with geo-distributed storages, queries and computations, while retaining a level of time and space efficiency that is well beyond any of the mainstream stacks. . Check the website [zenoh.io](http://zenoh.io) and the [roadmap](https://github.com/eclipse-zenoh/roadmap) for more detailed information. . ------------------------------- . ## Getting Started . Zenoh is extremely easy to learn, the best place to master the fundamentals is our [getting started guide](https://zenoh.io/docs/getting-started/first-app/). . ------------------------------- . ## How to install it . To install the latest release of the Zenoh router (`zenohd`) and its default plugins (REST API plugin and Storages Manager plugin) you can do as follows: . ### Manual installation (all platforms) . All release packages can be downloaded from [https://download.eclipse.org/zenoh/zenoh/latest/](https://download.eclipse.org/zenoh/zenoh/latest/). . Each subdirectory has the name of the Rust target. See the platforms each target corresponds to on [https://doc.rust-lang.org/stable/rustc/platform-support.html](https://doc.rust-lang.org/stable/rustc/platform-support.html). . Choose your platform and download the `.zip` file. Unzip it where you want, and run the extracted `zenohd` binary. . ### Linux Debian . Add Eclipse Zenoh private repository to the sources list, and install the `zenoh` package: . ```bash echo "deb [trusted=yes] https://download.eclipse.org/zenoh/debian-repo/ /" | sudo tee -a /etc/apt/sources.list.d/zenoh.list > /dev/null sudo apt update sudo apt install zenoh ``` . Then you can start run `zenohd`. . ### MacOS . Tap our brew package repository and install the `zenoh` formula: . ```bash brew tap eclipse-zenoh/homebrew-zenoh brew install zenoh ``` . Then you can start run `zenohd`. . ------------------------------- . ## Rust API . * [Docs.rs for Zenoh](https://docs.rs/zenoh/latest/zenoh/) . ------------------------------- . ## How to build it . > [!WARNING] > Zenoh and its ecosystem are under active development. When you build from git, make sure you also build from git any other Zenoh repository you plan to use (e.g. binding, plugin, backend, etc.). It may happen that some changes in git are not compatible with the most recent packaged Zenoh release (e.g. deb, docker, pip). We put particular effort in maintaining compatibility between the various git repositories in the Zenoh project. . Install [Cargo and Rust](https://doc.rust-lang.org/cargo/getting-started/installation.html). Zenoh can be successfully compiled with Rust stable (>= 1.75.0), so no special configuration is required from your side. If you already have the Rust toolchain installed, make sure it is up-to-date with: . ```bash rustup update ``` . To build Zenoh, just type the following command after having followed the previous instructions: . ```bash cargo build --release --all-targets ``` . Zenoh's router is built as `target/release/zenohd`. All the examples are built into the `target/release/examples` directory. They can all work in peer-to-peer, or interconnected via the zenoh router. . ------------------------------- . ## Quick tests of your build . ### Peer-to-peer tests . * **pub/sub** * run: `./target/release/examples/z_sub` * in another shell run: `./target/release/examples/z_put` * the subscriber should receive the publication. . * **get/queryable** * run: `./target/release/examples/z_queryable` * in another shell run: `./target/release/examples/z_get` * the queryable should display the log in its listener, and the get should receive the queryable result. . ### Routed tests . > [!NOTE] > **Windows users**: to properly execute the commands below in PowerShell you need to escape `"` characters as `\"`. . * **put / store / get** * run the Zenoh router with a memory storage: . ```sh ./target/release/zenohd --cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/example/**",volume:"memory"}' ``` . * in another shell run: . ```sh ./target/release/examples/z_put` ``` . * then run . ```sh ./target/release/examples/z_get ``` . * the get should receive the stored publication. . * **REST API using `curl` tool** * run the Zenoh router with a memory storage: . ```sh ./target/release/zenohd --cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/example/**",volume:"memory"}' ``` . * in another shell, do a publication via the REST API: . ```sh curl -X PUT -d '"Hello World!"' http://localhost:8000/demo/example/test ``` . * get it back via the REST API: . ```sh curl http://localhost:8000/demo/example/test ``` . * **router admin space via the REST API** * run the Zenoh router with permission to perform config changes via the admin space, and with a memory storage: . ```sh ./target/release/zenohd --rest-http-port=8000 --adminspace-permissions=rw --cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/example/**",volume:"memory"}' ``` . * in another shell, get info of the zenoh router via the zenoh admin space (you may use `jq` for pretty json formatting): . ```sh curl -s http://localhost:8000/@/local/router | jq ``` . * get the volumes of the router (only memory by default): . ```sh curl -s 'http://localhost:8000/@/local/router/**/volumes/*' | jq ``` . * get the storages of the local router (the memory storage configured at startup on '/demo/example/**' should be present): . ```sh curl -s 'http://localhost:8000/@/local/router/**/storages/*' | jq ``` . * add another memory storage on `/demo/mystore/**`: . ```sh curl -X PUT -H 'content-type:application/json' -d '{"key_expr":"demo/mystore/**","volume":"memory"}' http://localhost:8000/@/local/router/config/plugins/storage_manager/storages/mystore ``` . * check it has been created: . ```sh curl -s 'http://localhost:8000/@/local/router/**/storages/*' | jq ``` . ### Configuration options . A Zenoh configuration file can be provided via CLI to all Zenoh examples and the Zenoh router. . * `-c, --config `: a [JSON5](https://json5.org) configuration file. [DEFAULT_CONFIG.json5](DEFAULT_CONFIG.json5) shows the schema of this file and the available options. . See other examples of Zenoh usage in [examples/](examples) . > [!NOTE] > **Zenoh Runtime Configuration**: Starting from version 0.11.0-rc, Zenoh allows for configuring the number of worker threads and other advanced options of the runtime. For guidance on utilizing it, please refer to the [doc](https://docs.rs/zenoh-runtime/latest/zenoh_runtime/enum.ZRuntime.html). . ------------------------------- . ## Zenoh router command line arguments . `zenohd` accepts the following arguments: . * `--adminspace-permissions <[r|w|rw|none]>`: Configure the read and/or write permissions on the admin space. Default is read only. * `-c, --config `: a [JSON5](https://json5.org) configuration file. [DEFAULT_CONFIG.json5](DEFAULT_CONFIG.json5) shows the schema of this file. All properties of this configuration are optional, so you may not need such a large configuration for your use-case. * `--cfg :`: allows you to change specific parts of the configuration right after it has been constructed. VALUE must be a valid JSON5 value, and key must be a path through the configuration file, where each element is separated by a `/`. When inserting in parts of the config that are arrays, you may use indexes, or may use `+` to indicate that you want to append your value to the array. `--cfg` passed values will always override any previously existing value for their key in the configuration. * `-l, --listen ...`: An endpoint on which this router will listen for incoming sessions. Repeat this option to open several listeners. By default, `tcp/[::]:7447` is used. The following endpoints are currently supported: * TCP: `tcp/:` * UDP: `udp/:` * [TCP+TLS](https://zenoh.io/docs/manual/tls/): `tls/:` * [QUIC](https://zenoh.io/docs/manual/quic/): `quic/:` * `-e, --connect ...`: An endpoint this router will try to connect to. Repeat this option to connect to several peers or routers. * `--no-multicast-scouting`: By default zenohd replies to multicast scouting messages for being discovered by peers and clients. This option disables this feature. * `-i, --id `: The identifier (as an hexadecimal string - e.g.: A0B23...) that zenohd must use. **WARNING**: this identifier must be unique in the system! If not set, a random unsigned 128bit integer will be used. * `--no-timestamp`: By default zenohd adds a HLC-generated Timestamp to each routed Data if there isn't already one. This option disables this feature. * `-P, --plugin [ | :]...`: A [plugin](https://zenoh.io/docs/manual/plugins/) that must be loaded. Accepted values: * a plugin name; zenohd will search for a library named `libzenoh_plugin_.so` on Unix, `libzenoh_plugin_.dylib` on MacOS or `zenoh_plugin_.dll` on Windows. * `":"`; the plugin will be loaded from library file at ``. . Repeat this option to load several plugins. * `--plugin-search-dir ...`: A directory where to search for [plugins](https://zenoh.io/docs/manual/plugins/) libraries to load. Repeat this option to specify several search directories'. By default, the plugins libraries will be searched in: `'/usr/local/lib:/usr/lib:~/.zenoh/lib:.'` * `--rest-http-port `: Configures the [REST plugin](https://zenoh.io/docs/manual/plugin-http/)'s HTTP port. Accepted values: * a port number * a string with format `:` (to bind the HTTP server to a specific interface) * `"None"` to deactivate the REST plugin . If not specified, the REST plugin will be active on any interface (`[::]`) and port `8000`. . ------------------------------- . ## Plugins . > [!WARNING] > As Rust doesn't have a stable ABI, the plugins should be built with the exact same Rust version as `zenohd`, and using for `zenoh` dependency the same version (or commit number) as `zenohd` with the same set of features. A plugin compiled with different Rust version or with different set of `zenoh` crate features will be rejected when `zenohd` attempts to load it. Otherwise, incompatibilities in memory mapping of structures shared between `zenohd` and the library could lead to a `"SIGSEGV"` crash. . By default the Zenoh router is delivered or built with 2 plugins. These may be configured through a configuration file, or through individual changes to the configuration via the `--cfg` CLI option or via zenoh puts on individual parts of the configuration. . > [!WARNING] > Since `v0.6`, `zenohd` no longer loads every available plugin at startup. Instead, only configured plugins are loaded (after processing `--cfg` and `--plugin` options). Once `zenohd` is running, plugins can be hot-loaded and, if they support it, reconfigured at runtime by editing their configuration through the adminspace. . **[REST plugin](https://zenoh.io/docs/manual/plugin-http/)** (exposing a REST API): This plugin converts GET and PUT REST requests into Zenoh gets and puts respectively. . Note that to activate the REST plugin on `zenohd` the CLI argument should be passed: `--rest-http-port=8000` (or any other port of your choice). . **[Storages plugin](https://zenoh.io/docs/manual/plugin-storage-manager/)** (managing [backends and storages](https://zenoh.io/docs/manual/plugin-storage-manager/#backends-and-volumes)) This plugin allows you to easily define storages. These will store key-value pairs they subscribed to, and send the most recent ones when queried. Check out [DEFAULT_CONFIG.json5](DEFAULT_CONFIG.json5) for info on how to configure them. . ------------------------------- . ## Troubleshooting . In case of troubles, please first check on [this page](https://zenoh.io/docs/getting-started/troubleshooting/) if the trouble and cause are already known. Otherwise, you can ask a question on the [zenoh Discord server](https://discord.gg/vSDSpqnbkm), or [create an issue](https://github.com/eclipse-zenoh/zenoh/issues). Package: zenoh Version: 1.3.3 Architecture: arm64 Maintainer: zenoh-dev@eclipse.org Installed-Size: 41 Depends: zenoh-plugin-rest (=1.3.3), zenoh-plugin-storage-manager (=1.3.3), zenohd (=1.3.3) Filename: 1.3.3/zenoh_1.3.3_arm64.deb Size: 17552 MD5sum: 290d08a0571ec4807c013e74ec2f2229 SHA1: 3a8b57a3153dc1aea5b8d1f6350e73d8aef905b1 SHA256: dfdb48f18d62543694c3dcad384820b1f8e15bda8e2292206d88174b032fa313 Section: net Priority: optional Homepage: http://zenoh.io Description: Zenoh: The Zero Overhead Pub/Sub/Query Protocol. . [![CI](https://github.com/eclipse-zenoh/zenoh/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/eclipse-zenoh/zenoh/actions?query=workflow%3ACI+branch%3Amain++) [![Documentation Status](https://readthedocs.org/projects/zenoh-rust/badge/?version=latest)](https://zenoh-rust.readthedocs.io/en/latest/?badge=latest) [![codecov](https://codecov.io/github/eclipse-zenoh/zenoh/branch/main/graph/badge.svg?token=F8T4C8WPZD)](https://codecov.io/github/eclipse-zenoh/zenoh) [![Discussion](https://img.shields.io/badge/discussion-on%20github-blue)](https://github.com/eclipse-zenoh/roadmap/discussions) [![Discord](https://img.shields.io/badge/chat-on%20discord-blue)](https://discord.gg/2GJ958VuHs) [![License](https://img.shields.io/badge/License-EPL%202.0-blue)](https://choosealicense.com/licenses/epl-2.0/) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) . # Eclipse Zenoh . The Eclipse Zenoh: Zero Overhead Pub/sub, Store/Query and Compute. . Zenoh (pronounce _/zeno/_) unifies data in motion, data at rest and computations. It carefully blends traditional pub/sub with geo-distributed storages, queries and computations, while retaining a level of time and space efficiency that is well beyond any of the mainstream stacks. . Check the website [zenoh.io](http://zenoh.io) and the [roadmap](https://github.com/eclipse-zenoh/roadmap) for more detailed information. . ------------------------------- . ## Getting Started . Zenoh is extremely easy to learn, the best place to master the fundamentals is our [getting started guide](https://zenoh.io/docs/getting-started/first-app/). . ------------------------------- . ## How to install it . To install the latest release of the Zenoh router (`zenohd`) and its default plugins (REST API plugin and Storages Manager plugin) you can do as follows: . ### Manual installation (all platforms) . All release packages can be downloaded from [https://download.eclipse.org/zenoh/zenoh/latest/](https://download.eclipse.org/zenoh/zenoh/latest/). . Each subdirectory has the name of the Rust target. See the platforms each target corresponds to on [https://doc.rust-lang.org/stable/rustc/platform-support.html](https://doc.rust-lang.org/stable/rustc/platform-support.html). . Choose your platform and download the `.zip` file. Unzip it where you want, and run the extracted `zenohd` binary. . ### Linux Debian . Add Eclipse Zenoh private repository to the sources list, and install the `zenoh` package: . ```bash echo "deb [trusted=yes] https://download.eclipse.org/zenoh/debian-repo/ /" | sudo tee -a /etc/apt/sources.list.d/zenoh.list > /dev/null sudo apt update sudo apt install zenoh ``` . Then you can start run `zenohd`. . ### MacOS . Tap our brew package repository and install the `zenoh` formula: . ```bash brew tap eclipse-zenoh/homebrew-zenoh brew install zenoh ``` . Then you can start run `zenohd`. . ------------------------------- . ## Rust API . * [Docs.rs for Zenoh](https://docs.rs/zenoh/latest/zenoh/) . ------------------------------- . ## How to build it . > [!WARNING] > Zenoh and its ecosystem are under active development. When you build from git, make sure you also build from git any other Zenoh repository you plan to use (e.g. binding, plugin, backend, etc.). It may happen that some changes in git are not compatible with the most recent packaged Zenoh release (e.g. deb, docker, pip). We put particular effort in maintaining compatibility between the various git repositories in the Zenoh project. . Install [Cargo and Rust](https://doc.rust-lang.org/cargo/getting-started/installation.html). Zenoh can be successfully compiled with Rust stable (>= 1.75.0), so no special configuration is required from your side. If you already have the Rust toolchain installed, make sure it is up-to-date with: . ```bash rustup update ``` . To build Zenoh, just type the following command after having followed the previous instructions: . ```bash cargo build --release --all-targets ``` . Zenoh's router is built as `target/release/zenohd`. All the examples are built into the `target/release/examples` directory. They can all work in peer-to-peer, or interconnected via the zenoh router. . ------------------------------- . ## Quick tests of your build . ### Peer-to-peer tests . * **pub/sub** * run: `./target/release/examples/z_sub` * in another shell run: `./target/release/examples/z_put` * the subscriber should receive the publication. . * **get/queryable** * run: `./target/release/examples/z_queryable` * in another shell run: `./target/release/examples/z_get` * the queryable should display the log in its listener, and the get should receive the queryable result. . ### Routed tests . > [!NOTE] > **Windows users**: to properly execute the commands below in PowerShell you need to escape `"` characters as `\"`. . * **put / store / get** * run the Zenoh router with a memory storage: . ```sh ./target/release/zenohd --cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/example/**",volume:"memory"}' ``` . * in another shell run: . ```sh ./target/release/examples/z_put` ``` . * then run . ```sh ./target/release/examples/z_get ``` . * the get should receive the stored publication. . * **REST API using `curl` tool** * run the Zenoh router with a memory storage: . ```sh ./target/release/zenohd --cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/example/**",volume:"memory"}' ``` . * in another shell, do a publication via the REST API: . ```sh curl -X PUT -d '"Hello World!"' http://localhost:8000/demo/example/test ``` . * get it back via the REST API: . ```sh curl http://localhost:8000/demo/example/test ``` . * **router admin space via the REST API** * run the Zenoh router with permission to perform config changes via the admin space, and with a memory storage: . ```sh ./target/release/zenohd --rest-http-port=8000 --adminspace-permissions=rw --cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/example/**",volume:"memory"}' ``` . * in another shell, get info of the zenoh router via the zenoh admin space (you may use `jq` for pretty json formatting): . ```sh curl -s http://localhost:8000/@/local/router | jq ``` . * get the volumes of the router (only memory by default): . ```sh curl -s 'http://localhost:8000/@/local/router/**/volumes/*' | jq ``` . * get the storages of the local router (the memory storage configured at startup on '/demo/example/**' should be present): . ```sh curl -s 'http://localhost:8000/@/local/router/**/storages/*' | jq ``` . * add another memory storage on `/demo/mystore/**`: . ```sh curl -X PUT -H 'content-type:application/json' -d '{"key_expr":"demo/mystore/**","volume":"memory"}' http://localhost:8000/@/local/router/config/plugins/storage_manager/storages/mystore ``` . * check it has been created: . ```sh curl -s 'http://localhost:8000/@/local/router/**/storages/*' | jq ``` . ### Configuration options . A Zenoh configuration file can be provided via CLI to all Zenoh examples and the Zenoh router. . * `-c, --config `: a [JSON5](https://json5.org) configuration file. [DEFAULT_CONFIG.json5](DEFAULT_CONFIG.json5) shows the schema of this file and the available options. . See other examples of Zenoh usage in [examples/](examples) . > [!NOTE] > **Zenoh Runtime Configuration**: Starting from version 0.11.0-rc, Zenoh allows for configuring the number of worker threads and other advanced options of the runtime. For guidance on utilizing it, please refer to the [doc](https://docs.rs/zenoh-runtime/latest/zenoh_runtime/enum.ZRuntime.html). . ------------------------------- . ## Zenoh router command line arguments . `zenohd` accepts the following arguments: . * `--adminspace-permissions <[r|w|rw|none]>`: Configure the read and/or write permissions on the admin space. Default is read only. * `-c, --config `: a [JSON5](https://json5.org) configuration file. [DEFAULT_CONFIG.json5](DEFAULT_CONFIG.json5) shows the schema of this file. All properties of this configuration are optional, so you may not need such a large configuration for your use-case. * `--cfg :`: allows you to change specific parts of the configuration right after it has been constructed. VALUE must be a valid JSON5 value, and key must be a path through the configuration file, where each element is separated by a `/`. When inserting in parts of the config that are arrays, you may use indexes, or may use `+` to indicate that you want to append your value to the array. `--cfg` passed values will always override any previously existing value for their key in the configuration. * `-l, --listen ...`: An endpoint on which this router will listen for incoming sessions. Repeat this option to open several listeners. By default, `tcp/[::]:7447` is used. The following endpoints are currently supported: * TCP: `tcp/:` * UDP: `udp/:` * [TCP+TLS](https://zenoh.io/docs/manual/tls/): `tls/:` * [QUIC](https://zenoh.io/docs/manual/quic/): `quic/:` * `-e, --connect ...`: An endpoint this router will try to connect to. Repeat this option to connect to several peers or routers. * `--no-multicast-scouting`: By default zenohd replies to multicast scouting messages for being discovered by peers and clients. This option disables this feature. * `-i, --id `: The identifier (as an hexadecimal string - e.g.: A0B23...) that zenohd must use. **WARNING**: this identifier must be unique in the system! If not set, a random unsigned 128bit integer will be used. * `--no-timestamp`: By default zenohd adds a HLC-generated Timestamp to each routed Data if there isn't already one. This option disables this feature. * `-P, --plugin [ | :]...`: A [plugin](https://zenoh.io/docs/manual/plugins/) that must be loaded. Accepted values: * a plugin name; zenohd will search for a library named `libzenoh_plugin_.so` on Unix, `libzenoh_plugin_.dylib` on MacOS or `zenoh_plugin_.dll` on Windows. * `":"`; the plugin will be loaded from library file at ``. . Repeat this option to load several plugins. * `--plugin-search-dir ...`: A directory where to search for [plugins](https://zenoh.io/docs/manual/plugins/) libraries to load. Repeat this option to specify several search directories'. By default, the plugins libraries will be searched in: `'/usr/local/lib:/usr/lib:~/.zenoh/lib:.'` * `--rest-http-port `: Configures the [REST plugin](https://zenoh.io/docs/manual/plugin-http/)'s HTTP port. Accepted values: * a port number * a string with format `:` (to bind the HTTP server to a specific interface) * `"None"` to deactivate the REST plugin . If not specified, the REST plugin will be active on any interface (`[::]`) and port `8000`. . ------------------------------- . ## Plugins . > [!WARNING] > As Rust doesn't have a stable ABI, the plugins should be built with the exact same Rust version as `zenohd`, and using for `zenoh` dependency the same version (or commit number) as `zenohd` with the same set of features. A plugin compiled with different Rust version or with different set of `zenoh` crate features will be rejected when `zenohd` attempts to load it. Otherwise, incompatibilities in memory mapping of structures shared between `zenohd` and the library could lead to a `"SIGSEGV"` crash. . By default the Zenoh router is delivered or built with 2 plugins. These may be configured through a configuration file, or through individual changes to the configuration via the `--cfg` CLI option or via zenoh puts on individual parts of the configuration. . > [!WARNING] > Since `v0.6`, `zenohd` no longer loads every available plugin at startup. Instead, only configured plugins are loaded (after processing `--cfg` and `--plugin` options). Once `zenohd` is running, plugins can be hot-loaded and, if they support it, reconfigured at runtime by editing their configuration through the adminspace. . **[REST plugin](https://zenoh.io/docs/manual/plugin-http/)** (exposing a REST API): This plugin converts GET and PUT REST requests into Zenoh gets and puts respectively. . Note that to activate the REST plugin on `zenohd` the CLI argument should be passed: `--rest-http-port=8000` (or any other port of your choice). . **[Storages plugin](https://zenoh.io/docs/manual/plugin-storage-manager/)** (managing [backends and storages](https://zenoh.io/docs/manual/plugin-storage-manager/#backends-and-volumes)) This plugin allows you to easily define storages. These will store key-value pairs they subscribed to, and send the most recent ones when queried. Check out [DEFAULT_CONFIG.json5](DEFAULT_CONFIG.json5) for info on how to configure them. . ------------------------------- . ## Troubleshooting . In case of troubles, please first check on [this page](https://zenoh.io/docs/getting-started/troubleshooting/) if the trouble and cause are already known. Otherwise, you can ask a question on the [zenoh Discord server](https://discord.gg/vSDSpqnbkm), or [create an issue](https://github.com/eclipse-zenoh/zenoh/issues). Package: zenoh-plugin-rest Version: 1.3.3 Architecture: arm64 Maintainer: zenoh-dev@eclipse.org Installed-Size: 4631 Depends: zenohd (=1.3.3) Filename: 1.3.3/zenoh-plugin-rest_1.3.3_arm64.deb Size: 1144532 MD5sum: c8804ec32fc167c8d01c68ab086363a8 SHA1: c38c5c050ad0840690fffb893479579f7e1aed00 SHA256: af75ac439dac6bea1badcc7963765801fd36ef4c9fe8fbaeb8a2a3c89d8b1f9a Section: net Priority: optional Homepage: http://zenoh.io Description: The zenoh REST plugin # ⚠️ WARNING ⚠️ . This crate is intended for Zenoh's internal use. It is not guaranteed that the API will remain unchanged in any version, including patch updates. It is highly recommended to depend solely on the zenoh and zenoh-ext crates and to utilize their public APIs. . - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh) - [Click here for Zenoh's documentation](https://zenoh.io) Package: zenoh-plugin-rest Version: 1.3.3 Architecture: armel Maintainer: zenoh-dev@eclipse.org Installed-Size: 4373 Depends: zenohd (=1.3.3) Filename: 1.3.3/zenoh-plugin-rest_1.3.3_armel.deb Size: 1181284 MD5sum: 08648a9b05f2c4e9edfc73a318dc7e4e SHA1: 50e2066422fa7a055ef044e2a875806f9dc7632a SHA256: 8b51ace45d316a17ba7267956bc3359323c21c54a0973ac941a941c221d06c38 Section: net Priority: optional Homepage: http://zenoh.io Description: The zenoh REST plugin # ⚠️ WARNING ⚠️ . This crate is intended for Zenoh's internal use. It is not guaranteed that the API will remain unchanged in any version, including patch updates. It is highly recommended to depend solely on the zenoh and zenoh-ext crates and to utilize their public APIs. . - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh) - [Click here for Zenoh's documentation](https://zenoh.io) Package: zenoh-plugin-rest Version: 1.3.3 Architecture: amd64 Maintainer: zenoh-dev@eclipse.org Installed-Size: 4598 Depends: zenohd (=1.3.3) Filename: 1.3.3/zenoh-plugin-rest_1.3.3_amd64.deb Size: 1238272 MD5sum: 0d02e6246df2e56cadfada99bb208353 SHA1: 1f809e22a859687c2d897343145cf894b6c19493 SHA256: d4581d0d9001dde8572bdf8795ef9f29e592cee9875925331bfa11ee702df161 Section: net Priority: optional Homepage: http://zenoh.io Description: The zenoh REST plugin # ⚠️ WARNING ⚠️ . This crate is intended for Zenoh's internal use. It is not guaranteed that the API will remain unchanged in any version, including patch updates. It is highly recommended to depend solely on the zenoh and zenoh-ext crates and to utilize their public APIs. . - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh) - [Click here for Zenoh's documentation](https://zenoh.io) Package: zenoh-plugin-rest Version: 1.3.3 Architecture: armhf Maintainer: zenoh-dev@eclipse.org Installed-Size: 4300 Depends: zenohd (=1.3.3) Filename: 1.3.3/zenoh-plugin-rest_1.3.3_armhf.deb Size: 1177236 MD5sum: 867c598fe38c942cdb4dc594dc078782 SHA1: cee8bfdd5905d375efc074a034cacf070003cc76 SHA256: 088579bb0a7a7f992b4c7d8edce323537f751fa46de67a11d52bd1bed59fb092 Section: net Priority: optional Homepage: http://zenoh.io Description: The zenoh REST plugin # ⚠️ WARNING ⚠️ . This crate is intended for Zenoh's internal use. It is not guaranteed that the API will remain unchanged in any version, including patch updates. It is highly recommended to depend solely on the zenoh and zenoh-ext crates and to utilize their public APIs. . - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh) - [Click here for Zenoh's documentation](https://zenoh.io) Package: zenoh-plugin-storage-manager Version: 1.3.3 Architecture: arm64 Maintainer: zenoh-dev@eclipse.org Installed-Size: 4352 Depends: zenohd (=1.3.3) Filename: 1.3.3/zenoh-plugin-storage-manager_1.3.3_arm64.deb Size: 1047152 MD5sum: 17599db47df1b86b1791a3780b142170 SHA1: c6d42aafe57f536ac782a3d5a9ba3e214055b170 SHA256: 46583cb894e183cc22c4f9b66fd8c23bd741817b2687ee3c388ff13d4ce842ef Section: net Priority: optional Homepage: http://zenoh.io Description: The zenoh storages plugin. # ⚠️ WARNING ⚠️ . This crate is intended for Zenoh's internal use. It is not guaranteed that the API will remain unchanged in any version, including patch updates. It is highly recommended to depend solely on the zenoh and zenoh-ext crates and to utilize their public APIs. . - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh) - [Click here for Zenoh's documentation](https://zenoh.io) Package: zenoh-plugin-storage-manager Version: 1.3.3 Architecture: armel Maintainer: zenoh-dev@eclipse.org Installed-Size: 4118 Depends: zenohd (=1.3.3) Filename: 1.3.3/zenoh-plugin-storage-manager_1.3.3_armel.deb Size: 1095324 MD5sum: 68494fcacd4141e678f9ea10444191ba SHA1: 0396e43c68670454abfdee2aed53e43a99b65530 SHA256: c063f7d37966ac7e2ac4e3b998643caded75005e03d1f8fa0c833f06fcc2ab3e Section: net Priority: optional Homepage: http://zenoh.io Description: The zenoh storages plugin. # ⚠️ WARNING ⚠️ . This crate is intended for Zenoh's internal use. It is not guaranteed that the API will remain unchanged in any version, including patch updates. It is highly recommended to depend solely on the zenoh and zenoh-ext crates and to utilize their public APIs. . - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh) - [Click here for Zenoh's documentation](https://zenoh.io) Package: zenoh-plugin-storage-manager Version: 1.3.3 Architecture: amd64 Maintainer: zenoh-dev@eclipse.org Installed-Size: 4336 Depends: zenohd (=1.3.3) Filename: 1.3.3/zenoh-plugin-storage-manager_1.3.3_amd64.deb Size: 1129948 MD5sum: 81781cc267fb2d03c652011b9e65d562 SHA1: 491aa0665cdf03db4f35b65fcbce67276f864bf8 SHA256: 34b263b01a1ccd7284cf29ad6e918c53a8a5c1d62a5eeba72327c4b077082b94 Section: net Priority: optional Homepage: http://zenoh.io Description: The zenoh storages plugin. # ⚠️ WARNING ⚠️ . This crate is intended for Zenoh's internal use. It is not guaranteed that the API will remain unchanged in any version, including patch updates. It is highly recommended to depend solely on the zenoh and zenoh-ext crates and to utilize their public APIs. . - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh) - [Click here for Zenoh's documentation](https://zenoh.io) Package: zenoh-plugin-storage-manager Version: 1.3.3 Architecture: armhf Maintainer: zenoh-dev@eclipse.org Installed-Size: 4030 Depends: zenohd (=1.3.3) Filename: 1.3.3/zenoh-plugin-storage-manager_1.3.3_armhf.deb Size: 1089820 MD5sum: 1d1bc8792e158c5b99620284d4dc411d SHA1: 72b8a817f3bdebcd54c0347d4fae8a436b928e70 SHA256: bc9510e31e9d7a413392c97162bef771054d0ce41f15384117fea0f476e0fb65 Section: net Priority: optional Homepage: http://zenoh.io Description: The zenoh storages plugin. # ⚠️ WARNING ⚠️ . This crate is intended for Zenoh's internal use. It is not guaranteed that the API will remain unchanged in any version, including patch updates. It is highly recommended to depend solely on the zenoh and zenoh-ext crates and to utilize their public APIs. . - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh) - [Click here for Zenoh's documentation](https://zenoh.io) Package: zenohd Version: 1.3.3 Architecture: armel Maintainer: zenoh-dev@eclipse.org Installed-Size: 13113 Filename: 1.3.3/zenohd_1.3.3_armel.deb Size: 3583476 MD5sum: 6baa64b1c09b95d4658fccee1ceddb2a SHA1: bb9b71cbcc510eda23cfa37c00cf31d2c3beef48 SHA256: c7d66b1c83d94df519718834c9f5ce633df3fb76f1e5b283829d6566a9442564 Section: net Priority: optional Homepage: http://zenoh.io Description: Zenoh: The Zero Overhead Pub/Sub/Query Protocol. . [![CI](https://github.com/eclipse-zenoh/zenoh/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/eclipse-zenoh/zenoh/actions?query=workflow%3ACI+branch%3Amain++) [![Documentation Status](https://readthedocs.org/projects/zenoh-rust/badge/?version=latest)](https://zenoh-rust.readthedocs.io/en/latest/?badge=latest) [![codecov](https://codecov.io/github/eclipse-zenoh/zenoh/branch/main/graph/badge.svg?token=F8T4C8WPZD)](https://codecov.io/github/eclipse-zenoh/zenoh) [![Discussion](https://img.shields.io/badge/discussion-on%20github-blue)](https://github.com/eclipse-zenoh/roadmap/discussions) [![Discord](https://img.shields.io/badge/chat-on%20discord-blue)](https://discord.gg/2GJ958VuHs) [![License](https://img.shields.io/badge/License-EPL%202.0-blue)](https://choosealicense.com/licenses/epl-2.0/) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) . # Eclipse Zenoh . The Eclipse Zenoh: Zero Overhead Pub/sub, Store/Query and Compute. . Zenoh (pronounce _/zeno/_) unifies data in motion, data at rest and computations. It carefully blends traditional pub/sub with geo-distributed storages, queries and computations, while retaining a level of time and space efficiency that is well beyond any of the mainstream stacks. . Check the website [zenoh.io](http://zenoh.io) and the [roadmap](https://github.com/eclipse-zenoh/roadmap) for more detailed information. . ------------------------------- . ## Getting Started . Zenoh is extremely easy to learn, the best place to master the fundamentals is our [getting started guide](https://zenoh.io/docs/getting-started/first-app/). . ------------------------------- . ## How to install it . To install the latest release of the Zenoh router (`zenohd`) and its default plugins (REST API plugin and Storages Manager plugin) you can do as follows: . ### Manual installation (all platforms) . All release packages can be downloaded from [https://download.eclipse.org/zenoh/zenoh/latest/](https://download.eclipse.org/zenoh/zenoh/latest/). . Each subdirectory has the name of the Rust target. See the platforms each target corresponds to on [https://doc.rust-lang.org/stable/rustc/platform-support.html](https://doc.rust-lang.org/stable/rustc/platform-support.html). . Choose your platform and download the `.zip` file. Unzip it where you want, and run the extracted `zenohd` binary. . ### Linux Debian . Add Eclipse Zenoh private repository to the sources list, and install the `zenoh` package: . ```bash echo "deb [trusted=yes] https://download.eclipse.org/zenoh/debian-repo/ /" | sudo tee -a /etc/apt/sources.list.d/zenoh.list > /dev/null sudo apt update sudo apt install zenoh ``` . Then you can start run `zenohd`. . ### MacOS . Tap our brew package repository and install the `zenoh` formula: . ```bash brew tap eclipse-zenoh/homebrew-zenoh brew install zenoh ``` . Then you can start run `zenohd`. . ------------------------------- . ## Rust API . * [Docs.rs for Zenoh](https://docs.rs/zenoh/latest/zenoh/) . ------------------------------- . ## How to build it . > [!WARNING] > Zenoh and its ecosystem are under active development. When you build from git, make sure you also build from git any other Zenoh repository you plan to use (e.g. binding, plugin, backend, etc.). It may happen that some changes in git are not compatible with the most recent packaged Zenoh release (e.g. deb, docker, pip). We put particular effort in maintaining compatibility between the various git repositories in the Zenoh project. . Install [Cargo and Rust](https://doc.rust-lang.org/cargo/getting-started/installation.html). Zenoh can be successfully compiled with Rust stable (>= 1.75.0), so no special configuration is required from your side. If you already have the Rust toolchain installed, make sure it is up-to-date with: . ```bash rustup update ``` . To build Zenoh, just type the following command after having followed the previous instructions: . ```bash cargo build --release --all-targets ``` . Zenoh's router is built as `target/release/zenohd`. All the examples are built into the `target/release/examples` directory. They can all work in peer-to-peer, or interconnected via the zenoh router. . ------------------------------- . ## Quick tests of your build . ### Peer-to-peer tests . * **pub/sub** * run: `./target/release/examples/z_sub` * in another shell run: `./target/release/examples/z_put` * the subscriber should receive the publication. . * **get/queryable** * run: `./target/release/examples/z_queryable` * in another shell run: `./target/release/examples/z_get` * the queryable should display the log in its listener, and the get should receive the queryable result. . ### Routed tests . > [!NOTE] > **Windows users**: to properly execute the commands below in PowerShell you need to escape `"` characters as `\"`. . * **put / store / get** * run the Zenoh router with a memory storage: . ```sh ./target/release/zenohd --cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/example/**",volume:"memory"}' ``` . * in another shell run: . ```sh ./target/release/examples/z_put` ``` . * then run . ```sh ./target/release/examples/z_get ``` . * the get should receive the stored publication. . * **REST API using `curl` tool** * run the Zenoh router with a memory storage: . ```sh ./target/release/zenohd --cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/example/**",volume:"memory"}' ``` . * in another shell, do a publication via the REST API: . ```sh curl -X PUT -d '"Hello World!"' http://localhost:8000/demo/example/test ``` . * get it back via the REST API: . ```sh curl http://localhost:8000/demo/example/test ``` . * **router admin space via the REST API** * run the Zenoh router with permission to perform config changes via the admin space, and with a memory storage: . ```sh ./target/release/zenohd --rest-http-port=8000 --adminspace-permissions=rw --cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/example/**",volume:"memory"}' ``` . * in another shell, get info of the zenoh router via the zenoh admin space (you may use `jq` for pretty json formatting): . ```sh curl -s http://localhost:8000/@/local/router | jq ``` . * get the volumes of the router (only memory by default): . ```sh curl -s 'http://localhost:8000/@/local/router/**/volumes/*' | jq ``` . * get the storages of the local router (the memory storage configured at startup on '/demo/example/**' should be present): . ```sh curl -s 'http://localhost:8000/@/local/router/**/storages/*' | jq ``` . * add another memory storage on `/demo/mystore/**`: . ```sh curl -X PUT -H 'content-type:application/json' -d '{"key_expr":"demo/mystore/**","volume":"memory"}' http://localhost:8000/@/local/router/config/plugins/storage_manager/storages/mystore ``` . * check it has been created: . ```sh curl -s 'http://localhost:8000/@/local/router/**/storages/*' | jq ``` . ### Configuration options . A Zenoh configuration file can be provided via CLI to all Zenoh examples and the Zenoh router. . * `-c, --config `: a [JSON5](https://json5.org) configuration file. [DEFAULT_CONFIG.json5](DEFAULT_CONFIG.json5) shows the schema of this file and the available options. . See other examples of Zenoh usage in [examples/](examples) . > [!NOTE] > **Zenoh Runtime Configuration**: Starting from version 0.11.0-rc, Zenoh allows for configuring the number of worker threads and other advanced options of the runtime. For guidance on utilizing it, please refer to the [doc](https://docs.rs/zenoh-runtime/latest/zenoh_runtime/enum.ZRuntime.html). . ------------------------------- . ## Zenoh router command line arguments . `zenohd` accepts the following arguments: . * `--adminspace-permissions <[r|w|rw|none]>`: Configure the read and/or write permissions on the admin space. Default is read only. * `-c, --config `: a [JSON5](https://json5.org) configuration file. [DEFAULT_CONFIG.json5](DEFAULT_CONFIG.json5) shows the schema of this file. All properties of this configuration are optional, so you may not need such a large configuration for your use-case. * `--cfg :`: allows you to change specific parts of the configuration right after it has been constructed. VALUE must be a valid JSON5 value, and key must be a path through the configuration file, where each element is separated by a `/`. When inserting in parts of the config that are arrays, you may use indexes, or may use `+` to indicate that you want to append your value to the array. `--cfg` passed values will always override any previously existing value for their key in the configuration. * `-l, --listen ...`: An endpoint on which this router will listen for incoming sessions. Repeat this option to open several listeners. By default, `tcp/[::]:7447` is used. The following endpoints are currently supported: * TCP: `tcp/:` * UDP: `udp/:` * [TCP+TLS](https://zenoh.io/docs/manual/tls/): `tls/:` * [QUIC](https://zenoh.io/docs/manual/quic/): `quic/:` * `-e, --connect ...`: An endpoint this router will try to connect to. Repeat this option to connect to several peers or routers. * `--no-multicast-scouting`: By default zenohd replies to multicast scouting messages for being discovered by peers and clients. This option disables this feature. * `-i, --id `: The identifier (as an hexadecimal string - e.g.: A0B23...) that zenohd must use. **WARNING**: this identifier must be unique in the system! If not set, a random unsigned 128bit integer will be used. * `--no-timestamp`: By default zenohd adds a HLC-generated Timestamp to each routed Data if there isn't already one. This option disables this feature. * `-P, --plugin [ | :]...`: A [plugin](https://zenoh.io/docs/manual/plugins/) that must be loaded. Accepted values: * a plugin name; zenohd will search for a library named `libzenoh_plugin_.so` on Unix, `libzenoh_plugin_.dylib` on MacOS or `zenoh_plugin_.dll` on Windows. * `":"`; the plugin will be loaded from library file at ``. . Repeat this option to load several plugins. * `--plugin-search-dir ...`: A directory where to search for [plugins](https://zenoh.io/docs/manual/plugins/) libraries to load. Repeat this option to specify several search directories'. By default, the plugins libraries will be searched in: `'/usr/local/lib:/usr/lib:~/.zenoh/lib:.'` * `--rest-http-port `: Configures the [REST plugin](https://zenoh.io/docs/manual/plugin-http/)'s HTTP port. Accepted values: * a port number * a string with format `:` (to bind the HTTP server to a specific interface) * `"None"` to deactivate the REST plugin . If not specified, the REST plugin will be active on any interface (`[::]`) and port `8000`. . ------------------------------- . ## Plugins . > [!WARNING] > As Rust doesn't have a stable ABI, the plugins should be built with the exact same Rust version as `zenohd`, and using for `zenoh` dependency the same version (or commit number) as `zenohd` with the same set of features. A plugin compiled with different Rust version or with different set of `zenoh` crate features will be rejected when `zenohd` attempts to load it. Otherwise, incompatibilities in memory mapping of structures shared between `zenohd` and the library could lead to a `"SIGSEGV"` crash. . By default the Zenoh router is delivered or built with 2 plugins. These may be configured through a configuration file, or through individual changes to the configuration via the `--cfg` CLI option or via zenoh puts on individual parts of the configuration. . > [!WARNING] > Since `v0.6`, `zenohd` no longer loads every available plugin at startup. Instead, only configured plugins are loaded (after processing `--cfg` and `--plugin` options). Once `zenohd` is running, plugins can be hot-loaded and, if they support it, reconfigured at runtime by editing their configuration through the adminspace. . **[REST plugin](https://zenoh.io/docs/manual/plugin-http/)** (exposing a REST API): This plugin converts GET and PUT REST requests into Zenoh gets and puts respectively. . Note that to activate the REST plugin on `zenohd` the CLI argument should be passed: `--rest-http-port=8000` (or any other port of your choice). . **[Storages plugin](https://zenoh.io/docs/manual/plugin-storage-manager/)** (managing [backends and storages](https://zenoh.io/docs/manual/plugin-storage-manager/#backends-and-volumes)) This plugin allows you to easily define storages. These will store key-value pairs they subscribed to, and send the most recent ones when queried. Check out [DEFAULT_CONFIG.json5](DEFAULT_CONFIG.json5) for info on how to configure them. . ------------------------------- . ## Troubleshooting . In case of troubles, please first check on [this page](https://zenoh.io/docs/getting-started/troubleshooting/) if the trouble and cause are already known. Otherwise, you can ask a question on the [zenoh Discord server](https://discord.gg/vSDSpqnbkm), or [create an issue](https://github.com/eclipse-zenoh/zenoh/issues). Package: zenohd Version: 1.3.3 Architecture: arm64 Maintainer: zenoh-dev@eclipse.org Installed-Size: 12465 Filename: 1.3.3/zenohd_1.3.3_arm64.deb Size: 3420544 MD5sum: 06456b0206f81e53a421e24963bc215b SHA1: 40d98f7a9456b76e04d7702fa26f8d7c380258d1 SHA256: 7de4f4cf0aec4590e7a95d1d21c20844b9655e0334a9375663180b5cd323df0e Section: net Priority: optional Homepage: http://zenoh.io Description: Zenoh: The Zero Overhead Pub/Sub/Query Protocol. . [![CI](https://github.com/eclipse-zenoh/zenoh/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/eclipse-zenoh/zenoh/actions?query=workflow%3ACI+branch%3Amain++) [![Documentation Status](https://readthedocs.org/projects/zenoh-rust/badge/?version=latest)](https://zenoh-rust.readthedocs.io/en/latest/?badge=latest) [![codecov](https://codecov.io/github/eclipse-zenoh/zenoh/branch/main/graph/badge.svg?token=F8T4C8WPZD)](https://codecov.io/github/eclipse-zenoh/zenoh) [![Discussion](https://img.shields.io/badge/discussion-on%20github-blue)](https://github.com/eclipse-zenoh/roadmap/discussions) [![Discord](https://img.shields.io/badge/chat-on%20discord-blue)](https://discord.gg/2GJ958VuHs) [![License](https://img.shields.io/badge/License-EPL%202.0-blue)](https://choosealicense.com/licenses/epl-2.0/) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) . # Eclipse Zenoh . The Eclipse Zenoh: Zero Overhead Pub/sub, Store/Query and Compute. . Zenoh (pronounce _/zeno/_) unifies data in motion, data at rest and computations. It carefully blends traditional pub/sub with geo-distributed storages, queries and computations, while retaining a level of time and space efficiency that is well beyond any of the mainstream stacks. . Check the website [zenoh.io](http://zenoh.io) and the [roadmap](https://github.com/eclipse-zenoh/roadmap) for more detailed information. . ------------------------------- . ## Getting Started . Zenoh is extremely easy to learn, the best place to master the fundamentals is our [getting started guide](https://zenoh.io/docs/getting-started/first-app/). . ------------------------------- . ## How to install it . To install the latest release of the Zenoh router (`zenohd`) and its default plugins (REST API plugin and Storages Manager plugin) you can do as follows: . ### Manual installation (all platforms) . All release packages can be downloaded from [https://download.eclipse.org/zenoh/zenoh/latest/](https://download.eclipse.org/zenoh/zenoh/latest/). . Each subdirectory has the name of the Rust target. See the platforms each target corresponds to on [https://doc.rust-lang.org/stable/rustc/platform-support.html](https://doc.rust-lang.org/stable/rustc/platform-support.html). . Choose your platform and download the `.zip` file. Unzip it where you want, and run the extracted `zenohd` binary. . ### Linux Debian . Add Eclipse Zenoh private repository to the sources list, and install the `zenoh` package: . ```bash echo "deb [trusted=yes] https://download.eclipse.org/zenoh/debian-repo/ /" | sudo tee -a /etc/apt/sources.list.d/zenoh.list > /dev/null sudo apt update sudo apt install zenoh ``` . Then you can start run `zenohd`. . ### MacOS . Tap our brew package repository and install the `zenoh` formula: . ```bash brew tap eclipse-zenoh/homebrew-zenoh brew install zenoh ``` . Then you can start run `zenohd`. . ------------------------------- . ## Rust API . * [Docs.rs for Zenoh](https://docs.rs/zenoh/latest/zenoh/) . ------------------------------- . ## How to build it . > [!WARNING] > Zenoh and its ecosystem are under active development. When you build from git, make sure you also build from git any other Zenoh repository you plan to use (e.g. binding, plugin, backend, etc.). It may happen that some changes in git are not compatible with the most recent packaged Zenoh release (e.g. deb, docker, pip). We put particular effort in maintaining compatibility between the various git repositories in the Zenoh project. . Install [Cargo and Rust](https://doc.rust-lang.org/cargo/getting-started/installation.html). Zenoh can be successfully compiled with Rust stable (>= 1.75.0), so no special configuration is required from your side. If you already have the Rust toolchain installed, make sure it is up-to-date with: . ```bash rustup update ``` . To build Zenoh, just type the following command after having followed the previous instructions: . ```bash cargo build --release --all-targets ``` . Zenoh's router is built as `target/release/zenohd`. All the examples are built into the `target/release/examples` directory. They can all work in peer-to-peer, or interconnected via the zenoh router. . ------------------------------- . ## Quick tests of your build . ### Peer-to-peer tests . * **pub/sub** * run: `./target/release/examples/z_sub` * in another shell run: `./target/release/examples/z_put` * the subscriber should receive the publication. . * **get/queryable** * run: `./target/release/examples/z_queryable` * in another shell run: `./target/release/examples/z_get` * the queryable should display the log in its listener, and the get should receive the queryable result. . ### Routed tests . > [!NOTE] > **Windows users**: to properly execute the commands below in PowerShell you need to escape `"` characters as `\"`. . * **put / store / get** * run the Zenoh router with a memory storage: . ```sh ./target/release/zenohd --cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/example/**",volume:"memory"}' ``` . * in another shell run: . ```sh ./target/release/examples/z_put` ``` . * then run . ```sh ./target/release/examples/z_get ``` . * the get should receive the stored publication. . * **REST API using `curl` tool** * run the Zenoh router with a memory storage: . ```sh ./target/release/zenohd --cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/example/**",volume:"memory"}' ``` . * in another shell, do a publication via the REST API: . ```sh curl -X PUT -d '"Hello World!"' http://localhost:8000/demo/example/test ``` . * get it back via the REST API: . ```sh curl http://localhost:8000/demo/example/test ``` . * **router admin space via the REST API** * run the Zenoh router with permission to perform config changes via the admin space, and with a memory storage: . ```sh ./target/release/zenohd --rest-http-port=8000 --adminspace-permissions=rw --cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/example/**",volume:"memory"}' ``` . * in another shell, get info of the zenoh router via the zenoh admin space (you may use `jq` for pretty json formatting): . ```sh curl -s http://localhost:8000/@/local/router | jq ``` . * get the volumes of the router (only memory by default): . ```sh curl -s 'http://localhost:8000/@/local/router/**/volumes/*' | jq ``` . * get the storages of the local router (the memory storage configured at startup on '/demo/example/**' should be present): . ```sh curl -s 'http://localhost:8000/@/local/router/**/storages/*' | jq ``` . * add another memory storage on `/demo/mystore/**`: . ```sh curl -X PUT -H 'content-type:application/json' -d '{"key_expr":"demo/mystore/**","volume":"memory"}' http://localhost:8000/@/local/router/config/plugins/storage_manager/storages/mystore ``` . * check it has been created: . ```sh curl -s 'http://localhost:8000/@/local/router/**/storages/*' | jq ``` . ### Configuration options . A Zenoh configuration file can be provided via CLI to all Zenoh examples and the Zenoh router. . * `-c, --config `: a [JSON5](https://json5.org) configuration file. [DEFAULT_CONFIG.json5](DEFAULT_CONFIG.json5) shows the schema of this file and the available options. . See other examples of Zenoh usage in [examples/](examples) . > [!NOTE] > **Zenoh Runtime Configuration**: Starting from version 0.11.0-rc, Zenoh allows for configuring the number of worker threads and other advanced options of the runtime. For guidance on utilizing it, please refer to the [doc](https://docs.rs/zenoh-runtime/latest/zenoh_runtime/enum.ZRuntime.html). . ------------------------------- . ## Zenoh router command line arguments . `zenohd` accepts the following arguments: . * `--adminspace-permissions <[r|w|rw|none]>`: Configure the read and/or write permissions on the admin space. Default is read only. * `-c, --config `: a [JSON5](https://json5.org) configuration file. [DEFAULT_CONFIG.json5](DEFAULT_CONFIG.json5) shows the schema of this file. All properties of this configuration are optional, so you may not need such a large configuration for your use-case. * `--cfg :`: allows you to change specific parts of the configuration right after it has been constructed. VALUE must be a valid JSON5 value, and key must be a path through the configuration file, where each element is separated by a `/`. When inserting in parts of the config that are arrays, you may use indexes, or may use `+` to indicate that you want to append your value to the array. `--cfg` passed values will always override any previously existing value for their key in the configuration. * `-l, --listen ...`: An endpoint on which this router will listen for incoming sessions. Repeat this option to open several listeners. By default, `tcp/[::]:7447` is used. The following endpoints are currently supported: * TCP: `tcp/:` * UDP: `udp/:` * [TCP+TLS](https://zenoh.io/docs/manual/tls/): `tls/:` * [QUIC](https://zenoh.io/docs/manual/quic/): `quic/:` * `-e, --connect ...`: An endpoint this router will try to connect to. Repeat this option to connect to several peers or routers. * `--no-multicast-scouting`: By default zenohd replies to multicast scouting messages for being discovered by peers and clients. This option disables this feature. * `-i, --id `: The identifier (as an hexadecimal string - e.g.: A0B23...) that zenohd must use. **WARNING**: this identifier must be unique in the system! If not set, a random unsigned 128bit integer will be used. * `--no-timestamp`: By default zenohd adds a HLC-generated Timestamp to each routed Data if there isn't already one. This option disables this feature. * `-P, --plugin [ | :]...`: A [plugin](https://zenoh.io/docs/manual/plugins/) that must be loaded. Accepted values: * a plugin name; zenohd will search for a library named `libzenoh_plugin_.so` on Unix, `libzenoh_plugin_.dylib` on MacOS or `zenoh_plugin_.dll` on Windows. * `":"`; the plugin will be loaded from library file at ``. . Repeat this option to load several plugins. * `--plugin-search-dir ...`: A directory where to search for [plugins](https://zenoh.io/docs/manual/plugins/) libraries to load. Repeat this option to specify several search directories'. By default, the plugins libraries will be searched in: `'/usr/local/lib:/usr/lib:~/.zenoh/lib:.'` * `--rest-http-port `: Configures the [REST plugin](https://zenoh.io/docs/manual/plugin-http/)'s HTTP port. Accepted values: * a port number * a string with format `:` (to bind the HTTP server to a specific interface) * `"None"` to deactivate the REST plugin . If not specified, the REST plugin will be active on any interface (`[::]`) and port `8000`. . ------------------------------- . ## Plugins . > [!WARNING] > As Rust doesn't have a stable ABI, the plugins should be built with the exact same Rust version as `zenohd`, and using for `zenoh` dependency the same version (or commit number) as `zenohd` with the same set of features. A plugin compiled with different Rust version or with different set of `zenoh` crate features will be rejected when `zenohd` attempts to load it. Otherwise, incompatibilities in memory mapping of structures shared between `zenohd` and the library could lead to a `"SIGSEGV"` crash. . By default the Zenoh router is delivered or built with 2 plugins. These may be configured through a configuration file, or through individual changes to the configuration via the `--cfg` CLI option or via zenoh puts on individual parts of the configuration. . > [!WARNING] > Since `v0.6`, `zenohd` no longer loads every available plugin at startup. Instead, only configured plugins are loaded (after processing `--cfg` and `--plugin` options). Once `zenohd` is running, plugins can be hot-loaded and, if they support it, reconfigured at runtime by editing their configuration through the adminspace. . **[REST plugin](https://zenoh.io/docs/manual/plugin-http/)** (exposing a REST API): This plugin converts GET and PUT REST requests into Zenoh gets and puts respectively. . Note that to activate the REST plugin on `zenohd` the CLI argument should be passed: `--rest-http-port=8000` (or any other port of your choice). . **[Storages plugin](https://zenoh.io/docs/manual/plugin-storage-manager/)** (managing [backends and storages](https://zenoh.io/docs/manual/plugin-storage-manager/#backends-and-volumes)) This plugin allows you to easily define storages. These will store key-value pairs they subscribed to, and send the most recent ones when queried. Check out [DEFAULT_CONFIG.json5](DEFAULT_CONFIG.json5) for info on how to configure them. . ------------------------------- . ## Troubleshooting . In case of troubles, please first check on [this page](https://zenoh.io/docs/getting-started/troubleshooting/) if the trouble and cause are already known. Otherwise, you can ask a question on the [zenoh Discord server](https://discord.gg/vSDSpqnbkm), or [create an issue](https://github.com/eclipse-zenoh/zenoh/issues). Package: zenohd Version: 1.3.3 Architecture: armhf Maintainer: zenoh-dev@eclipse.org Installed-Size: 12840 Filename: 1.3.3/zenohd_1.3.3_armhf.deb Size: 3601776 MD5sum: 32a372d16934c4c67a796a411c184f76 SHA1: 772646f2c5349734881a2928ce210d7afc72872d SHA256: d78536d3395771e494ec03da49c0f6b6ca4377312d271b8a93adf311b268ec9d Section: net Priority: optional Homepage: http://zenoh.io Description: Zenoh: The Zero Overhead Pub/Sub/Query Protocol. . [![CI](https://github.com/eclipse-zenoh/zenoh/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/eclipse-zenoh/zenoh/actions?query=workflow%3ACI+branch%3Amain++) [![Documentation Status](https://readthedocs.org/projects/zenoh-rust/badge/?version=latest)](https://zenoh-rust.readthedocs.io/en/latest/?badge=latest) [![codecov](https://codecov.io/github/eclipse-zenoh/zenoh/branch/main/graph/badge.svg?token=F8T4C8WPZD)](https://codecov.io/github/eclipse-zenoh/zenoh) [![Discussion](https://img.shields.io/badge/discussion-on%20github-blue)](https://github.com/eclipse-zenoh/roadmap/discussions) [![Discord](https://img.shields.io/badge/chat-on%20discord-blue)](https://discord.gg/2GJ958VuHs) [![License](https://img.shields.io/badge/License-EPL%202.0-blue)](https://choosealicense.com/licenses/epl-2.0/) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) . # Eclipse Zenoh . The Eclipse Zenoh: Zero Overhead Pub/sub, Store/Query and Compute. . Zenoh (pronounce _/zeno/_) unifies data in motion, data at rest and computations. It carefully blends traditional pub/sub with geo-distributed storages, queries and computations, while retaining a level of time and space efficiency that is well beyond any of the mainstream stacks. . Check the website [zenoh.io](http://zenoh.io) and the [roadmap](https://github.com/eclipse-zenoh/roadmap) for more detailed information. . ------------------------------- . ## Getting Started . Zenoh is extremely easy to learn, the best place to master the fundamentals is our [getting started guide](https://zenoh.io/docs/getting-started/first-app/). . ------------------------------- . ## How to install it . To install the latest release of the Zenoh router (`zenohd`) and its default plugins (REST API plugin and Storages Manager plugin) you can do as follows: . ### Manual installation (all platforms) . All release packages can be downloaded from [https://download.eclipse.org/zenoh/zenoh/latest/](https://download.eclipse.org/zenoh/zenoh/latest/). . Each subdirectory has the name of the Rust target. See the platforms each target corresponds to on [https://doc.rust-lang.org/stable/rustc/platform-support.html](https://doc.rust-lang.org/stable/rustc/platform-support.html). . Choose your platform and download the `.zip` file. Unzip it where you want, and run the extracted `zenohd` binary. . ### Linux Debian . Add Eclipse Zenoh private repository to the sources list, and install the `zenoh` package: . ```bash echo "deb [trusted=yes] https://download.eclipse.org/zenoh/debian-repo/ /" | sudo tee -a /etc/apt/sources.list.d/zenoh.list > /dev/null sudo apt update sudo apt install zenoh ``` . Then you can start run `zenohd`. . ### MacOS . Tap our brew package repository and install the `zenoh` formula: . ```bash brew tap eclipse-zenoh/homebrew-zenoh brew install zenoh ``` . Then you can start run `zenohd`. . ------------------------------- . ## Rust API . * [Docs.rs for Zenoh](https://docs.rs/zenoh/latest/zenoh/) . ------------------------------- . ## How to build it . > [!WARNING] > Zenoh and its ecosystem are under active development. When you build from git, make sure you also build from git any other Zenoh repository you plan to use (e.g. binding, plugin, backend, etc.). It may happen that some changes in git are not compatible with the most recent packaged Zenoh release (e.g. deb, docker, pip). We put particular effort in maintaining compatibility between the various git repositories in the Zenoh project. . Install [Cargo and Rust](https://doc.rust-lang.org/cargo/getting-started/installation.html). Zenoh can be successfully compiled with Rust stable (>= 1.75.0), so no special configuration is required from your side. If you already have the Rust toolchain installed, make sure it is up-to-date with: . ```bash rustup update ``` . To build Zenoh, just type the following command after having followed the previous instructions: . ```bash cargo build --release --all-targets ``` . Zenoh's router is built as `target/release/zenohd`. All the examples are built into the `target/release/examples` directory. They can all work in peer-to-peer, or interconnected via the zenoh router. . ------------------------------- . ## Quick tests of your build . ### Peer-to-peer tests . * **pub/sub** * run: `./target/release/examples/z_sub` * in another shell run: `./target/release/examples/z_put` * the subscriber should receive the publication. . * **get/queryable** * run: `./target/release/examples/z_queryable` * in another shell run: `./target/release/examples/z_get` * the queryable should display the log in its listener, and the get should receive the queryable result. . ### Routed tests . > [!NOTE] > **Windows users**: to properly execute the commands below in PowerShell you need to escape `"` characters as `\"`. . * **put / store / get** * run the Zenoh router with a memory storage: . ```sh ./target/release/zenohd --cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/example/**",volume:"memory"}' ``` . * in another shell run: . ```sh ./target/release/examples/z_put` ``` . * then run . ```sh ./target/release/examples/z_get ``` . * the get should receive the stored publication. . * **REST API using `curl` tool** * run the Zenoh router with a memory storage: . ```sh ./target/release/zenohd --cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/example/**",volume:"memory"}' ``` . * in another shell, do a publication via the REST API: . ```sh curl -X PUT -d '"Hello World!"' http://localhost:8000/demo/example/test ``` . * get it back via the REST API: . ```sh curl http://localhost:8000/demo/example/test ``` . * **router admin space via the REST API** * run the Zenoh router with permission to perform config changes via the admin space, and with a memory storage: . ```sh ./target/release/zenohd --rest-http-port=8000 --adminspace-permissions=rw --cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/example/**",volume:"memory"}' ``` . * in another shell, get info of the zenoh router via the zenoh admin space (you may use `jq` for pretty json formatting): . ```sh curl -s http://localhost:8000/@/local/router | jq ``` . * get the volumes of the router (only memory by default): . ```sh curl -s 'http://localhost:8000/@/local/router/**/volumes/*' | jq ``` . * get the storages of the local router (the memory storage configured at startup on '/demo/example/**' should be present): . ```sh curl -s 'http://localhost:8000/@/local/router/**/storages/*' | jq ``` . * add another memory storage on `/demo/mystore/**`: . ```sh curl -X PUT -H 'content-type:application/json' -d '{"key_expr":"demo/mystore/**","volume":"memory"}' http://localhost:8000/@/local/router/config/plugins/storage_manager/storages/mystore ``` . * check it has been created: . ```sh curl -s 'http://localhost:8000/@/local/router/**/storages/*' | jq ``` . ### Configuration options . A Zenoh configuration file can be provided via CLI to all Zenoh examples and the Zenoh router. . * `-c, --config `: a [JSON5](https://json5.org) configuration file. [DEFAULT_CONFIG.json5](DEFAULT_CONFIG.json5) shows the schema of this file and the available options. . See other examples of Zenoh usage in [examples/](examples) . > [!NOTE] > **Zenoh Runtime Configuration**: Starting from version 0.11.0-rc, Zenoh allows for configuring the number of worker threads and other advanced options of the runtime. For guidance on utilizing it, please refer to the [doc](https://docs.rs/zenoh-runtime/latest/zenoh_runtime/enum.ZRuntime.html). . ------------------------------- . ## Zenoh router command line arguments . `zenohd` accepts the following arguments: . * `--adminspace-permissions <[r|w|rw|none]>`: Configure the read and/or write permissions on the admin space. Default is read only. * `-c, --config `: a [JSON5](https://json5.org) configuration file. [DEFAULT_CONFIG.json5](DEFAULT_CONFIG.json5) shows the schema of this file. All properties of this configuration are optional, so you may not need such a large configuration for your use-case. * `--cfg :`: allows you to change specific parts of the configuration right after it has been constructed. VALUE must be a valid JSON5 value, and key must be a path through the configuration file, where each element is separated by a `/`. When inserting in parts of the config that are arrays, you may use indexes, or may use `+` to indicate that you want to append your value to the array. `--cfg` passed values will always override any previously existing value for their key in the configuration. * `-l, --listen ...`: An endpoint on which this router will listen for incoming sessions. Repeat this option to open several listeners. By default, `tcp/[::]:7447` is used. The following endpoints are currently supported: * TCP: `tcp/:` * UDP: `udp/:` * [TCP+TLS](https://zenoh.io/docs/manual/tls/): `tls/:` * [QUIC](https://zenoh.io/docs/manual/quic/): `quic/:` * `-e, --connect ...`: An endpoint this router will try to connect to. Repeat this option to connect to several peers or routers. * `--no-multicast-scouting`: By default zenohd replies to multicast scouting messages for being discovered by peers and clients. This option disables this feature. * `-i, --id `: The identifier (as an hexadecimal string - e.g.: A0B23...) that zenohd must use. **WARNING**: this identifier must be unique in the system! If not set, a random unsigned 128bit integer will be used. * `--no-timestamp`: By default zenohd adds a HLC-generated Timestamp to each routed Data if there isn't already one. This option disables this feature. * `-P, --plugin [ | :]...`: A [plugin](https://zenoh.io/docs/manual/plugins/) that must be loaded. Accepted values: * a plugin name; zenohd will search for a library named `libzenoh_plugin_.so` on Unix, `libzenoh_plugin_.dylib` on MacOS or `zenoh_plugin_.dll` on Windows. * `":"`; the plugin will be loaded from library file at ``. . Repeat this option to load several plugins. * `--plugin-search-dir ...`: A directory where to search for [plugins](https://zenoh.io/docs/manual/plugins/) libraries to load. Repeat this option to specify several search directories'. By default, the plugins libraries will be searched in: `'/usr/local/lib:/usr/lib:~/.zenoh/lib:.'` * `--rest-http-port `: Configures the [REST plugin](https://zenoh.io/docs/manual/plugin-http/)'s HTTP port. Accepted values: * a port number * a string with format `:` (to bind the HTTP server to a specific interface) * `"None"` to deactivate the REST plugin . If not specified, the REST plugin will be active on any interface (`[::]`) and port `8000`. . ------------------------------- . ## Plugins . > [!WARNING] > As Rust doesn't have a stable ABI, the plugins should be built with the exact same Rust version as `zenohd`, and using for `zenoh` dependency the same version (or commit number) as `zenohd` with the same set of features. A plugin compiled with different Rust version or with different set of `zenoh` crate features will be rejected when `zenohd` attempts to load it. Otherwise, incompatibilities in memory mapping of structures shared between `zenohd` and the library could lead to a `"SIGSEGV"` crash. . By default the Zenoh router is delivered or built with 2 plugins. These may be configured through a configuration file, or through individual changes to the configuration via the `--cfg` CLI option or via zenoh puts on individual parts of the configuration. . > [!WARNING] > Since `v0.6`, `zenohd` no longer loads every available plugin at startup. Instead, only configured plugins are loaded (after processing `--cfg` and `--plugin` options). Once `zenohd` is running, plugins can be hot-loaded and, if they support it, reconfigured at runtime by editing their configuration through the adminspace. . **[REST plugin](https://zenoh.io/docs/manual/plugin-http/)** (exposing a REST API): This plugin converts GET and PUT REST requests into Zenoh gets and puts respectively. . Note that to activate the REST plugin on `zenohd` the CLI argument should be passed: `--rest-http-port=8000` (or any other port of your choice). . **[Storages plugin](https://zenoh.io/docs/manual/plugin-storage-manager/)** (managing [backends and storages](https://zenoh.io/docs/manual/plugin-storage-manager/#backends-and-volumes)) This plugin allows you to easily define storages. These will store key-value pairs they subscribed to, and send the most recent ones when queried. Check out [DEFAULT_CONFIG.json5](DEFAULT_CONFIG.json5) for info on how to configure them. . ------------------------------- . ## Troubleshooting . In case of troubles, please first check on [this page](https://zenoh.io/docs/getting-started/troubleshooting/) if the trouble and cause are already known. Otherwise, you can ask a question on the [zenoh Discord server](https://discord.gg/vSDSpqnbkm), or [create an issue](https://github.com/eclipse-zenoh/zenoh/issues). Package: zenohd Version: 1.3.3 Architecture: amd64 Maintainer: zenoh-dev@eclipse.org Installed-Size: 13804 Depends: libc6 (>= 2.34) Filename: 1.3.3/zenohd_1.3.3_amd64.deb Size: 3832288 MD5sum: 4d5b6b5b7a4ba518df46f250a3f2b01d SHA1: d7d2cee49a77e66279596d9970ac1ddb77528bd5 SHA256: 517f6e4a08fff4b11d9f54fa34ddb9f3ffed19e249016789420b66bcafabe6ee Section: net Priority: optional Homepage: http://zenoh.io Description: Zenoh: The Zero Overhead Pub/Sub/Query Protocol. . [![CI](https://github.com/eclipse-zenoh/zenoh/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/eclipse-zenoh/zenoh/actions?query=workflow%3ACI+branch%3Amain++) [![Documentation Status](https://readthedocs.org/projects/zenoh-rust/badge/?version=latest)](https://zenoh-rust.readthedocs.io/en/latest/?badge=latest) [![codecov](https://codecov.io/github/eclipse-zenoh/zenoh/branch/main/graph/badge.svg?token=F8T4C8WPZD)](https://codecov.io/github/eclipse-zenoh/zenoh) [![Discussion](https://img.shields.io/badge/discussion-on%20github-blue)](https://github.com/eclipse-zenoh/roadmap/discussions) [![Discord](https://img.shields.io/badge/chat-on%20discord-blue)](https://discord.gg/2GJ958VuHs) [![License](https://img.shields.io/badge/License-EPL%202.0-blue)](https://choosealicense.com/licenses/epl-2.0/) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) . # Eclipse Zenoh . The Eclipse Zenoh: Zero Overhead Pub/sub, Store/Query and Compute. . Zenoh (pronounce _/zeno/_) unifies data in motion, data at rest and computations. It carefully blends traditional pub/sub with geo-distributed storages, queries and computations, while retaining a level of time and space efficiency that is well beyond any of the mainstream stacks. . Check the website [zenoh.io](http://zenoh.io) and the [roadmap](https://github.com/eclipse-zenoh/roadmap) for more detailed information. . ------------------------------- . ## Getting Started . Zenoh is extremely easy to learn, the best place to master the fundamentals is our [getting started guide](https://zenoh.io/docs/getting-started/first-app/). . ------------------------------- . ## How to install it . To install the latest release of the Zenoh router (`zenohd`) and its default plugins (REST API plugin and Storages Manager plugin) you can do as follows: . ### Manual installation (all platforms) . All release packages can be downloaded from [https://download.eclipse.org/zenoh/zenoh/latest/](https://download.eclipse.org/zenoh/zenoh/latest/). . Each subdirectory has the name of the Rust target. See the platforms each target corresponds to on [https://doc.rust-lang.org/stable/rustc/platform-support.html](https://doc.rust-lang.org/stable/rustc/platform-support.html). . Choose your platform and download the `.zip` file. Unzip it where you want, and run the extracted `zenohd` binary. . ### Linux Debian . Add Eclipse Zenoh private repository to the sources list, and install the `zenoh` package: . ```bash echo "deb [trusted=yes] https://download.eclipse.org/zenoh/debian-repo/ /" | sudo tee -a /etc/apt/sources.list.d/zenoh.list > /dev/null sudo apt update sudo apt install zenoh ``` . Then you can start run `zenohd`. . ### MacOS . Tap our brew package repository and install the `zenoh` formula: . ```bash brew tap eclipse-zenoh/homebrew-zenoh brew install zenoh ``` . Then you can start run `zenohd`. . ------------------------------- . ## Rust API . * [Docs.rs for Zenoh](https://docs.rs/zenoh/latest/zenoh/) . ------------------------------- . ## How to build it . > [!WARNING] > Zenoh and its ecosystem are under active development. When you build from git, make sure you also build from git any other Zenoh repository you plan to use (e.g. binding, plugin, backend, etc.). It may happen that some changes in git are not compatible with the most recent packaged Zenoh release (e.g. deb, docker, pip). We put particular effort in maintaining compatibility between the various git repositories in the Zenoh project. . Install [Cargo and Rust](https://doc.rust-lang.org/cargo/getting-started/installation.html). Zenoh can be successfully compiled with Rust stable (>= 1.75.0), so no special configuration is required from your side. If you already have the Rust toolchain installed, make sure it is up-to-date with: . ```bash rustup update ``` . To build Zenoh, just type the following command after having followed the previous instructions: . ```bash cargo build --release --all-targets ``` . Zenoh's router is built as `target/release/zenohd`. All the examples are built into the `target/release/examples` directory. They can all work in peer-to-peer, or interconnected via the zenoh router. . ------------------------------- . ## Quick tests of your build . ### Peer-to-peer tests . * **pub/sub** * run: `./target/release/examples/z_sub` * in another shell run: `./target/release/examples/z_put` * the subscriber should receive the publication. . * **get/queryable** * run: `./target/release/examples/z_queryable` * in another shell run: `./target/release/examples/z_get` * the queryable should display the log in its listener, and the get should receive the queryable result. . ### Routed tests . > [!NOTE] > **Windows users**: to properly execute the commands below in PowerShell you need to escape `"` characters as `\"`. . * **put / store / get** * run the Zenoh router with a memory storage: . ```sh ./target/release/zenohd --cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/example/**",volume:"memory"}' ``` . * in another shell run: . ```sh ./target/release/examples/z_put` ``` . * then run . ```sh ./target/release/examples/z_get ``` . * the get should receive the stored publication. . * **REST API using `curl` tool** * run the Zenoh router with a memory storage: . ```sh ./target/release/zenohd --cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/example/**",volume:"memory"}' ``` . * in another shell, do a publication via the REST API: . ```sh curl -X PUT -d '"Hello World!"' http://localhost:8000/demo/example/test ``` . * get it back via the REST API: . ```sh curl http://localhost:8000/demo/example/test ``` . * **router admin space via the REST API** * run the Zenoh router with permission to perform config changes via the admin space, and with a memory storage: . ```sh ./target/release/zenohd --rest-http-port=8000 --adminspace-permissions=rw --cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/example/**",volume:"memory"}' ``` . * in another shell, get info of the zenoh router via the zenoh admin space (you may use `jq` for pretty json formatting): . ```sh curl -s http://localhost:8000/@/local/router | jq ``` . * get the volumes of the router (only memory by default): . ```sh curl -s 'http://localhost:8000/@/local/router/**/volumes/*' | jq ``` . * get the storages of the local router (the memory storage configured at startup on '/demo/example/**' should be present): . ```sh curl -s 'http://localhost:8000/@/local/router/**/storages/*' | jq ``` . * add another memory storage on `/demo/mystore/**`: . ```sh curl -X PUT -H 'content-type:application/json' -d '{"key_expr":"demo/mystore/**","volume":"memory"}' http://localhost:8000/@/local/router/config/plugins/storage_manager/storages/mystore ``` . * check it has been created: . ```sh curl -s 'http://localhost:8000/@/local/router/**/storages/*' | jq ``` . ### Configuration options . A Zenoh configuration file can be provided via CLI to all Zenoh examples and the Zenoh router. . * `-c, --config `: a [JSON5](https://json5.org) configuration file. [DEFAULT_CONFIG.json5](DEFAULT_CONFIG.json5) shows the schema of this file and the available options. . See other examples of Zenoh usage in [examples/](examples) . > [!NOTE] > **Zenoh Runtime Configuration**: Starting from version 0.11.0-rc, Zenoh allows for configuring the number of worker threads and other advanced options of the runtime. For guidance on utilizing it, please refer to the [doc](https://docs.rs/zenoh-runtime/latest/zenoh_runtime/enum.ZRuntime.html). . ------------------------------- . ## Zenoh router command line arguments . `zenohd` accepts the following arguments: . * `--adminspace-permissions <[r|w|rw|none]>`: Configure the read and/or write permissions on the admin space. Default is read only. * `-c, --config `: a [JSON5](https://json5.org) configuration file. [DEFAULT_CONFIG.json5](DEFAULT_CONFIG.json5) shows the schema of this file. All properties of this configuration are optional, so you may not need such a large configuration for your use-case. * `--cfg :`: allows you to change specific parts of the configuration right after it has been constructed. VALUE must be a valid JSON5 value, and key must be a path through the configuration file, where each element is separated by a `/`. When inserting in parts of the config that are arrays, you may use indexes, or may use `+` to indicate that you want to append your value to the array. `--cfg` passed values will always override any previously existing value for their key in the configuration. * `-l, --listen ...`: An endpoint on which this router will listen for incoming sessions. Repeat this option to open several listeners. By default, `tcp/[::]:7447` is used. The following endpoints are currently supported: * TCP: `tcp/:` * UDP: `udp/:` * [TCP+TLS](https://zenoh.io/docs/manual/tls/): `tls/:` * [QUIC](https://zenoh.io/docs/manual/quic/): `quic/:` * `-e, --connect ...`: An endpoint this router will try to connect to. Repeat this option to connect to several peers or routers. * `--no-multicast-scouting`: By default zenohd replies to multicast scouting messages for being discovered by peers and clients. This option disables this feature. * `-i, --id `: The identifier (as an hexadecimal string - e.g.: A0B23...) that zenohd must use. **WARNING**: this identifier must be unique in the system! If not set, a random unsigned 128bit integer will be used. * `--no-timestamp`: By default zenohd adds a HLC-generated Timestamp to each routed Data if there isn't already one. This option disables this feature. * `-P, --plugin [ | :]...`: A [plugin](https://zenoh.io/docs/manual/plugins/) that must be loaded. Accepted values: * a plugin name; zenohd will search for a library named `libzenoh_plugin_.so` on Unix, `libzenoh_plugin_.dylib` on MacOS or `zenoh_plugin_.dll` on Windows. * `":"`; the plugin will be loaded from library file at ``. . Repeat this option to load several plugins. * `--plugin-search-dir ...`: A directory where to search for [plugins](https://zenoh.io/docs/manual/plugins/) libraries to load. Repeat this option to specify several search directories'. By default, the plugins libraries will be searched in: `'/usr/local/lib:/usr/lib:~/.zenoh/lib:.'` * `--rest-http-port `: Configures the [REST plugin](https://zenoh.io/docs/manual/plugin-http/)'s HTTP port. Accepted values: * a port number * a string with format `:` (to bind the HTTP server to a specific interface) * `"None"` to deactivate the REST plugin . If not specified, the REST plugin will be active on any interface (`[::]`) and port `8000`. . ------------------------------- . ## Plugins . > [!WARNING] > As Rust doesn't have a stable ABI, the plugins should be built with the exact same Rust version as `zenohd`, and using for `zenoh` dependency the same version (or commit number) as `zenohd` with the same set of features. A plugin compiled with different Rust version or with different set of `zenoh` crate features will be rejected when `zenohd` attempts to load it. Otherwise, incompatibilities in memory mapping of structures shared between `zenohd` and the library could lead to a `"SIGSEGV"` crash. . By default the Zenoh router is delivered or built with 2 plugins. These may be configured through a configuration file, or through individual changes to the configuration via the `--cfg` CLI option or via zenoh puts on individual parts of the configuration. . > [!WARNING] > Since `v0.6`, `zenohd` no longer loads every available plugin at startup. Instead, only configured plugins are loaded (after processing `--cfg` and `--plugin` options). Once `zenohd` is running, plugins can be hot-loaded and, if they support it, reconfigured at runtime by editing their configuration through the adminspace. . **[REST plugin](https://zenoh.io/docs/manual/plugin-http/)** (exposing a REST API): This plugin converts GET and PUT REST requests into Zenoh gets and puts respectively. . Note that to activate the REST plugin on `zenohd` the CLI argument should be passed: `--rest-http-port=8000` (or any other port of your choice). . **[Storages plugin](https://zenoh.io/docs/manual/plugin-storage-manager/)** (managing [backends and storages](https://zenoh.io/docs/manual/plugin-storage-manager/#backends-and-volumes)) This plugin allows you to easily define storages. These will store key-value pairs they subscribed to, and send the most recent ones when queried. Check out [DEFAULT_CONFIG.json5](DEFAULT_CONFIG.json5) for info on how to configure them. . ------------------------------- . ## Troubleshooting . In case of troubles, please first check on [this page](https://zenoh.io/docs/getting-started/troubleshooting/) if the trouble and cause are already known. Otherwise, you can ask a question on the [zenoh Discord server](https://discord.gg/vSDSpqnbkm), or [create an issue](https://github.com/eclipse-zenoh/zenoh/issues).