From 994a1f30c43c7329f4801daa2b17f0e340888f36 Mon Sep 17 00:00:00 2001 From: Sander Bruens Date: Mon, 3 Feb 2025 16:34:25 -0500 Subject: [PATCH] docs: update `x/config` references to `x/configurl` (#369) --- README.md | 4 ++-- x/examples/connectivity-app/README.md | 2 +- x/examples/fyne-proxy/main.go | 2 +- .../Mobileproxy.framework/Headers/Mobileproxy.objc.h | 4 ++-- .../Mobileproxy.framework/Headers/Mobileproxy.objc.h | 4 ++-- x/mobileproxy/README.md | 8 ++++---- x/mobileproxy/mobileproxy.go | 2 +- x/smart/README.md | 2 +- 8 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 90b58782..c1bbfe5b 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ The Outline SDK offers two types of strategies for evading DNS-based blocking: r - The [dns](https://pkg.go.dev/github.com/Jigsaw-Code/outline-sdk/dns) package can replace the resolution based on the system resolver with more resillient options: - Encrypted DNS over HTTPS (DoH) or TLS (DoT) - Alternative hosts and ports for UDP and TCP resolvers, making it possible to use resolvers that are not blocked. -- The `override` config from [x/config](https://pkg.go.dev/github.com/Jigsaw-Code/outline-sdk/x/config) with a `host` option can be used to force a specific address, +- The `override` config from [x/configurl](https://pkg.go.dev/github.com/Jigsaw-Code/outline-sdk/x/configurl) with a `host` option can be used to force a specific address, or you can implement your own Dialer that can map addresses. ### Bypass SNI-based Blocking @@ -144,7 +144,7 @@ You can find detailed steps at the tutorial [Go for beginners: Getting started]( The Outline SDK has several command-line utilities that illustrate the usage of the SDK, but are also valuable for debugging and trying the different strategies without having to build an app. They all take a `-transport` flag with a config that specifies what transport should be used to establish connections. -The config format can be found in [x/config](https://pkg.go.dev/github.com/Jigsaw-Code/outline-sdk/x/config). +The config format can be found in [x/configurl](https://pkg.go.dev/github.com/Jigsaw-Code/outline-sdk/x/configurl). ### Resolve a Domain Name diff --git a/x/examples/connectivity-app/README.md b/x/examples/connectivity-app/README.md index b0f4e335..bd08d770 100644 --- a/x/examples/connectivity-app/README.md +++ b/x/examples/connectivity-app/README.md @@ -126,7 +126,7 @@ If you just want to develop ios or android, you can run `yarn watch:ios` or `yar 1. **\[P1\]** read browser language on load, centralize language list, and only localize once 1. **\[P1\]** documentation on how to generate mobile app build credentials 1. **\[P1\]** add individual test result errors to the test result output UI -1. **\[P2\]** use x/config to parse the access key and showcase the different transports (see: https://github.com/Jigsaw-Code/outline-sdk/blob/main/x/examples/test-connectivity/main.go) +1. **\[P2\]** use x/configurl to parse the access key and showcase the different transports (see: https://github.com/Jigsaw-Code/outline-sdk/blob/main/x/examples/test-connectivity/main.go) 1. **\[P2\]** generalize request handler via generics/reflection 1. **\[P2\]** create a logo for the app 1. **\[P2\]** android-specific toggle CSS diff --git a/x/examples/fyne-proxy/main.go b/x/examples/fyne-proxy/main.go index 1b17f9f9..c686846e 100644 --- a/x/examples/fyne-proxy/main.go +++ b/x/examples/fyne-proxy/main.go @@ -191,7 +191,7 @@ func main() { container.NewVBox( widget.NewLabelWithStyle("Local address", fyne.TextAlignLeading, fyne.TextStyle{Bold: true}), addressEntry, - widget.NewRichTextFromMarkdown("**Transport config** ([format](https://pkg.go.dev/github.com/Jigsaw-Code/outline-sdk/x/config#hdr-Config_Format))"), + widget.NewRichTextFromMarkdown("**Transport config** ([format](https://pkg.go.dev/github.com/Jigsaw-Code/outline-sdk/x/configurl#hdr-Config_Format))"), configEntry, container.NewHBox(layout.NewSpacer(), startStopButton), widget.NewLabelWithStyle("Status", fyne.TextAlignLeading, fyne.TextStyle{Bold: true}), diff --git a/x/examples/web-wrapper/generated/mobileproxy.xcframework/ios-arm64/Mobileproxy.framework/Headers/Mobileproxy.objc.h b/x/examples/web-wrapper/generated/mobileproxy.xcframework/ios-arm64/Mobileproxy.framework/Headers/Mobileproxy.objc.h index 35ae2ecc..78801961 100644 --- a/x/examples/web-wrapper/generated/mobileproxy.xcframework/ios-arm64/Mobileproxy.framework/Headers/Mobileproxy.objc.h +++ b/x/examples/web-wrapper/generated/mobileproxy.xcframework/ios-arm64/Mobileproxy.framework/Headers/Mobileproxy.objc.h @@ -76,7 +76,7 @@ The function takes a timeoutSeconds number instead of a [time.Duration] so it's - (nonnull instancetype)initWithRef:(_Nonnull id)ref; /** * NewStreamDialerFromConfig creates a [StreamDialer] based on the given config. -The config format is specified in https://pkg.go.dev/github.com/Jigsaw-Code/outline-sdk/x/config#hdr-Config_Format. +The config format is specified in https://pkg.go.dev/github.com/Jigsaw-Code/outline-sdk/x/configurl#hdr-Config_Format. */ - (nullable instancetype)initFromConfig:(NSString* _Nullable)transportConfig; // skipped field StreamDialer.StreamDialer with unsupported type: github.com/Jigsaw-Code/outline-sdk/transport.StreamDialer @@ -122,7 +122,7 @@ FOUNDATION_EXPORT id _Nullable MobileproxyNewStderrLogWrit /** * NewStreamDialerFromConfig creates a [StreamDialer] based on the given config. -The config format is specified in https://pkg.go.dev/github.com/Jigsaw-Code/outline-sdk/x/config#hdr-Config_Format. +The config format is specified in https://pkg.go.dev/github.com/Jigsaw-Code/outline-sdk/x/configurl#hdr-Config_Format. */ FOUNDATION_EXPORT MobileproxyStreamDialer* _Nullable MobileproxyNewStreamDialerFromConfig(NSString* _Nullable transportConfig, NSError* _Nullable* _Nullable error); diff --git a/x/examples/web-wrapper/generated/mobileproxy.xcframework/ios-arm64_x86_64-simulator/Mobileproxy.framework/Headers/Mobileproxy.objc.h b/x/examples/web-wrapper/generated/mobileproxy.xcframework/ios-arm64_x86_64-simulator/Mobileproxy.framework/Headers/Mobileproxy.objc.h index 35ae2ecc..78801961 100644 --- a/x/examples/web-wrapper/generated/mobileproxy.xcframework/ios-arm64_x86_64-simulator/Mobileproxy.framework/Headers/Mobileproxy.objc.h +++ b/x/examples/web-wrapper/generated/mobileproxy.xcframework/ios-arm64_x86_64-simulator/Mobileproxy.framework/Headers/Mobileproxy.objc.h @@ -76,7 +76,7 @@ The function takes a timeoutSeconds number instead of a [time.Duration] so it's - (nonnull instancetype)initWithRef:(_Nonnull id)ref; /** * NewStreamDialerFromConfig creates a [StreamDialer] based on the given config. -The config format is specified in https://pkg.go.dev/github.com/Jigsaw-Code/outline-sdk/x/config#hdr-Config_Format. +The config format is specified in https://pkg.go.dev/github.com/Jigsaw-Code/outline-sdk/x/configurl#hdr-Config_Format. */ - (nullable instancetype)initFromConfig:(NSString* _Nullable)transportConfig; // skipped field StreamDialer.StreamDialer with unsupported type: github.com/Jigsaw-Code/outline-sdk/transport.StreamDialer @@ -122,7 +122,7 @@ FOUNDATION_EXPORT id _Nullable MobileproxyNewStderrLogWrit /** * NewStreamDialerFromConfig creates a [StreamDialer] based on the given config. -The config format is specified in https://pkg.go.dev/github.com/Jigsaw-Code/outline-sdk/x/config#hdr-Config_Format. +The config format is specified in https://pkg.go.dev/github.com/Jigsaw-Code/outline-sdk/x/configurl#hdr-Config_Format. */ FOUNDATION_EXPORT MobileproxyStreamDialer* _Nullable MobileproxyNewStreamDialerFromConfig(NSString* _Nullable transportConfig, NSError* _Nullable* _Nullable error); diff --git a/x/mobileproxy/README.md b/x/mobileproxy/README.md index d1b6f771..08b559cf 100644 --- a/x/mobileproxy/README.md +++ b/x/mobileproxy/README.md @@ -118,7 +118,7 @@ The function takes a timeoutSeconds number instead of a [time.Duration] so it's - (nonnull instancetype)initWithRef:(_Nonnull id)ref; /** * NewStreamDialerFromConfig creates a [StreamDialer] based on the given config. -The config format is specified in https://pkg.go.dev/github.com/Jigsaw-Code/outline-sdk/x/config#hdr-Config_Format. +The config format is specified in https://pkg.go.dev/github.com/Jigsaw-Code/outline-sdk/x/configurl#hdr-Config_Format. */ - (nullable instancetype)initFromConfig:(NSString* _Nullable)transportConfig; // skipped field StreamDialer.StreamDialer with unsupported type: github.com/Jigsaw-Code/outline-sdk/transport.StreamDialer @@ -164,7 +164,7 @@ FOUNDATION_EXPORT id _Nullable MobileproxyNewStderrLogWrit /** * NewStreamDialerFromConfig creates a [StreamDialer] based on the given config. -The config format is specified in https://pkg.go.dev/github.com/Jigsaw-Code/outline-sdk/x/config#hdr-Config_Format. +The config format is specified in https://pkg.go.dev/github.com/Jigsaw-Code/outline-sdk/x/configurl#hdr-Config_Format. */ FOUNDATION_EXPORT MobileproxyStreamDialer* _Nullable MobileproxyNewStreamDialerFromConfig(NSString* _Nullable transportConfig, NSError* _Nullable* _Nullable error); @@ -246,7 +246,7 @@ public final class StreamDialer implements Seq.Proxy { /** * NewStreamDialerFromConfig creates a [StreamDialer] based on the given config. - The config format is specified in https://pkg.go.dev/github.com/Jigsaw-Code/outline-sdk/x/config#hdr-Config_Format. + The config format is specified in https://pkg.go.dev/github.com/Jigsaw-Code/outline-sdk/x/configurl#hdr-Config_Format. */ public StreamDialer(String transportConfig) { this.refnum = __NewStreamDialerFromConfig(transportConfig); @@ -341,7 +341,7 @@ public abstract class Mobileproxy { public static native LogWriter newStderrLogWriter(); /** * NewStreamDialerFromConfig creates a [StreamDialer] based on the given config. - The config format is specified in https://pkg.go.dev/github.com/Jigsaw-Code/outline-sdk/x/config#hdr-Config_Format. + The config format is specified in https://pkg.go.dev/github.com/Jigsaw-Code/outline-sdk/x/configurl#hdr-Config_Format. */ public static native StreamDialer newStreamDialerFromConfig(String transportConfig) throws Exception; /** diff --git a/x/mobileproxy/mobileproxy.go b/x/mobileproxy/mobileproxy.go index b06d3284..4323fd6c 100644 --- a/x/mobileproxy/mobileproxy.go +++ b/x/mobileproxy/mobileproxy.go @@ -155,7 +155,7 @@ type StreamDialer struct { var configModule = configurl.NewDefaultProviders() // NewStreamDialerFromConfig creates a [StreamDialer] based on the given config. -// The config format is specified in https://pkg.go.dev/github.com/Jigsaw-Code/outline-sdk/x/config#hdr-Config_Format. +// The config format is specified in https://pkg.go.dev/github.com/Jigsaw-Code/outline-sdk/x/configurl#hdr-Config_Format. func NewStreamDialerFromConfig(transportConfig string) (*StreamDialer, error) { dialer, err := configModule.NewStreamDialer(context.Background(), transportConfig) if err != nil { diff --git a/x/smart/README.md b/x/smart/README.md index f4886b00..7455d6bd 100644 --- a/x/smart/README.md +++ b/x/smart/README.md @@ -88,7 +88,7 @@ The config that the Smart Dialer takes is in a JSON format. Here is an example: * The `tls` field specifies a list of TLS transports to test. * Each TLS transport is a string that specifies the transport to use. -* For example, `override:host=cloudflare.net|tlsfrag:1` specifies a transport that uses domain fronting with Cloudflare and TLS fragmentation. See the [config documentation](https://pkg.go.dev/github.com/Jigsaw-Code/outline-sdk/x/config#hdr-Config_Format) for details. +* For example, `override:host=cloudflare.net|tlsfrag:1` specifies a transport that uses domain fronting with Cloudflare and TLS fragmentation. See the [config documentation](https://pkg.go.dev/github.com/Jigsaw-Code/outline-sdk/x/configurl#hdr-Config_Format) for details. ### Using the Smart Dialer