diff --git a/src/main/java/com/hithomelabs/CFTunnels/Config/CloudflareConfig.java b/src/main/java/com/hithomelabs/CFTunnels/Config/CloudflareConfig.java index ad280ed..8d880e3 100644 --- a/src/main/java/com/hithomelabs/CFTunnels/Config/CloudflareConfig.java +++ b/src/main/java/com/hithomelabs/CFTunnels/Config/CloudflareConfig.java @@ -3,11 +3,47 @@ package com.hithomelabs.CFTunnels.Config; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.context.annotation.Configuration; +/** + * Configuration class for Cloudflare API credentials. + * + *

Loads Cloudflare configuration from application properties + * using the {@code cloudflare.*} prefix.

+ * + *

Example configuration in application.properties:

+ *
+ * cloudflare.account-id=your-account-id
+ * cloudflare.api-key=your-api-key
+ * cloudflare.email=your@email.com
+ * 
+ * + * @see Cloudflare API Documentation + */ @Configuration @ConfigurationProperties(prefix = "cloudflare") public class CloudflareConfig { + + /** + * Cloudflare account ID. + * + *

Found in the Cloudflare Dashboard under + * Overview > Account ID

+ */ private String accountId; + + /** + * Cloudflare API Key. + * + *

Generated in Cloudflare Dashboard under + * Profile > API Tokens > Global API Key

+ */ private String apiKey; + + /** + * Cloudflare account email. + * + *

The email address associated with your + * Cloudflare account.

+ */ private String email; // Getters and Setters @@ -19,4 +55,4 @@ public class CloudflareConfig { public String getEmail() { return email; } public void setEmail(String email) { this.email = email; } -} +} \ No newline at end of file