Initialize README.md

[jviehhauser]

Initialize README.md

[zhuhaow]

Thanks for the explanation. The status of Specht2 is: I’m doing a full rewrite (to add some features and fix some bugs), but at the same time, as everything is working just fine for me (to some extent), I’m not highly motivated to improve it, so it has been stalled for a while. I’m not going to recommend you use Specht2 for now since there are some known issues, and I want to keep the flexibility to do a full overhaul without thinking about backward capabilities. But stay tuned, I’m going to release a more stable version soon with better documentation. (Hopefully in a month)

…

On Mar 24, 2023 at 21:01:39, Josef Viehhauser ***@***.***> wrote: Sure! At QuantCo and previously at BMW Group, my teams and I have worked extensively with jump hosts we used as gateways into specific network zones. Specht(Lite) allowed us to automatically and easily switch between these environments and port-/SOCKS5-forward. So essentially: - Define custom forwarding rules - Support for SOCKS5 and HTTP Here is an example configuration that I am currently using: # This is the local http proxy server port.# Note there is another SOCKS5 proxy server starts at port+1 automatically. port: 9090# Adapter is the remote proxy server you want to connect to adapter: # id is used to distinguish adapter when defining rules. # There is a 'direct' adapter that connect directly to target host without proxy. - id: proxy type: HTTP host: localhost port: 6116 - id: sox # SOCKS5 config (e.g. route certain addresses through it) type: socks5 host: localhost port: 6115 # Speed adapter automatically connects to all specified adapters (with given delay) # and uses the one that becomes ready first. - id: speed type: SPEED adapters: - id: proxy # Delay in milliseconds. delay: 300 - id: sox delay: 300 - id: direct delay: 0 # Disconnect after given delay without connecting to remote. - id: reject type: reject # It's very important to set a delay since some apps may try to reconnect repeatedly. delay: 300# Here defines how things should work.# Rule will be matched one by one. rule: # Forward requests based on whether the host domain matches the given regular expressions. - type: list file: ~/.SpechtLite/noproxylist adapter: direct - type: list file: ~/.SpechtLite/proxylist adapter: proxy - type: list file: ~/.SpechtLite/soxlist adapter: sox # Match all other requests. - type: all adapter: speed — Reply to this email directly, view it on GitHub <#153 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAJ2MLHFOF5MILVTIKOCZTTW5WLLHANCNFSM6AAAAAAWGQVEYU> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[zhuhaow]

Hi @jviehhauser, thanks for you interest in specht2.

Would mind share want you want from specht2? Since this is mainly written for my personal usage, I just implemented features that myself need.

[jviehhauser]

Sure! At QuantCo and previously at BMW Group, my teams and I have worked extensively with jump hosts we used as gateways into specific network zones. Specht(Lite) allowed us to automatically and easily switch between these environments and port-/SOCKS5-forward. So essentially:

• Define custom forwarding rules
• Support for SOCKS5 and HTTP

Here is an example configuration that I am currently using:

# This is the local http proxy server port.
# Note there is another SOCKS5 proxy server starts at port+1 automatically.
port: 9090
# Adapter is the remote proxy server you want to connect to
adapter:
     # id is used to distinguish adapter when defining rules.
     # There is a 'direct' adapter that connect directly to target host without proxy.
  - id: proxy
    type: HTTP
    host: localhost
    port: 6116
  - id: sox
    # SOCKS5 config (e.g. route certain addresses through it)
    type: socks5
    host: localhost
    port: 6115
  # Speed adapter automatically connects to all specified adapters (with given delay)
  # and uses the one that becomes ready first.
  - id: speed
    type: SPEED
    adapters:
      - id: proxy
        # Delay in milliseconds.
        delay: 300
      - id: sox
        delay: 300
      - id: direct
        delay: 0
  # Disconnect after given delay without connecting to remote.
  - id: reject
    type: reject
    # It's very important to set a delay since some apps may try to reconnect repeatedly.
    delay: 300
# Here defines how things should work.
# Rule will be matched one by one.
rule:
  # Forward requests based on whether the host domain matches the given regular expressions.
  - type: list
    file: ~/.SpechtLite/noproxylist
    adapter: direct
  - type: list
    file: ~/.SpechtLite/proxylist
    adapter: proxy
  - type: list
    file: ~/.SpechtLite/soxlist
    adapter: sox
  # Match all other requests.
  - type: all
    adapter: speed