ockam icon indicating copy to clipboard operation
ockam copied to clipboard

Replace TCP port 5000 in examples&guides

Open SanjoDeundiak opened this issue 4 years ago • 4 comments

Latests MacOS release uses port 5000 for some service, therefore guides that use that port won't work

SanjoDeundiak avatar Nov 23 '21 22:11 SanjoDeundiak

Specifically, this refers to the examples in https://github.com/ockam-network/ockam/tree/develop/examples/rust and the guides in https://github.com/ockam-network/ockam/tree/develop/documentation/guides/rust and https://github.com/ockam-network/ockam/tree/develop/documentation/use-cases.

Note that you can check much of your work by doing something like this from the root of the repository. This both checks that the examples run and the. (That said, I don't know if it exhibits the issue described — I don't think so because I've been running this on up to date macOS without issues... It claims to be up to date, anyway).

$ export OCKAM_HOME=$PWD
$ tools/docs/check_documentation.sh
$ tools/docs/run_examples.sh
$ tools/docs/run_kafka_example.sh

Or, in one command: export OCKAM_HOME=$PWD && tools/docs/check_documentation.sh && tools/docs/run_examples.sh && tools/docs/run_kafka_example.sh

(@SanjoDeundiak / @mrinalwadhwa, is that missing anything?)

thomcc avatar Nov 24 '21 16:11 thomcc

There's an alternative: just toggle System Preferences / Sharing / Airplay Receiver off. Maybe the docs and examples could mention that?

hseeberger avatar Jan 13 '22 21:01 hseeberger

Hi. I'd like to tackle this (https://github.com/ockam-network/ockam/discussions/1081#discussioncomment-2389817).

I've two questions...

  • The port 5000 is hardcoded in some of the guide's images. How can I update those images?
  • It seems there are no tests (like run_examples.sh) for the 'secure remote access tunnels' guide. Should I add some?

Thanks!

Edit: (@mrinalwadhwa, who could answer this?)

neil2468 avatar Mar 21 '22 10:03 neil2468

@neil2468 Thank you for looking into this!

The port 5000 is hardcoded in some of the guide's images. How can I update those images?

The diagrams.drawio file here should have all the images that have port numbers. If you find some images that are in there, let me know.

It seems there are no tests (like run_examples.sh) for the 'secure remote access tunnels' guide. Should I add some?

That would be great!

mrinalwadhwa avatar Mar 23 '22 21:03 mrinalwadhwa

Looks like new examples (from late 2022 and 2023) are using port 5000 again. Should we close this for now @mrinalwadhwa ?

adrianbenavides avatar Apr 10 '23 11:04 adrianbenavides

I think newer versions of MacOS don't use 5000 anymore. At least, I haven't noticed any problems with it on my machine. Using more exotic ports would still be a safer option for examples/guides. Tests should generate random ports from higher numbers IMHO

SanjoDeundiak avatar Apr 10 '23 13:04 SanjoDeundiak