Package: zenoh
Version: 1.1.1
Architecture: armhf
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 41
Depends: zenoh-plugin-rest (=1.1.1), zenoh-plugin-storage-manager (=1.1.1), zenohd (=1.1.1)
Filename: 1.1.1/zenoh_1.1.1_armhf.deb
Size: 17460
MD5sum: 10f38cd8ce4f6e4009513c24b78a3caa
SHA1: 770d39eb50e5f23e25942463bb812c9f5feaeb58
SHA256: 8ce59535cd7b7fa6de2f53733747ccf8769501d4cc915c16daa826cb499cd93d
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://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.1.1
Architecture: armel
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 41
Depends: zenoh-plugin-rest (=1.1.1), zenoh-plugin-storage-manager (=1.1.1), zenohd (=1.1.1)
Filename: 1.1.1/zenoh_1.1.1_armel.deb
Size: 17456
MD5sum: 0ccfc32a274026ac6eac0d2cd91b9772
SHA1: 5a6404341820c25d9c3d5dd855287562174db602
SHA256: 694f8986d94868722ca8796d71278a2a9867f857169a1b12008f15d37ab11444
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://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.1.1
Architecture: amd64
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 41
Depends: zenoh-plugin-rest (=1.1.1), zenoh-plugin-storage-manager (=1.1.1), zenohd (=1.1.1)
Filename: 1.1.1/zenoh_1.1.1_amd64.deb
Size: 17460
MD5sum: 662022fec117255596014231a5c705d6
SHA1: 607c3801d5a188034e0218c74f09a1cdda91156d
SHA256: 4e68bd11d15386e8978dffbe07cc24c0508462b964b6eebee6ba64eaefbd4614
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://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.1.1
Architecture: arm64
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 41
Depends: zenoh-plugin-rest (=1.1.1), zenoh-plugin-storage-manager (=1.1.1), zenohd (=1.1.1)
Filename: 1.1.1/zenoh_1.1.1_arm64.deb
Size: 17460
MD5sum: 79d8ad964d86b48a791ec2d4433bf9b4
SHA1: 7a3f0b48951ef6e39e9d0388484af6c72178b0f5
SHA256: 7dda9d8d5f0a619292bf6504a0c3476debc1082510eced1bdd5c8af0fdd7ad33
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://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.1.1
Architecture: amd64
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 10888
Depends: zenohd (=1.1.1)
Filename: 1.1.1/zenoh-plugin-rest_1.1.1_amd64.deb
Size: 2097392
MD5sum: 5bc97ac1a4c8a6bcbce33c76a4896dfd
SHA1: 8f142c3f743fc7f4e3f3efddd99bc922fa8b844d
SHA256: 402aeb7a0efe73dcc41f8fe361002d6ca3b7dec7b7716561d2cbb79d5f6f46c8
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.1.1
Architecture: arm64
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 9882
Depends: zenohd (=1.1.1)
Filename: 1.1.1/zenoh-plugin-rest_1.1.1_arm64.deb
Size: 1921400
MD5sum: bd80d61d3d7b4490efa74848ff895aca
SHA1: 4156c6be392dc835488377ca4c12d0959ab32c5c
SHA256: 2d02c8568640734490011e95a919e13cc35d73e53e3793d47ac3f7ba500667eb
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.1.1
Architecture: armel
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 8024
Depends: zenohd (=1.1.1)
Filename: 1.1.1/zenoh-plugin-rest_1.1.1_armel.deb
Size: 1795096
MD5sum: 485e6f72ebd802d48779b0865ef7a991
SHA1: 7f64625cf6c7ffd3c7fd7d0754e64b0e59b55471
SHA256: 7a3fa5232aa78afacfaf0d13d6f892dca4ae632cc1af9994e2e39c5c034d4e3b
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.1.1
Architecture: armhf
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 7930
Depends: zenohd (=1.1.1)
Filename: 1.1.1/zenoh-plugin-rest_1.1.1_armhf.deb
Size: 1784916
MD5sum: 39c49c6ee16d91487515f32c666401fb
SHA1: 0d8a0dbb28876753ae6eefb01a14c1177ecf47b1
SHA256: af2cf274bebd8aeea801e361181175dc316bcb39a350d84554dd2bbece45ea50
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.1.1
Architecture: armel
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 7785
Depends: zenohd (=1.1.1)
Filename: 1.1.1/zenoh-plugin-storage-manager_1.1.1_armel.deb
Size: 1709464
MD5sum: 90c457b5138801482e2278d8d5af6568
SHA1: beb6621c4c382dae92f44b5ecd0fa75e3570e93c
SHA256: ebccb3973230912f5717c733be617ab6c27713322a2a2c10b0efe7f259cf88da
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.1.1
Architecture: amd64
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 10620
Depends: zenohd (=1.1.1)
Filename: 1.1.1/zenoh-plugin-storage-manager_1.1.1_amd64.deb
Size: 1989072
MD5sum: 2edb65bf17b4045ab17a3673953f51e5
SHA1: cc4162776142753c31871eff6773a77972de339c
SHA256: 885167ea1ea78d80ecef8298ae6b5fff470cf83d6910fc15d3e5ce097ceb3edf
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.1.1
Architecture: arm64
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 9593
Depends: zenohd (=1.1.1)
Filename: 1.1.1/zenoh-plugin-storage-manager_1.1.1_arm64.deb
Size: 1815964
MD5sum: c259ba791b9385e83ab722d361422f22
SHA1: d13a4be442960b59a87a2a3b96174acc23dd15e8
SHA256: 1cbaa18566aef0a94bb43d155cc303b90530a4104473f1d13f8de1817697bc35
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.1.1
Architecture: armhf
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 7671
Depends: zenohd (=1.1.1)
Filename: 1.1.1/zenoh-plugin-storage-manager_1.1.1_armhf.deb
Size: 1695792
MD5sum: c43089e8c557c6554469cf24130f95b0
SHA1: 1d3acf9b1c1e4a20d87701ae414d11d212f1eee8
SHA256: f4297ebeb585f7a680f67c4c8d21f2e9f7398106b4ccaf5b6262c05e2a425022
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.1.1
Architecture: amd64
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 18482
Depends: libc6 (>= 2.29)
Filename: 1.1.1/zenohd_1.1.1_amd64.deb
Size: 4509268
MD5sum: f35a9adb55548487bd3a5956fbbcf7dc
SHA1: 61dcf22645d58cb421c246df29e59b850de4a556
SHA256: f8ecd969adcba41342c59a0236714a54dafc3d950b0084b46c28e2ab2aae1572
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://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.1.1
Architecture: arm64
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 16590
Filename: 1.1.1/zenohd_1.1.1_arm64.deb
Size: 4053452
MD5sum: 3d8786de9a0d6e266fd2c1c298853a01
SHA1: 328b0ea5ddede61b8c40520e778913bfde0754a8
SHA256: 5652b503def2fbf97ab15788311d583c80c39ceca19a0dca5a7b5ab6de0486bb
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://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.1.1
Architecture: armel
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 18039
Filename: 1.1.1/zenohd_1.1.1_armel.deb
Size: 4432852
MD5sum: ace86fc54641f7e067eb8553e46e4630
SHA1: 7f51bb0384800726c1d69736d6dd31ac89257764
SHA256: 95cda2b696f157e0165e968ae1314c4bcfcea069ea4ac8b22db9132566a075a5
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://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.1.1
Architecture: armhf
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 17809
Filename: 1.1.1/zenohd_1.1.1_armhf.deb
Size: 4484336
MD5sum: 48f00aafeeb9e1fd9a927a734ced8035
SHA1: 93840ee93b630124e23581aee973568e6b1b2ed2
SHA256: dca5595bdb8d4f9858c92d3cb51e71e6e380134ce10ffd0c03e97358e2d46daa
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://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).