Package: zenoh
Version: 1.2.2
Architecture: armel
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 41
Depends: zenoh-plugin-rest (=1.2.2), zenoh-plugin-storage-manager (=1.2.2), zenohd (=1.2.2)
Filename: 1.2.2/zenoh_1.2.2_armel.deb
Size: 17560
MD5sum: 93f5ee054fd1872876bcf37e96df112d
SHA1: 23358de20fdf73ef120fb45bfd728b09ee507d51
SHA256: 2ad99b975bf046615d037294c31fdeef054586dd96a3aed1e6794409e79869e9
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.2.2
Architecture: armhf
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 41
Depends: zenoh-plugin-rest (=1.2.2), zenoh-plugin-storage-manager (=1.2.2), zenohd (=1.2.2)
Filename: 1.2.2/zenoh_1.2.2_armhf.deb
Size: 17560
MD5sum: 89a1e583d2ebb0fef356485dc6bbc312
SHA1: 52ec67eedef4f695611d097da6dd35b03a65505c
SHA256: 11a2b749e37cf9ccc527d968a634d3251f5a4354dac676d4df0f52649fa49bc2
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.2.2
Architecture: amd64
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 41
Depends: zenoh-plugin-rest (=1.2.2), zenoh-plugin-storage-manager (=1.2.2), zenohd (=1.2.2)
Filename: 1.2.2/zenoh_1.2.2_amd64.deb
Size: 17560
MD5sum: 0bae52ad4cd6bb5a2a55be1a6b9cd61a
SHA1: 263ec12dfad109338bb0e94cb5b55045ebcd3cff
SHA256: d8eccf0d1d0c8c1bf5cf1af2cb6516e9762980a8f057f92878bbfdffc252606b
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.2.2
Architecture: arm64
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 41
Depends: zenoh-plugin-rest (=1.2.2), zenoh-plugin-storage-manager (=1.2.2), zenohd (=1.2.2)
Filename: 1.2.2/zenoh_1.2.2_arm64.deb
Size: 17560
MD5sum: 4b11ab86cdf5e94532b36d0b9d6b6a79
SHA1: ac72268b7fcacf97d35d18e17861af8125ada200
SHA256: b07fa57a7f33ead34ae5d1997302dc9bdfde9f584139b6f140a686ef71e8f93e
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.2.2
Architecture: amd64
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 10808
Depends: zenohd (=1.2.2)
Filename: 1.2.2/zenoh-plugin-rest_1.2.2_amd64.deb
Size: 2091532
MD5sum: 632cd77a5fd8d5b66b443aae379bb1fb
SHA1: ca6c963246c99b617c616dbae028a2c7c0f38782
SHA256: 8ec2bd5f96720138078c3315bd433da337e2d03257ca56e1628e973fcad00ed1
Section: net
Priority: optional
Homepage: http://zenoh.io
Description: The zenoh REST plugin
# ⚠️ WARNING ⚠️
.
This crate is intended for Zenoh's internal use.
.
- [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.2.2
Architecture: arm64
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 10246
Depends: zenohd (=1.2.2)
Filename: 1.2.2/zenoh-plugin-rest_1.2.2_arm64.deb
Size: 1962244
MD5sum: 15a615f64654cf6c0930b97a37613021
SHA1: 5f11282baa05b430d869b1494a347c65a909fdf5
SHA256: 4abf81fc1246c9aa862a027e1df71937efdd3f381a57168e81a593071ed93e2a
Section: net
Priority: optional
Homepage: http://zenoh.io
Description: The zenoh REST plugin
# ⚠️ WARNING ⚠️
.
This crate is intended for Zenoh's internal use.
.
- [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.2.2
Architecture: armel
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 8059
Depends: zenohd (=1.2.2)
Filename: 1.2.2/zenoh-plugin-rest_1.2.2_armel.deb
Size: 1806184
MD5sum: e26ca6187b97f9bd80f0d7d75bcb5a27
SHA1: 5c076300b7a663e1ecbe639b25d5768acf68098c
SHA256: d5f78ac0ba8cefe443e6d60e294b65aa2a00d3ae3348738407ca3b8ecb5ffff1
Section: net
Priority: optional
Homepage: http://zenoh.io
Description: The zenoh REST plugin
# ⚠️ WARNING ⚠️
.
This crate is intended for Zenoh's internal use.
.
- [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.2.2
Architecture: armhf
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 7961
Depends: zenohd (=1.2.2)
Filename: 1.2.2/zenoh-plugin-rest_1.2.2_armhf.deb
Size: 1793284
MD5sum: 7b4e0a954c4d9277a5f95dfa4152559d
SHA1: bb69645777930d9462c0b9523cd28d4aea55d18f
SHA256: cd2c40a572888ee0a4d25d73326cfa44dcfbc273e6399aded18555db37ec9acd
Section: net
Priority: optional
Homepage: http://zenoh.io
Description: The zenoh REST plugin
# ⚠️ WARNING ⚠️
.
This crate is intended for Zenoh's internal use.
.
- [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.2.2
Architecture: amd64
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 10540
Depends: zenohd (=1.2.2)
Filename: 1.2.2/zenoh-plugin-storage-manager_1.2.2_amd64.deb
Size: 1981148
MD5sum: 266da1388b7e662e5d7a34d274a0b764
SHA1: 15b038536b3c86a5afd575fe84baceba9473745d
SHA256: b6a564ba5349bf20923f1a1a4ff858306831cee95e3e83fe5e95905ed009045d
Section: net
Priority: optional
Homepage: http://zenoh.io
Description: The zenoh storages plugin.
# ⚠️ WARNING ⚠️
.
This crate is intended for Zenoh's internal use.
.
- [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.2.2
Architecture: armhf
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 7702
Depends: zenohd (=1.2.2)
Filename: 1.2.2/zenoh-plugin-storage-manager_1.2.2_armhf.deb
Size: 1707432
MD5sum: 43a7a41c035fc262dcd35d56351aeeb4
SHA1: 0c5d189f8669fc79b4ecc655de2dc4ab2e584a75
SHA256: 332d61ea0ee5c60769e3a514a50a4233bb149da0e2f23ae5492a9987b2075b40
Section: net
Priority: optional
Homepage: http://zenoh.io
Description: The zenoh storages plugin.
# ⚠️ WARNING ⚠️
.
This crate is intended for Zenoh's internal use.
.
- [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.2.2
Architecture: arm64
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 9957
Depends: zenohd (=1.2.2)
Filename: 1.2.2/zenoh-plugin-storage-manager_1.2.2_arm64.deb
Size: 1854952
MD5sum: 41ad390e96de1adc901ba64619a650a7
SHA1: 2425aa5ddbc9427cc14ac25b593bc0ea4c26915d
SHA256: 8fe8bce4382acc0383dcd74709fab63caab5413c72e3d80fef22bc1e37f0365b
Section: net
Priority: optional
Homepage: http://zenoh.io
Description: The zenoh storages plugin.
# ⚠️ WARNING ⚠️
.
This crate is intended for Zenoh's internal use.
.
- [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.2.2
Architecture: armel
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 7817
Depends: zenohd (=1.2.2)
Filename: 1.2.2/zenoh-plugin-storage-manager_1.2.2_armel.deb
Size: 1719352
MD5sum: 5dc0061f0a83f204c92b1261b674163c
SHA1: 40c929d3e5e730b6c15b2d3eb316b56f37286fb0
SHA256: 8911f3c9a39d26863151dbb83ac632950381c7afb8a0b6d7be65c69fab787ea9
Section: net
Priority: optional
Homepage: http://zenoh.io
Description: The zenoh storages plugin.
# ⚠️ WARNING ⚠️
.
This crate is intended for Zenoh's internal use.
.
- [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.2.2
Architecture: amd64
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 18522
Depends: libc6 (>= 2.29)
Filename: 1.2.2/zenohd_1.2.2_amd64.deb
Size: 4534772
MD5sum: f9f77326fb4df0616e0d7688f459f629
SHA1: cdcb6b4f6f8078079dd76172c03e508e26a0875c
SHA256: edf805283c6a3cff0590d9d84d4f4af05119b3fc9b5f748bbb62b4f4703f4f71
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.2.2
Architecture: arm64
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 17055
Filename: 1.2.2/zenohd_1.2.2_arm64.deb
Size: 4138140
MD5sum: 34c400231c521ba707df5898d0e16635
SHA1: 3bbc816933f6f8659ea2c64bf9b7d25439241758
SHA256: efe721f7666e1f90cb6f5072ed2f96cd081b90cbf6e3209d151a0bd24369d31d
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.2.2
Architecture: armel
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 18175
Filename: 1.2.2/zenohd_1.2.2_armel.deb
Size: 4474932
MD5sum: 07871ec680f4b2c6295ce314d63968f3
SHA1: 2536bc7e19d1dd7ac186f76d57a641768f6aaa82
SHA256: 92bfc8dee31868240ff55f81c7fa61ecfed95c5223bd862ac6b5bf4d622a68c4
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.2.2
Architecture: armhf
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 17931
Filename: 1.2.2/zenohd_1.2.2_armhf.deb
Size: 4528052
MD5sum: 0d2c834b086a5d1aa5e7257d4280cee2
SHA1: a87a3c4143b3a28ac096504f25e4b5eff15042bb
SHA256: 0511b21460837c3c908932b627b283ee79c5ae5a8a71583abb0b3ac3056b8b22
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).