2023-06-06 20:52:27 +00:00
|
|
|
# Nox Distro
|
2022-06-21 08:08:30 +00:00
|
|
|
|
2023-06-06 20:52:27 +00:00
|
|
|
The distributive and packaging of the [nox](https://github.com/fluencelabs/nox).
|
2021-06-22 10:38:59 +00:00
|
|
|
|
2023-02-22 07:42:26 +00:00
|
|
|
## Installation and usage
|
2021-06-22 10:38:59 +00:00
|
|
|
|
2023-02-22 07:42:26 +00:00
|
|
|
```bash
|
2023-06-06 20:52:27 +00:00
|
|
|
docker run -d --name nox -e RUST_LOG="info" -p 7777:7777 -p 9999:9999 fluencelabs/nox:latest --local
|
2023-02-22 07:42:26 +00:00
|
|
|
```
|
2022-07-15 19:43:07 +00:00
|
|
|
|
2023-06-06 20:52:27 +00:00
|
|
|
To get a list of commands that can be passed to nox run:
|
2022-07-15 19:43:07 +00:00
|
|
|
|
2023-02-22 07:42:26 +00:00
|
|
|
```bash
|
2023-06-06 20:52:27 +00:00
|
|
|
docker run --rm --name nox fluencelabs/nox:latest --help
|
2023-02-22 07:42:26 +00:00
|
|
|
```
|
2022-07-15 19:43:07 +00:00
|
|
|
|
2023-03-22 15:59:01 +00:00
|
|
|
See deployment instructions and tips at
|
2023-06-06 20:52:27 +00:00
|
|
|
[deploy](https://github.com/fluencelabs/nox-distro/tree/master/deploy).
|
2022-08-18 10:16:09 +00:00
|
|
|
|
2023-02-22 07:42:26 +00:00
|
|
|
## Documentation
|
2022-08-18 10:16:09 +00:00
|
|
|
|
2023-03-22 15:59:01 +00:00
|
|
|
- Rust peer distro
|
2023-06-06 20:52:27 +00:00
|
|
|
[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)
|
2022-07-15 19:43:07 +00:00
|
|
|
|
2023-03-22 15:59:01 +00:00
|
|
|
Comprehensive documentation on everything related to Fluence can be found
|
|
|
|
[here](https://fluence.dev/). Check also our
|
|
|
|
[YouTube channel](https://www.youtube.com/@fluencelabs).
|
2022-08-18 10:16:09 +00:00
|
|
|
|
2023-02-22 07:42:26 +00:00
|
|
|
## Support
|
2022-07-15 19:43:07 +00:00
|
|
|
|
2023-06-06 20:52:27 +00:00
|
|
|
Please, file an [issue](https://github.com/fluencelabs/nox-distro/issues) if you
|
|
|
|
find a bug. You can also contact us at
|
2023-03-22 15:59:01 +00:00
|
|
|
[Discord](https://discord.com/invite/5qSnPZKh7u) or
|
|
|
|
[Telegram](https://t.me/fluence_project). We will do our best to resolve the
|
|
|
|
issue ASAP.
|
2022-06-21 08:08:30 +00:00
|
|
|
|
2023-02-22 07:42:26 +00:00
|
|
|
## Contributing
|
2022-06-21 08:08:30 +00:00
|
|
|
|
2023-03-22 15:59:01 +00:00
|
|
|
Any interested person is welcome to contribute to the project. Please, make sure
|
|
|
|
you read and follow some basic
|
2023-06-06 20:52:27 +00:00
|
|
|
[rules](https://github.com/fluencelabs/nox-distro/tree/master/CONTRIBUTING.md).
|
2023-03-22 15:59:01 +00:00
|
|
|
The Contributor License Agreement can be found
|
2023-06-06 20:52:27 +00:00
|
|
|
[here](https://github.com/fluencelabs/nox-distro/tree/master/FluenceCLA).
|
2021-06-22 10:38:59 +00:00
|
|
|
|
2023-02-22 07:42:26 +00:00
|
|
|
## License
|
2021-06-22 10:38:59 +00:00
|
|
|
|
2023-03-22 15:59:01 +00:00
|
|
|
All software code is copyright (c) Fluence Labs, Inc. under the
|
2023-06-06 20:52:27 +00:00
|
|
|
[Apache-2.0](https://github.com/fluencelabs/nox-distro/tree/master/LICENSE)
|
2023-03-22 15:59:01 +00:00
|
|
|
license.
|