2023-06-06 20:52:27 +00:00
|
|
|
# Nox Distro Flavours
|
2023-02-22 07:42:26 +00:00
|
|
|
|
2023-03-08 11:47:37 +00:00
|
|
|
Each flavour is represented by a docker image tag. See the
|
2023-06-06 20:52:27 +00:00
|
|
|
[docker hub](https://hub.docker.com/r/fluencelabs/nox) and the
|
|
|
|
|
[releases](https://github.com/fluencelabs/nox-distro/releases) page.
|
2023-02-22 07:42:26 +00:00
|
|
|
|
2023-03-08 11:47:37 +00:00
|
|
|
Each flavour builds upon its previous flavour. In particular, `ipfs` has
|
|
|
|
|
everything that `minimal` has, and `rich` has everything that `minimal` and
|
|
|
|
|
`ipfs` have.
|
2023-02-22 07:42:26 +00:00
|
|
|
|
2023-03-13 07:41:53 +00:00
|
|
|
| flavour | IPFS daemon | services | binaries |
|
|
|
|
|
| ------- | ----------- | ------------------------------------------- | ------------------------------------------ |
|
|
|
|
|
| minimal | ❌ | aqua-ipfs, trust-graph, registry, connector | curl, ipfs |
|
|
|
|
|
| ipfs | ✅ | aqua-ipfs, trust-graph, registry, connector | curl, ipfs |
|
|
|
|
|
| rich | ✅ | aqua-ipfs, trust-graph, registry, connector | curl, ipfs, ceramic, bitcoin cli, geth cli |
|
2023-02-22 07:42:26 +00:00
|
|
|
|
|
|
|
|
Tag `latest` points to the latest version of `ipfs` flavour.
|
|
|
|
|
|
|
|
|
|
## minimal
|
|
|
|
|
|
2023-06-06 20:52:27 +00:00
|
|
|
It contains nox itself and some [builtin services](builtins.md). It serves as a
|
|
|
|
|
base image for all other image flavours and is intended for those who want to
|
|
|
|
|
run an IPFS node separately.
|
2023-02-22 07:42:26 +00:00
|
|
|
|
|
|
|
|
`FLUENCE_ENV_AQUA_IPFS_*` variables must be defined and point to externally
|
2023-03-08 11:47:37 +00:00
|
|
|
running IPFS daemon in order for `aqua-ipfs` to work. If not defined,
|
|
|
|
|
**aqua-ipfs builtin will be removed**.
|
2023-02-22 07:42:26 +00:00
|
|
|
|
|
|
|
|
| variable | default | description |
|
|
|
|
|
| ---------------------------------------------- | --------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
|
|
|
|
| `FLUENCE_ENV_AQUA_IPFS_EXTERNAL_API_MULTIADDR` | `/dns4/ipfs.fluence.dev/tcp/5001` | advertised to clients (eg frontend apps) to use in uploading files (`ipfs.put`), managing pins (`ipfs.pin`) etc |
|
|
|
|
|
| `FLUENCE_ENV_AQUA_IPFS_LOCAL_API_MULTIADDR` | `/dns4/ipfs.fluence.dev/tcp/5001` | used by aqua-ipfs builtin to connect to IPFS node |
|
|
|
|
|
|
|
|
|
|
## ipfs
|
|
|
|
|
|
2023-06-06 20:52:27 +00:00
|
|
|
This is a nox packaged with an
|
2023-03-08 11:47:37 +00:00
|
|
|
[IPFS node](https://docs.ipfs.io/how-to/command-line-quick-start/#take-your-node-online)
|
|
|
|
|
running inside a container.
|
2023-02-22 07:42:26 +00:00
|
|
|
|
|
|
|
|
| variable | default | description |
|
|
|
|
|
| ---------------------------------------------- | ---------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
|
|
|
|
| `IPFS_PATH` | `/config/ipfs` | IPFS node data directory |
|
|
|
|
|
| `IPFS_LOG_PATH` | `/log/ipfs` | directory where IPFS will store its logs |
|
|
|
|
|
| `IPFS_MIGRATE_FS` | `false` | automatically run [fs-repo-migrations](https://github.com/ipfs/fs-repo-migrations) on start |
|
|
|
|
|
| `IPFS_ADDRESSES_SWARM` | `/ip4/0.0.0.0/tcp/4001,/ip4/0.0.0.0/tcp/4001/ws` | IPFS swarm multiaddr |
|
|
|
|
|
| `IPFS_ADDRESSES_API` | `/ip4/0.0.0.0/tcp/5001` | IPFS API multiaddr |
|
|
|
|
|
| `IPFS_ADDRESSES_GATEWAY` | `/ip4/0.0.0.0/tcp/8080` | IPFS gateway multiaddr |
|
|
|
|
|
| `IPFS_ADDRESSES_ANNOUNCE` | `/ip4/127.0.0.1/tcp/4001,/ip4/127.0.0.1/tcp/4001/ws` | IPFS p2p multiaddr of the IPFS swarm protocol |
|
|
|
|
|
| `FLUENCE_ENV_AQUA_IPFS_EXTERNAL_API_MULTIADDR` | `/ip4/127.0.0.1/tcp/5001` | advertised to clients (eg frontend apps) to use in uploading files (`ipfs.put`), managing pins (`ipfs.pin`) etc |
|
|
|
|
|
| `FLUENCE_ENV_AQUA_IPFS_LOCAL_API_MULTIADDR` | `/ip4/127.0.0.1/tcp/5001` | used by aqua-ipfs builtin to connect to IPFS node |
|
|
|
|
|
|
|
|
|
|
## rich
|
|
|
|
|
|
2023-06-06 20:52:27 +00:00
|
|
|
This is a nox packaged with an IPFS node,
|
2023-03-08 11:47:37 +00:00
|
|
|
[Ceramic](https://developers.ceramic.network/learn/welcome/) CLI and some other
|
|
|
|
|
binaries like bitcoin-cli or
|
2023-02-22 07:42:26 +00:00
|
|
|
[geth](https://geth.ethereum.org/docs/interface/command-line-options).
|
|
|
|
|
|
|
|
|
|
| variable | default | description |
|
|
|
|
|
| ---------------------------------------------- | ---------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
|
|
|
|
| `CERAMIC_HOST` | | ceramic daemon address |
|
|
|
|
|
| `IPFS_PATH` | `/config/ipfs` | IPFS node data directory |
|
|
|
|
|
| `IPFS_LOG_PATH` | `/log/ipfs` | directory where IPFS will store its logs |
|
|
|
|
|
| `IPFS_MIGRATE_FS` | `false` | automatically run [fs-repo-migrations](https://github.com/ipfs/fs-repo-migrations) on start |
|
|
|
|
|
| `IPFS_ADDRESSES_SWARM` | `/ip4/0.0.0.0/tcp/4001,/ip4/0.0.0.0/tcp/4001/ws` | IPFS swarm multiaddr |
|
|
|
|
|
| `IPFS_ADDRESSES_API` | `/ip4/0.0.0.0/tcp/5001` | IPFS API multiaddr |
|
|
|
|
|
| `IPFS_ADDRESSES_GATEWAY` | `/ip4/0.0.0.0/tcp/8080` | IPFS gateway multiaddr |
|
|
|
|
|
| `IPFS_ADDRESSES_ANNOUNCE` | `/ip4/127.0.0.1/tcp/4001,/ip4/127.0.0.1/tcp/4001/ws` | IPFS announce multiaddr |
|
|
|
|
|
| `FLUENCE_ENV_AQUA_IPFS_EXTERNAL_API_MULTIADDR` | `/ip4/127.0.0.1/tcp/5001` | advertised to clients (eg frontend apps) to use in uploading files (`ipfs.put`), managing pins (`ipfs.pin`) etc |
|
|
|
|
|
| `FLUENCE_ENV_AQUA_IPFS_LOCAL_API_MULTIADDR` | `/ip4/127.0.0.1/tcp/5001` | used by aqua-ipfs builtin to connect to IPFS node |
|
