node-distro/README.md
Anatolios Laskaris 2e9337ea3f
chore(naming): Rename rust-peer to nox (#152)
* Rename rust-peer to nox

* Fix

* Fix
2023-06-06 14:52:27 -06:00

51 lines
1.6 KiB
Markdown

# Nox Distro
The distributive and packaging of the [nox](https://github.com/fluencelabs/nox).
## Installation and usage
```bash
docker run -d --name nox -e RUST_LOG="info" -p 7777:7777 -p 9999:9999 fluencelabs/nox:latest --local
```
To get a list of commands that can be passed to nox run:
```bash
docker run --rm --name nox fluencelabs/nox:latest --help
```
See deployment instructions and tips at
[deploy](https://github.com/fluencelabs/nox-distro/tree/master/deploy).
## Documentation
- Rust peer distro
[image flavours](https://github.com/fluencelabs/nox-distro/tree/master/docs/flavours.md)
- [Builtin services](https://github.com/fluencelabs/nox-distro/tree/master/docs/builtins.md)
Comprehensive documentation on everything related to Fluence can be found
[here](https://fluence.dev/). Check also our
[YouTube channel](https://www.youtube.com/@fluencelabs).
## Support
Please, file an [issue](https://github.com/fluencelabs/nox-distro/issues) if you
find a bug. You can also contact us at
[Discord](https://discord.com/invite/5qSnPZKh7u) or
[Telegram](https://t.me/fluence_project). We will do our best to resolve the
issue ASAP.
## Contributing
Any interested person is welcome to contribute to the project. Please, make sure
you read and follow some basic
[rules](https://github.com/fluencelabs/nox-distro/tree/master/CONTRIBUTING.md).
The Contributor License Agreement can be found
[here](https://github.com/fluencelabs/nox-distro/tree/master/FluenceCLA).
## License
All software code is copyright (c) Fluence Labs, Inc. under the
[Apache-2.0](https://github.com/fluencelabs/nox-distro/tree/master/LICENSE)
license.