Package: zenoh
Version: 1.3.0
Architecture: amd64
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 41
Depends: zenoh-plugin-rest (=1.3.0), zenoh-plugin-storage-manager (=1.3.0), zenohd (=1.3.0)
Filename: 1.3.0/zenoh_1.3.0_amd64.deb
Size: 17548
MD5sum: cc21aed83f3ac29117e2d6c6b7844fee
SHA1: b92a8d218ba648e633786e0cea716000a5452fd3
SHA256: 164f69c4ca86f746c05a407970b6cd32c89baada26018c561b883ed9d44f6b14
Section: net
Priority: optional
Homepage: http://zenoh.io
Description: Zenoh: The Zero Overhead Pub/Sub/Query Protocol.
.
[](https://github.com/eclipse-zenoh/zenoh/actions?query=workflow%3ACI+branch%3Amain++)
[](https://zenoh-rust.readthedocs.io/en/latest/?badge=latest)
[](https://codecov.io/github/eclipse-zenoh/zenoh)
[](https://github.com/eclipse-zenoh/roadmap/discussions)
[](https://discord.gg/2GJ958VuHs)
[](https://choosealicense.com/licenses/epl-2.0/)
[](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.0
Architecture: arm64
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 41
Depends: zenoh-plugin-rest (=1.3.0), zenoh-plugin-storage-manager (=1.3.0), zenohd (=1.3.0)
Filename: 1.3.0/zenoh_1.3.0_arm64.deb
Size: 17548
MD5sum: cbe28a6fa596e1b23e3650dc34d2f727
SHA1: 9883d400d30cb9b968d8af82744df5187934c54b
SHA256: aef5bead11b073b4e0d753ca38874cefe74a86b495bcfe5202cf664216f7f3ea
Section: net
Priority: optional
Homepage: http://zenoh.io
Description: Zenoh: The Zero Overhead Pub/Sub/Query Protocol.
.
[](https://github.com/eclipse-zenoh/zenoh/actions?query=workflow%3ACI+branch%3Amain++)
[](https://zenoh-rust.readthedocs.io/en/latest/?badge=latest)
[](https://codecov.io/github/eclipse-zenoh/zenoh)
[](https://github.com/eclipse-zenoh/roadmap/discussions)
[](https://discord.gg/2GJ958VuHs)
[](https://choosealicense.com/licenses/epl-2.0/)
[](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.0
Architecture: armel
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 41
Depends: zenoh-plugin-rest (=1.3.0), zenoh-plugin-storage-manager (=1.3.0), zenohd (=1.3.0)
Filename: 1.3.0/zenoh_1.3.0_armel.deb
Size: 17548
MD5sum: 98c37e932704dcc376c0269053293758
SHA1: c5486f6781230751ace9acb1b2aea64510cde620
SHA256: 98099d2db77593af973d9d2c370637771f8a5049119628377cf2ac63ed2a1877
Section: net
Priority: optional
Homepage: http://zenoh.io
Description: Zenoh: The Zero Overhead Pub/Sub/Query Protocol.
.
[](https://github.com/eclipse-zenoh/zenoh/actions?query=workflow%3ACI+branch%3Amain++)
[](https://zenoh-rust.readthedocs.io/en/latest/?badge=latest)
[](https://codecov.io/github/eclipse-zenoh/zenoh)
[](https://github.com/eclipse-zenoh/roadmap/discussions)
[](https://discord.gg/2GJ958VuHs)
[](https://choosealicense.com/licenses/epl-2.0/)
[](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.0
Architecture: armhf
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 41
Depends: zenoh-plugin-rest (=1.3.0), zenoh-plugin-storage-manager (=1.3.0), zenohd (=1.3.0)
Filename: 1.3.0/zenoh_1.3.0_armhf.deb
Size: 17548
MD5sum: 7cc965369b0cd40877e9da49dbc4d7ef
SHA1: fa9f72fb141e91071f6615e7ff3b1ee3341002c3
SHA256: 360bc97120007ff935601c3d68dbb3ea8eeab180463fc0ceb0ce7b85bbbe1c36
Section: net
Priority: optional
Homepage: http://zenoh.io
Description: Zenoh: The Zero Overhead Pub/Sub/Query Protocol.
.
[](https://github.com/eclipse-zenoh/zenoh/actions?query=workflow%3ACI+branch%3Amain++)
[](https://zenoh-rust.readthedocs.io/en/latest/?badge=latest)
[](https://codecov.io/github/eclipse-zenoh/zenoh)
[](https://github.com/eclipse-zenoh/roadmap/discussions)
[](https://discord.gg/2GJ958VuHs)
[](https://choosealicense.com/licenses/epl-2.0/)
[](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.0
Architecture: armel
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 4365
Depends: zenohd (=1.3.0)
Filename: 1.3.0/zenoh-plugin-rest_1.3.0_armel.deb
Size: 1180672
MD5sum: a330e52fc13a3eb5ab7b87e696a9c668
SHA1: 7649321b94aca145db3a18fd5f3b0d6c1d599a45
SHA256: 2700f0478add73d4f7ff340521a74fd27f68508404c7bebf20b87bb5575b63cd
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.0
Architecture: arm64
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 4642
Depends: zenohd (=1.3.0)
Filename: 1.3.0/zenoh-plugin-rest_1.3.0_arm64.deb
Size: 1144688
MD5sum: fdb516c4e6772b2d25f5281e1eebe4cf
SHA1: f6052670dcaf6f74f863fa108c284f702f167e20
SHA256: 7b864ad0fc9a3e4820ecf58e150126df756a9676eaf86636679aba3e79355507
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.0
Architecture: amd64
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 4600
Depends: zenohd (=1.3.0)
Filename: 1.3.0/zenoh-plugin-rest_1.3.0_amd64.deb
Size: 1236348
MD5sum: 4cbe79209e5ac2a7303a8ea0adcb9711
SHA1: e996fab3a9a2047d62b75095097bf051cd6c568f
SHA256: 5427f4c7a6d626c6be346f734013f261480efe243b7c70189a511a1a5e3d013e
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.0
Architecture: armhf
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 4296
Depends: zenohd (=1.3.0)
Filename: 1.3.0/zenoh-plugin-rest_1.3.0_armhf.deb
Size: 1175164
MD5sum: 864a5d38ecd5c12d35e4d79ca3dda2b9
SHA1: 9e164ca6e39690ac1d10f39fd51ebfa65dd450db
SHA256: 835c8ac9d2b127f006f034203128a58be8195db1f62b6b07ea09c77964ebee7b
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.0
Architecture: armhf
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 4026
Depends: zenohd (=1.3.0)
Filename: 1.3.0/zenoh-plugin-storage-manager_1.3.0_armhf.deb
Size: 1088804
MD5sum: 50e8e2114ba95b37160d28709b02cf2b
SHA1: 099985d6b9d95143adfd6ff3b2c93bda1bed611c
SHA256: 61be1125c924084820b928ce548e334fb9a737d6490d87abe4fa7f653215bf8f
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.0
Architecture: amd64
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 4335
Depends: zenohd (=1.3.0)
Filename: 1.3.0/zenoh-plugin-storage-manager_1.3.0_amd64.deb
Size: 1129180
MD5sum: 89d55cf8eec59a61e50de8e489f64b43
SHA1: 9ae9644001e9a3853e4d09e40b2104c5ff82edec
SHA256: ea64a1e1ae31489567689bed14da86bba61a56f8f6d7ac13ad7b4171fb79ff3a
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.0
Architecture: arm64
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 4363
Depends: zenohd (=1.3.0)
Filename: 1.3.0/zenoh-plugin-storage-manager_1.3.0_arm64.deb
Size: 1047620
MD5sum: 9c1854faa095d17f9b27780614170d5c
SHA1: 704392ab64c3375a24b5436dd2ca1be0bfc4827d
SHA256: a6d5e3bb9a37e3c842169006e9238a905b7d93cbb7d0358d1f336770ce1e5572
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.0
Architecture: armel
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 4115
Depends: zenohd (=1.3.0)
Filename: 1.3.0/zenoh-plugin-storage-manager_1.3.0_armel.deb
Size: 1095100
MD5sum: 87cdd87eca5185703e12e32445d967ce
SHA1: f04aaf713fba0531a1260cb3a0ca39f5c931962e
SHA256: 1763d88bd6f04ccf4176d498a49146e10f10d39213f08ed7901f5ff6835c8070
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.0
Architecture: amd64
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 13504
Depends: libc6 (>= 2.29)
Filename: 1.3.0/zenohd_1.3.0_amd64.deb
Size: 3770816
MD5sum: f397dde0a3ba286091c6e7ab9b17f8a6
SHA1: 6911e1eafe1229e78494683d44cf05347781e6c4
SHA256: 29cdf6b7ed4cfaffcf74748e870943cfba42a898f4448ed53d639e52c4e9b17f
Section: net
Priority: optional
Homepage: http://zenoh.io
Description: Zenoh: The Zero Overhead Pub/Sub/Query Protocol.
.
[](https://github.com/eclipse-zenoh/zenoh/actions?query=workflow%3ACI+branch%3Amain++)
[](https://zenoh-rust.readthedocs.io/en/latest/?badge=latest)
[](https://codecov.io/github/eclipse-zenoh/zenoh)
[](https://github.com/eclipse-zenoh/roadmap/discussions)
[](https://discord.gg/2GJ958VuHs)
[](https://choosealicense.com/licenses/epl-2.0/)
[](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.0
Architecture: arm64
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 12221
Filename: 1.3.0/zenohd_1.3.0_arm64.deb
Size: 3370244
MD5sum: 84d71964a564d53280785b19693664d2
SHA1: af39cc43ea537b690ef2bcf7e0e329152ac35629
SHA256: cabde56e0d63db5108c5fb57573c35d89e641e0c8766eb433bab1035c7ff8d9b
Section: net
Priority: optional
Homepage: http://zenoh.io
Description: Zenoh: The Zero Overhead Pub/Sub/Query Protocol.
.
[](https://github.com/eclipse-zenoh/zenoh/actions?query=workflow%3ACI+branch%3Amain++)
[](https://zenoh-rust.readthedocs.io/en/latest/?badge=latest)
[](https://codecov.io/github/eclipse-zenoh/zenoh)
[](https://github.com/eclipse-zenoh/roadmap/discussions)
[](https://discord.gg/2GJ958VuHs)
[](https://choosealicense.com/licenses/epl-2.0/)
[](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.0
Architecture: armel
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 12851
Filename: 1.3.0/zenohd_1.3.0_armel.deb
Size: 3526152
MD5sum: f9aaab0408972f86d6fc9681fca2d88a
SHA1: 5b17f586ed2a9fb2b9a27c309421b9d9cefe641e
SHA256: 4dd7c59782e457ef79936f0f1943682451538ceedf1df4bbe6b672b55f735fe5
Section: net
Priority: optional
Homepage: http://zenoh.io
Description: Zenoh: The Zero Overhead Pub/Sub/Query Protocol.
.
[](https://github.com/eclipse-zenoh/zenoh/actions?query=workflow%3ACI+branch%3Amain++)
[](https://zenoh-rust.readthedocs.io/en/latest/?badge=latest)
[](https://codecov.io/github/eclipse-zenoh/zenoh)
[](https://github.com/eclipse-zenoh/roadmap/discussions)
[](https://discord.gg/2GJ958VuHs)
[](https://choosealicense.com/licenses/epl-2.0/)
[](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.0
Architecture: armhf
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 12578
Filename: 1.3.0/zenohd_1.3.0_armhf.deb
Size: 3546656
MD5sum: 1dfadbb9abd17ea11ff4183d8751f648
SHA1: 3011e7bb5530407beaa0f1dcabccd725046836e1
SHA256: 9ff2d8ca2f610a3b81d982f9e386aad4ac1e807f2595da42044a0bedff7dca34
Section: net
Priority: optional
Homepage: http://zenoh.io
Description: Zenoh: The Zero Overhead Pub/Sub/Query Protocol.
.
[](https://github.com/eclipse-zenoh/zenoh/actions?query=workflow%3ACI+branch%3Amain++)
[](https://zenoh-rust.readthedocs.io/en/latest/?badge=latest)
[](https://codecov.io/github/eclipse-zenoh/zenoh)
[](https://github.com/eclipse-zenoh/roadmap/discussions)
[](https://discord.gg/2GJ958VuHs)
[](https://choosealicense.com/licenses/epl-2.0/)
[](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).