Docs (or detailed usage help) needed

[dmnsea]

Hi.
Do you plan to add any docs to this package? Or at least usage details?

I don't know, may be most starred here has enough with basic example. I got ehco working too, but it's still not fully clear to me 😞

In example, for me next things need for clarification:

1. For each relay config there are fields:

   • listen_type
   • transport_type
     Which values here are acceptable? From readme it looks like raw, wss and mwss but is this right or there are any other values?

2. How does ehco manage tcp and udp? Does it listen to both on interface and port specified in listen field of relay config?

3. If yes, does ehco forward both tcp and udp to specified remote recievers? Does tcp traffic received by ehco goes only to tcp_remotes and udp traffic goes only to udp_remotes?

4. Do I correctly understand, that to forward only tcp traffic (for example) I need to pass empty array to udp_remotes for such relay in config? If I'm wrong then how?

5. Does web_token required only for prometheus web monitor?

6. What does exactly do ehco install? From ehco --help it's described as "install ehco systemd service". It sounds like ability to daemonize process, but what does it need exactly? Running ehco install --help outputs next:

   ehco install --help
   NAME:
      ehco install - install ehco systemd service
   
   USAGE:
      ehco install [command options] [arguments...]
   
   OPTIONS:
      --help, -h  show help (default: false)
   

   Does it need to be used as putting install right after ehco in ehco -c config.json? Or it will use some default location for config? Or what? If it gives ability to create multiple systemd services based on multiple configs (ehco install -c configN.json, where N for example is number from 1 to 5) then does it have any ability to give name for this service?

Finally, many questions and no answers found 😞

[Ehco1996]

@NEK-RA

i am sorry for late reply, i can understand that your are frustrated when you encounter these problmes, i will try to add some detail docs about ehco later( when i have enough time 🤣If you are interested in participating in the construction of the document, I would be very grateful!)

let me answer your questions one by one

For each relay config there are fields:

first of all yes! the options for both listen_type and listen_type are and only are raw wss and mwss. i add some hits in this commit

How does ehco manage tcp and udp? Does it listen to both on interface and port specified in listen field of relay config?

no, udp will only be listened to if there is a value in udp_remotes

If yes, does ehco forward both tcp and udp to specified remote recievers? Does tcp traffic received by ehco goes only to tcp_remotes and udp traffic goes only to udp_remotes?

yes,ehco goes only to tcp_remotes and udp traffic goes only to udp_remotes?

Do I correctly understand, that to forward only tcp traffic (for example) I need to pass empty array to udp_remotes for such relay in config

yes , just pass empty array to udp_remotes or just don't pass this flag

Does web_token required only for prometheus web monitor

yes and no, if you want to keep you pprof endpoint safe, you can use this flag too

What does exactly do ehco install?

ehco install just write one systemd service file to /etc/systemd/system/ehco.service, and the template is here, if you want to add multiple systemd services, you can do this manully

[dmnsea]

i am sorry for late reply

It's not a problem :)

just pass empty array to udp_remotes

Then I guess there's some unnecessary output (or bug?) - in this screen as you see tcp_remotes is empty, but ehco still printing that tcp relay started

or just don't pass this flag

Does it actual for both tcp and udp remote fields?

yes and no, if you want to keep you pprof endpoint safe, you can use this flag too

Well, I guess this part need for some explanation😅

ehco install just write one systemd service file to /etc/systemd/system/ehco.service

So to use it I need to use it in next way: ehco install my-config.json. Right?

[Ehco1996]

@NEK-RA

just pass empty array to udp_remotes

thanks, this is a bug and i fix this in a9b4ecc

Well, I guess this part need for some explanation

added some explains for this flag, but in Chinese,Given that the majority of users are Chinese, but I will soon add instructions for the English version as well

So to use it I need to use it in next way: ehco install my-config.json. Right?
no, just use ehco install , a vi editor will open for you, you just need to change the content of the file and save it

[dmnsea]

Thanks, will wait it :)

[Ehco1996]

help wanted

[Ehco1996]

closed as completed https://docs.ehco-relay.cc/