nym-credential-proxy: improve naming of env vars

nym-credential-proxy/nym-credential-proxy/Dockerfile

@@ -5,9 +5,29 @@ WORKDIR /usr/src/nym/nym-credential-proxy/nym-credential-proxy
 
 RUN cargo build --release
 
+#-------------------------------------------------------------------
+# The following environment variables are required at runtime:
+#
+# NYM_CREDENTIAL_PROXY_MNEMONIC
+# NYM_CREDENTIAL_PROXY_AUTH_TOKEN
+#
+# WEBHOOK_ZK_NYMS_URL
+# WEBHOOK_ZK_NYMS_CLIENT_ID
+# WEBHOOK_ZK_NYMS_CLIENT_SECRET
+#
+# And optionally:
+#
+# NYM_CREDENTIAL_PROXY_PORT
+# NYM_CREDENTIAL_PROXY_BIND_ADDRESS
+# NYM_CREDENTIAL_PROXY_PERSISTENT_STORAGE_STORAGE
+#
+# see https://github.com/nymtech/nym/blob/develop/nym-credential-proxy/nym-credential-proxy/src/cli.rs for details
+#-------------------------------------------------------------------
+
 FROM ubuntu:24.04
 
 WORKDIR /nym
 
 COPY --from=builder /usr/src/nym/nym-credential-proxy/target/release/nym-credential-proxy ./
 ENTRYPOINT [ "/nym/nym-credential-proxy" ]
+

nym-credential-proxy/nym-credential-proxy/src/cli.rs

@@ -32,7 +32,7 @@ pub struct Cli {
     /// default: `8080`
     #[clap(
         long,
-        env = "VPN_API_PORT",
+        env = "NYM_CREDENTIAL_PROXY_PORT",
         default_value = "8080",
         default_value_if("bind_address", ArgPredicate::IsPresent, None)
     )]
@@ -40,18 +40,18 @@ pub struct Cli {
 
     /// Specifies the custom bind address value used for the api server.
     /// default: `0.0.0.0:8080`
-    #[clap(long, env = "VPN_API_BIND_ADDRESS")]
+    #[clap(long, env = "NYM_CREDENTIAL_PROXY_BIND_ADDRESS")]
     pub bind_address: Option<SocketAddr>,
 
     /// Specifies the mnemonic authorised for making deposits for "free pass" ticketbooks
-    #[clap(long, env = "VPN_API_MNEMONIC")]
+    #[clap(long, env = "NYM_CREDENTIAL_PROXY_MNEMONIC")]
     pub mnemonic: bip39::Mnemonic,
 
     /// Bearer token for accessing the http endpoints.
-    #[clap(long, env = "VPN_API_AUTH_TOKEN", alias = "http-bearer-token")]
+    #[clap(long, env = "NYM_CREDENTIAL_PROXY_AUTH_TOKEN", alias = "http-bearer-token")]
     pub(crate) http_auth_token: String,
 
-    #[clap(long, env = "VPN_API_PERSISTENT_STORAGE_STORAGE")]
+    #[clap(long, env = "NYM_CREDENTIAL_PROXY_PERSISTENT_STORAGE_STORAGE")]
     pub(crate) persistent_storage_path: Option<PathBuf>,
 }