Skip to content

Commit

Permalink
fix: update dockerfile env vars description (#5079)
Browse files Browse the repository at this point in the history
  • Loading branch information
farbanas authored Nov 4, 2024
1 parent c740f84 commit de4239a
Show file tree
Hide file tree
Showing 3 changed files with 90 additions and 0 deletions.
9 changes: 9 additions & 0 deletions nym-node-status-agent/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,15 @@ COPY ./ /usr/src/nym
WORKDIR /usr/src/nym/nym-node-status-agent
RUN cargo build --release

#-------------------------------------------------------------------
# The following environment variables are required at runtime:
#
# NODE_STATUS_AGENT_SERVER_ADDRESS
# NODE_STATUS_AGENT_SERVER_PORT
#
# see https://github.com/nymtech/nym/blob/develop/nym-node-status-agent/src/cli.rs for details
#-------------------------------------------------------------------

FROM ubuntu:24.04

RUN apt-get update && apt-get install -y ca-certificates
Expand Down
21 changes: 21 additions & 0 deletions nym-node-status-api/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,27 @@ WORKDIR /usr/src/nym/nym-node-status-api

RUN cargo build --release


#-------------------------------------------------------------------
# The following environment variables are required at runtime:
#
# EXPLORER_API
# NYXD
# NYM_API
# DATABASE_URL
#
# And optionally:
#
# NYM_NODE_STATUS_API_NYM_HTTP_CACHE_TTL
# NYM_NODE_STATUS_API_HTTP_PORT
# NYM_API_CLIENT_TIMEOUT
# EXPLORER_CLIENT_TIMEOUT
# NODE_STATUS_API_MONITOR_REFRESH_INTERVAL
# NODE_STATUS_API_TESTRUN_REFRESH_INTERVAL
#
# see https://github.com/nymtech/nym/blob/develop/nym-node-status-api/src/cli.rs for details
#-------------------------------------------------------------------

FROM ubuntu:24.04

RUN apt-get update && apt-get install -y ca-certificates
Expand Down
60 changes: 60 additions & 0 deletions nym-node/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,66 @@ WORKDIR /usr/src/nym/nym-node

RUN cargo build --release

#-------------------------------------------------------------------
# The following environment variables are required at runtime:
#
# NYMNODE_ACCEPT_OPERATOR_TERMS
# NYMNODE_MODE
#
# And optionally:
#
# NYMNODE_BONDING_INFORMATION_OUTPUT
# NYMNODE_DENY_INIT
# NYMNODE_INIT_ONLY
# NYMNODE_LOCAL
# NYMMONDE_WRITE_CONFIG_CHANGES
# NYMNODE_OUTPUT
#
# Host args
# NYMNODE_PUBLIC_IPS
# NYMNODE_HOSTNAME
# NYMNODE_LOCATION
#
# Http args
# NYMNODE_HTTP_BIND_ADDRESS
# NYMNODE_HTTP_LANDING_ASSETS
# NYMNODE_HTTP_ACCESS_TOKEN
# NYMNODE_HTTP_EXPOSE_SYSTEM_INFO
# NYMNODE_HTTP_EXPOSE_SYSTEM_HARDWARE
# NYMNODE_HTTP_EXPOSE_CRYPTO_HARDWARE
#
# Mixnet args
# NYMNODE_MIXNET_BIND_ADDRESS
# NYMNODE_MIXNET_ANNOUNCE_PORT
# NYMNODE_NYM_APIS
# NYMNODE_NYXD
# UNSAFE_DISABLE_NOISE
#
# Wireguard args
# NYMNODE_WG_ENABLED
# NYMNODE_WG_BIND_ADDRESS
# NYMNODE_WG_IP
# NYMNODE_WG_ANNOUNCED_PORT
# NYMNODE_WG_PRIVATE_NETWORK_PREFIX
#
# Mixnode args
# NYMNODE_VERLOC_BIND_ADDRESS
# NYMNODE_VERLOC_ANNOUNCE_PORT
#
# Entry gateway args
# NYMNODE_ENTRY_BIND_ADDRESS
# NYMNODE_ENTRY_ANNOUNCE_WS_PORT
# NYMNODE_ENTRY_ANNOUNCE_WSS_PORT
# NYMNODE_ENFORCE_ZK_NYMS
# NYMNODE_MNEMONIC
#
# Exit gateway args
# NYMNODE_UPSTREAM_EXIT_POLICY
# NYMNODE_OPEN_PROXY
#
# see https://github.com/nymtech/nym/blob/develop/nym-node/src/env.rs for details
#-------------------------------------------------------------------

FROM ubuntu:24.04

WORKDIR /nym
Expand Down

0 comments on commit de4239a

Please sign in to comment.