Package: zenoh
Version: 1.0.0~rc.1-1
Architecture: armhf
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 40
Depends: zenoh-plugin-storage-manager (=1.0.0~rc.1-1), zenohd (=1.0.0~rc.1-1), zenoh-plugin-rest (=1.0.0~rc.1-1)
Filename: 1.0.0-rc.1/zenoh_1.0.0~rc.1-1_armhf.deb
Size: 17344
MD5sum: 1e58fd015af87b9cb6289461122f6570
SHA1: 84735435511d00d3d1de96d0cf7bacd1ffbb9572
SHA256: c986d2b0d13204495601e3149f80b4996698fb0638b57ff7b161e680a8821b6f
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%3A%22CI%22)
[](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:
`./target/release/zenohd
--cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/example/**",volume:"memory"}'`
* in another shell run: `./target/release/examples/z_put`
* then run `./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:
`./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:
`curl -X PUT -d '"Hello World!"' http://localhost:8000/demo/example/test`
* get it back via the REST API:
`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:
`./target/release/zenohd --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:
`curl http://localhost:8000/@/local/router`
* get the volumes of the router (only memory by default):
`curl 'http://localhost:8000/@/local/router/**/volumes/*'`
* get the storages of the local router (the memory storage configured at
startup on '/demo/example/**' should be present):
`curl 'http://localhost:8000/@/local/router/**/storages/*'`
* add another memory storage on `/demo/mystore/**`:
`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:
`curl 'http://localhost:8000/@/local/router/**/storages/*'`
.
### 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 than `zenohd`, and using for `zenoh`
dependency the same version (or commit number) than 'zenohd'.
Otherwise, incompatibilities in memory mapping of shared types between `zenohd`
and the library can lead to a `"SIGSEV"` 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.
.
Note that the REST plugin is added to the configuration by the default value of
the `--rest-http-port` CLI argument.
.
**[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.
.
**[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).
Vcs-Browser: https://github.com/eclipse-zenoh/zenoh
Vcs-Git: https://github.com/eclipse-zenoh/zenoh
Package: zenoh
Version: 1.0.0~rc.1-1
Architecture: armel
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 40
Depends: zenohd (=1.0.0~rc.1-1), zenoh-plugin-storage-manager (=1.0.0~rc.1-1), zenoh-plugin-rest (=1.0.0~rc.1-1)
Filename: 1.0.0-rc.1/zenoh_1.0.0~rc.1-1_armel.deb
Size: 17336
MD5sum: 388b6799f8599db9a2a7e308c4dcd830
SHA1: 1c5ebbdddd89924a8764869f26d2bbe4ace2afdf
SHA256: fa1cde7a563333e4c80e3ff43ed1e068b2ee1025edfe8058cf5e9d6db8e75686
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%3A%22CI%22)
[](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:
`./target/release/zenohd
--cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/example/**",volume:"memory"}'`
* in another shell run: `./target/release/examples/z_put`
* then run `./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:
`./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:
`curl -X PUT -d '"Hello World!"' http://localhost:8000/demo/example/test`
* get it back via the REST API:
`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:
`./target/release/zenohd --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:
`curl http://localhost:8000/@/local/router`
* get the volumes of the router (only memory by default):
`curl 'http://localhost:8000/@/local/router/**/volumes/*'`
* get the storages of the local router (the memory storage configured at
startup on '/demo/example/**' should be present):
`curl 'http://localhost:8000/@/local/router/**/storages/*'`
* add another memory storage on `/demo/mystore/**`:
`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:
`curl 'http://localhost:8000/@/local/router/**/storages/*'`
.
### 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 than `zenohd`, and using for `zenoh`
dependency the same version (or commit number) than 'zenohd'.
Otherwise, incompatibilities in memory mapping of shared types between `zenohd`
and the library can lead to a `"SIGSEV"` 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.
.
Note that the REST plugin is added to the configuration by the default value of
the `--rest-http-port` CLI argument.
.
**[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.
.
**[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).
Vcs-Browser: https://github.com/eclipse-zenoh/zenoh
Vcs-Git: https://github.com/eclipse-zenoh/zenoh
Package: zenoh
Version: 1.0.0~rc.1-1
Architecture: arm64
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 40
Depends: zenoh-plugin-rest (=1.0.0~rc.1-1), zenohd (=1.0.0~rc.1-1), zenoh-plugin-storage-manager (=1.0.0~rc.1-1)
Filename: 1.0.0-rc.1/zenoh_1.0.0~rc.1-1_arm64.deb
Size: 17344
MD5sum: 7eda4a19ee5d39c8ec1242fce4e7f2cd
SHA1: 1304998b08e994838fdfd124213020b5c678eac4
SHA256: 7dc52b1725692889f4a6a613489c57dd4e97efd5d349fff71783bd0aa6fda57d
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%3A%22CI%22)
[](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:
`./target/release/zenohd
--cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/example/**",volume:"memory"}'`
* in another shell run: `./target/release/examples/z_put`
* then run `./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:
`./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:
`curl -X PUT -d '"Hello World!"' http://localhost:8000/demo/example/test`
* get it back via the REST API:
`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:
`./target/release/zenohd --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:
`curl http://localhost:8000/@/local/router`
* get the volumes of the router (only memory by default):
`curl 'http://localhost:8000/@/local/router/**/volumes/*'`
* get the storages of the local router (the memory storage configured at
startup on '/demo/example/**' should be present):
`curl 'http://localhost:8000/@/local/router/**/storages/*'`
* add another memory storage on `/demo/mystore/**`:
`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:
`curl 'http://localhost:8000/@/local/router/**/storages/*'`
.
### 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 than `zenohd`, and using for `zenoh`
dependency the same version (or commit number) than 'zenohd'.
Otherwise, incompatibilities in memory mapping of shared types between `zenohd`
and the library can lead to a `"SIGSEV"` 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.
.
Note that the REST plugin is added to the configuration by the default value of
the `--rest-http-port` CLI argument.
.
**[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.
.
**[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).
Vcs-Browser: https://github.com/eclipse-zenoh/zenoh
Vcs-Git: https://github.com/eclipse-zenoh/zenoh
Package: zenoh
Version: 1.0.0~rc.1-1
Architecture: amd64
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 40
Depends: zenoh-plugin-storage-manager (=1.0.0~rc.1-1), zenohd (=1.0.0~rc.1-1), zenoh-plugin-rest (=1.0.0~rc.1-1)
Filename: 1.0.0-rc.1/zenoh_1.0.0~rc.1-1_amd64.deb
Size: 17344
MD5sum: 735db33f6a56ca83f1a43340dfe0c11a
SHA1: 5abb98f75f9dd472f55f4e4bd4d0b23a2ddcae3d
SHA256: 8df542eab214c563d476e2ea06e6714ee13faa59d4ef67ded495c16ba524187b
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%3A%22CI%22)
[](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:
`./target/release/zenohd
--cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/example/**",volume:"memory"}'`
* in another shell run: `./target/release/examples/z_put`
* then run `./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:
`./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:
`curl -X PUT -d '"Hello World!"' http://localhost:8000/demo/example/test`
* get it back via the REST API:
`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:
`./target/release/zenohd --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:
`curl http://localhost:8000/@/local/router`
* get the volumes of the router (only memory by default):
`curl 'http://localhost:8000/@/local/router/**/volumes/*'`
* get the storages of the local router (the memory storage configured at
startup on '/demo/example/**' should be present):
`curl 'http://localhost:8000/@/local/router/**/storages/*'`
* add another memory storage on `/demo/mystore/**`:
`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:
`curl 'http://localhost:8000/@/local/router/**/storages/*'`
.
### 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 than `zenohd`, and using for `zenoh`
dependency the same version (or commit number) than 'zenohd'.
Otherwise, incompatibilities in memory mapping of shared types between `zenohd`
and the library can lead to a `"SIGSEV"` 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.
.
Note that the REST plugin is added to the configuration by the default value of
the `--rest-http-port` CLI argument.
.
**[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.
.
**[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).
Vcs-Browser: https://github.com/eclipse-zenoh/zenoh
Vcs-Git: https://github.com/eclipse-zenoh/zenoh
Package: zenoh-plugin-rest
Version: 1.0.0~rc.1-1
Architecture: armel
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 7981
Depends: zenohd (=1.0.0~rc.1-1)
Filename: 1.0.0-rc.1/zenoh-plugin-rest_1.0.0~rc.1-1_armel.deb
Size: 1779996
MD5sum: 4b920e58afbfc9b4154c6947d9df9207
SHA1: 5b5fa94c5718dc2cc8e6394a9e124aa0cd3c7a1a
SHA256: 25a6daf5eeba0fadbc3deb2e5d5feae234ed1304a26331b0d2856688e9957eb4
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)
Vcs-Browser: https://github.com/eclipse-zenoh/zenoh
Vcs-Git: https://github.com/eclipse-zenoh/zenoh
Package: zenoh-plugin-rest
Version: 1.0.0~rc.1-1
Architecture: amd64
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 10854
Depends: zenohd (=1.0.0~rc.1-1)
Filename: 1.0.0-rc.1/zenoh-plugin-rest_1.0.0~rc.1-1_amd64.deb
Size: 2087116
MD5sum: ed2c2cda860b60cd28654a9cbd9c24ea
SHA1: d664af37dcf914831b9a9b4cda7aa3de48670730
SHA256: 6ae887aba5e05ffdc2d8c4791c871cbbcedecf55d832a517977f5065db7bfc7f
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)
Vcs-Browser: https://github.com/eclipse-zenoh/zenoh
Vcs-Git: https://github.com/eclipse-zenoh/zenoh
Package: zenoh-plugin-rest
Version: 1.0.0~rc.1-1
Architecture: arm64
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 9835
Depends: zenohd (=1.0.0~rc.1-1)
Filename: 1.0.0-rc.1/zenoh-plugin-rest_1.0.0~rc.1-1_arm64.deb
Size: 1912408
MD5sum: 76e90b05cbdc9f429a0ab9632c9bfda7
SHA1: 4f8e83c3268590f06a7b1a0542bcf1c556c2f678
SHA256: f5c83525095c255962faea4d74b1e0d584423660781f670e9b95380960fcae66
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)
Vcs-Browser: https://github.com/eclipse-zenoh/zenoh
Vcs-Git: https://github.com/eclipse-zenoh/zenoh
Package: zenoh-plugin-rest
Version: 1.0.0~rc.1-1
Architecture: armhf
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 7887
Depends: zenohd (=1.0.0~rc.1-1)
Filename: 1.0.0-rc.1/zenoh-plugin-rest_1.0.0~rc.1-1_armhf.deb
Size: 1770092
MD5sum: e28ce2c4da8d71b6e319fb7b68545698
SHA1: 809e4583bfca3b024a84d06fa206a8a5901bd1f9
SHA256: f1869fff4cb186912093a9570b00aca1840b6124f7d5f34058e3b85d60ea16ae
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)
Vcs-Browser: https://github.com/eclipse-zenoh/zenoh
Vcs-Git: https://github.com/eclipse-zenoh/zenoh
Package: zenoh-plugin-storage-manager
Version: 1.0.0~rc.1-1
Architecture: armel
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 7735
Depends: zenohd (=1.0.0~rc.1-1)
Filename: 1.0.0-rc.1/zenoh-plugin-storage-manager_1.0.0~rc.1-1_armel.deb
Size: 1696464
MD5sum: 82529e503a87584de500d6e900c8d809
SHA1: a4fefb27891afc7f76b4582048dab41c24aa17a8
SHA256: a99b17f60c9865deefb6f29c1dda3ace65bd254969f38e0c58a57975e9240b0b
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)
Vcs-Browser: https://github.com/eclipse-zenoh/zenoh
Vcs-Git: https://github.com/eclipse-zenoh/zenoh
Package: zenoh-plugin-storage-manager
Version: 1.0.0~rc.1-1
Architecture: amd64
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 10583
Depends: zenohd (=1.0.0~rc.1-1)
Filename: 1.0.0-rc.1/zenoh-plugin-storage-manager_1.0.0~rc.1-1_amd64.deb
Size: 1977092
MD5sum: 23c92cfea44530a61db010a9b73ea4b6
SHA1: 478daf2f85893c79d6c841cdd0377c9c6bf043bc
SHA256: 2e21d030e574052b144f6103cc5fd3ffc81ccab691dbfa32244a0aa1691b8cbe
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)
Vcs-Browser: https://github.com/eclipse-zenoh/zenoh
Vcs-Git: https://github.com/eclipse-zenoh/zenoh
Package: zenoh-plugin-storage-manager
Version: 1.0.0~rc.1-1
Architecture: arm64
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 9547
Depends: zenohd (=1.0.0~rc.1-1)
Filename: 1.0.0-rc.1/zenoh-plugin-storage-manager_1.0.0~rc.1-1_arm64.deb
Size: 1803616
MD5sum: 5571fc3684fb81bcf2be00b9df71f55c
SHA1: 2c8d3f4e461e0c5eb081bfdee044e34e31f43cfa
SHA256: 481cd2cfcc384669edfe1f764b09f757823cacd25863d2532cf41be2f4bc8315
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)
Vcs-Browser: https://github.com/eclipse-zenoh/zenoh
Vcs-Git: https://github.com/eclipse-zenoh/zenoh
Package: zenoh-plugin-storage-manager
Version: 1.0.0~rc.1-1
Architecture: armhf
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 7620
Depends: zenohd (=1.0.0~rc.1-1)
Filename: 1.0.0-rc.1/zenoh-plugin-storage-manager_1.0.0~rc.1-1_armhf.deb
Size: 1683496
MD5sum: c14a4beff6f1cbba28fc09edea7ad497
SHA1: 464ec2d8e295c66b5c4198d38979f6457bd0fb65
SHA256: 581c79fc34631412ee9e6b95322d8d28b3f7a0ebc0cfb2cde6c8a99afe7386d5
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)
Vcs-Browser: https://github.com/eclipse-zenoh/zenoh
Vcs-Git: https://github.com/eclipse-zenoh/zenoh
Package: zenohd
Version: 1.0.0~rc.1-1
Architecture: amd64
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 18020
Depends: libc6 (>= 2.29)
Filename: 1.0.0-rc.1/zenohd_1.0.0~rc.1-1_amd64.deb
Size: 4416520
MD5sum: 18f69019410ae927903d9e7120fcb944
SHA1: bcc57770e0e35d4d256ae0ba6fda82b4408cf502
SHA256: 6f1ba4e8af91579175037fa987ccb3652067d71a727a73c96d7f37f58903be13
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%3A%22CI%22)
[](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:
`./target/release/zenohd
--cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/example/**",volume:"memory"}'`
* in another shell run: `./target/release/examples/z_put`
* then run `./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:
`./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:
`curl -X PUT -d '"Hello World!"' http://localhost:8000/demo/example/test`
* get it back via the REST API:
`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:
`./target/release/zenohd --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:
`curl http://localhost:8000/@/local/router`
* get the volumes of the router (only memory by default):
`curl 'http://localhost:8000/@/local/router/**/volumes/*'`
* get the storages of the local router (the memory storage configured at
startup on '/demo/example/**' should be present):
`curl 'http://localhost:8000/@/local/router/**/storages/*'`
* add another memory storage on `/demo/mystore/**`:
`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:
`curl 'http://localhost:8000/@/local/router/**/storages/*'`
.
### 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 than `zenohd`, and using for `zenoh`
dependency the same version (or commit number) than 'zenohd'.
Otherwise, incompatibilities in memory mapping of shared types between `zenohd`
and the library can lead to a `"SIGSEV"` 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.
.
Note that the REST plugin is added to the configuration by the default value of
the `--rest-http-port` CLI argument.
.
**[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.
.
**[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).
Vcs-Browser: https://github.com/eclipse-zenoh/zenoh
Vcs-Git: https://github.com/eclipse-zenoh/zenoh
Package: zenohd
Version: 1.0.0~rc.1-1
Architecture: arm64
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 16164
Filename: 1.0.0-rc.1/zenohd_1.0.0~rc.1-1_arm64.deb
Size: 3978824
MD5sum: 7eae370ff08c076bad5772a7eee562ed
SHA1: f52b981b03915a4cec95e79593dca9aee9742e31
SHA256: 0d5d3207864bb37a6a89d5e057cf1f238b83340df09309ef518f84bf49dbf2c1
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%3A%22CI%22)
[](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:
`./target/release/zenohd
--cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/example/**",volume:"memory"}'`
* in another shell run: `./target/release/examples/z_put`
* then run `./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:
`./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:
`curl -X PUT -d '"Hello World!"' http://localhost:8000/demo/example/test`
* get it back via the REST API:
`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:
`./target/release/zenohd --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:
`curl http://localhost:8000/@/local/router`
* get the volumes of the router (only memory by default):
`curl 'http://localhost:8000/@/local/router/**/volumes/*'`
* get the storages of the local router (the memory storage configured at
startup on '/demo/example/**' should be present):
`curl 'http://localhost:8000/@/local/router/**/storages/*'`
* add another memory storage on `/demo/mystore/**`:
`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:
`curl 'http://localhost:8000/@/local/router/**/storages/*'`
.
### 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 than `zenohd`, and using for `zenoh`
dependency the same version (or commit number) than 'zenohd'.
Otherwise, incompatibilities in memory mapping of shared types between `zenohd`
and the library can lead to a `"SIGSEV"` 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.
.
Note that the REST plugin is added to the configuration by the default value of
the `--rest-http-port` CLI argument.
.
**[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.
.
**[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).
Vcs-Browser: https://github.com/eclipse-zenoh/zenoh
Vcs-Git: https://github.com/eclipse-zenoh/zenoh
Package: zenohd
Version: 1.0.0~rc.1-1
Architecture: armhf
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 17303
Filename: 1.0.0-rc.1/zenohd_1.0.0~rc.1-1_armhf.deb
Size: 4377064
MD5sum: b27f14607cb3162cfa12c73ca695ba74
SHA1: 05c98fd1aa435c5c3f643a2654b2fd5066c4925a
SHA256: 47d3c218b85ffa343e7f99fa27d034aeb843238042e1f18c42706080d3789975
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%3A%22CI%22)
[](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:
`./target/release/zenohd
--cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/example/**",volume:"memory"}'`
* in another shell run: `./target/release/examples/z_put`
* then run `./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:
`./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:
`curl -X PUT -d '"Hello World!"' http://localhost:8000/demo/example/test`
* get it back via the REST API:
`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:
`./target/release/zenohd --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:
`curl http://localhost:8000/@/local/router`
* get the volumes of the router (only memory by default):
`curl 'http://localhost:8000/@/local/router/**/volumes/*'`
* get the storages of the local router (the memory storage configured at
startup on '/demo/example/**' should be present):
`curl 'http://localhost:8000/@/local/router/**/storages/*'`
* add another memory storage on `/demo/mystore/**`:
`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:
`curl 'http://localhost:8000/@/local/router/**/storages/*'`
.
### 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 than `zenohd`, and using for `zenoh`
dependency the same version (or commit number) than 'zenohd'.
Otherwise, incompatibilities in memory mapping of shared types between `zenohd`
and the library can lead to a `"SIGSEV"` 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.
.
Note that the REST plugin is added to the configuration by the default value of
the `--rest-http-port` CLI argument.
.
**[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.
.
**[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).
Vcs-Browser: https://github.com/eclipse-zenoh/zenoh
Vcs-Git: https://github.com/eclipse-zenoh/zenoh
Package: zenohd
Version: 1.0.0~rc.1-1
Architecture: armel
Maintainer: zenoh-dev@eclipse.org
Installed-Size: 17518
Filename: 1.0.0-rc.1/zenohd_1.0.0~rc.1-1_armel.deb
Size: 4319700
MD5sum: cb1cdf46095afc746f8f8d44231670bc
SHA1: 868c6fbd273a6224c26a715b67c0fe13ba54493b
SHA256: ef4621c045cb6165025f5c9db23dd5f682c731a12f6433412bfb477d35ed88fa
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%3A%22CI%22)
[](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:
`./target/release/zenohd
--cfg='plugins/storage_manager/storages/demo:{key_expr:"demo/example/**",volume:"memory"}'`
* in another shell run: `./target/release/examples/z_put`
* then run `./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:
`./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:
`curl -X PUT -d '"Hello World!"' http://localhost:8000/demo/example/test`
* get it back via the REST API:
`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:
`./target/release/zenohd --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:
`curl http://localhost:8000/@/local/router`
* get the volumes of the router (only memory by default):
`curl 'http://localhost:8000/@/local/router/**/volumes/*'`
* get the storages of the local router (the memory storage configured at
startup on '/demo/example/**' should be present):
`curl 'http://localhost:8000/@/local/router/**/storages/*'`
* add another memory storage on `/demo/mystore/**`:
`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:
`curl 'http://localhost:8000/@/local/router/**/storages/*'`
.
### 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 than `zenohd`, and using for `zenoh`
dependency the same version (or commit number) than 'zenohd'.
Otherwise, incompatibilities in memory mapping of shared types between `zenohd`
and the library can lead to a `"SIGSEV"` 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.
.
Note that the REST plugin is added to the configuration by the default value of
the `--rest-http-port` CLI argument.
.
**[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.
.
**[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).
Vcs-Browser: https://github.com/eclipse-zenoh/zenoh
Vcs-Git: https://github.com/eclipse-zenoh/zenoh