Skip to content

refactor: rename TLS_HOST_AUTO_DETECT to AUTO_TLS for clarity #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hrntknr merged 1 commit into from
Aug 18, 2025
Merged

refactor: rename TLS_HOST_AUTO_DETECT to AUTO_TLS for clarity #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,8 +104,8 @@ For a simpler approach to publish local MCP servers over OAuth, consider [MCP Wa
| ---------------------- | -------- | ----------------------------------------------------------------------------------------------------- | ------------------------------------------------ |
| `LISTEN` | No | Server listen address | `:80` |
| `TLS_LISTEN` | No | Address to listen on for TLS | `:443` |
| `AUTO_TLS` | No | Automatically setup TLS certificates from externalURL | `true` |
Copy link

Copilot AI Aug 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The description for AUTO_TLS should be consistent with the original description. The original was 'Automatically detect TLS host from externalURL' but this shows 'Automatically setup TLS certificates from externalURL'. Consider using the original description for consistency.

Suggested change
| `AUTO_TLS` | No | Automatically setup TLS certificates from externalURL | `true` |
| `AUTO_TLS` | No | Automatically detect TLS host from externalURL | `true` |

Copilot uses AI. Check for mistakes.
| `TLS_HOST` | No | Host name for automatic TLS certificate | - |
| `TLS_HOST_AUTO_DETECT` | No | Automatically detect TLS host from externalURL | `true` |
| `TLS_DIRECTORY_URL` | No | ACME directory URL for TLS certificates | `https://acme-v02.api.letsencrypt.org/directory` |
| `TLS_ACCEPT_TOS` | No | Accept TLS terms of service | `false` |
| `DATA_PATH` | No | Data directory path | `./data` |
Expand Down Expand Up @@ -210,3 +210,7 @@ Breaking changes should be indicated by a `!` after the type/scope:
```
feat!: change authentication API to support multiple providers
```

### PR Template

- [./.github/pull_request_template.md](./.github/pull_request_template.md)
6 changes: 3 additions & 3 deletions main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ func getEnvBoolWithDefault(key string, defaultValue bool) bool {
func main() {
var listen string
var listenTLS string
var autoTLS bool
var tlsHost string
var tlsHostAutoDetect bool
var tlsDirectoryURL string
var tlsAcceptTOS bool
var dataPath string
Expand Down Expand Up @@ -76,8 +76,8 @@ func main() {
if err := mcpproxy.Run(
listen,
listenTLS,
autoTLS,
tlsHost,
tlsHostAutoDetect,
tlsDirectoryURL,
tlsAcceptTOS,
dataPath,
Expand All @@ -101,8 +101,8 @@ func main() {

rootCmd.Flags().StringVar(&listen, "listen", getEnvWithDefault("LISTEN", ":80"), "Address to listen on")
rootCmd.Flags().StringVar(&listenTLS, "listen-tls", getEnvWithDefault("TLS_LISTEN", ":443"), "Address to listen on for TLS")
rootCmd.Flags().BoolVar(&autoTLS, "auto-tls", getEnvBoolWithDefault("AUTO_TLS", true), "Automatically detect TLS host from externalURL")
rootCmd.Flags().StringVarP(&tlsHost, "tls-host", "H", getEnvWithDefault("TLS_HOST", ""), "Host name for TLS")
rootCmd.Flags().BoolVar(&tlsHostAutoDetect, "tls-host-auto-detect", getEnvBoolWithDefault("TLS_HOST_AUTO_DETECT", true), "Automatically detect TLS host from externalURL")
rootCmd.Flags().StringVar(&tlsDirectoryURL, "tls-directory-url", getEnvWithDefault("TLS_DIRECTORY_URL", "https://acme-v02.api.letsencrypt.org/directory"), "ACME directory URL for TLS certificates")
rootCmd.Flags().BoolVar(&tlsAcceptTOS, "tls-accept-tos", getEnvBoolWithDefault("TLS_ACCEPT_TOS", false), "Accept TLS terms of service")
rootCmd.Flags().StringVarP(&dataPath, "data", "d", getEnvWithDefault("DATA_PATH", "./data"), "Path to the data directory")
Expand Down
6 changes: 3 additions & 3 deletions pkg/mcp-proxy/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ var ServerShutdownTimeout = 5 * time.Second
func Run(
listen string,
listenTLS string,
autoTLS bool,
tlsHost string,
tlsHostAutoDetect bool,
tlsDirectoryURL string,
tlsAcceptTOS bool,
dataPath string,
Expand Down Expand Up @@ -188,7 +188,7 @@ func Run(
proxyRouter.SetupRoutes(router)

var tlsHostDetected bool
if tlsHostAutoDetect &&
if autoTLS &&
tlsHost == "" &&
parsedExternalURL.Scheme == "https" &&
parsedExternalURL.Host != "localhost" {
Expand All @@ -204,7 +204,7 @@ func Run(
if tlsHost != "" {
if !tlsAcceptTOS {
if tlsHostDetected {
return errors.New("TLS host is auto-detected, but tlsAcceptTOS is not set to true. Please agree to the TOS or set tlsHostAutoDetect to false")
return errors.New("TLS host is auto-detected, but tlsAcceptTOS is not set to true. Please agree to the TOS or set autoTLS to false")
} else {
return errors.New("TLS is enabled, but tlsAcceptTOS is not set to true. Please explicitly agree to the TOS")
}
Expand Down