Improve README with instructions on installing bun and the backend providers
#588
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rafaellehmkuhl
requested review from
patrickelectric,
Williangalvani and
ES-Alexander
rafaellehmkuhl
force-pushed
the
improve-readme
branch
from
774ba14
to
4e9e7de
Compare
rafaellehmkuhl
changed the title
bun following their docsbun and the backend providers
Williangalvani
requested changes
Nov 23, 2023
README.md
Outdated
|
|
||
| If you're serving `mavlink2rest` in the same machine as Cockpit, activate the checkmark for "Mavlink2Rest connection" and use `ws://0.0.0.0:8088/v1/ws/mavlink` there (if you're running a mavlink2rest version before 0.11.15, omit the `/v1` in the URL). |
There was a problem hiding this comment.
Suggested change
| If you're serving `mavlink2rest` in the same machine as Cockpit, activate the checkmark for "Mavlink2Rest connection" and use `ws://0.0.0.0:8088/v1/ws/mavlink` there (if you're running a mavlink2rest version before 0.11.15, omit the `/v1` in the URL). | |
| If you're serving `mavlink2rest` in the same machine as Cockpit, activate the checkmark for "Mavlink2Rest connection" and use `ws://127.0.0.1:8088/v1/ws/mavlink` there (if you're running a mavlink2rest version before 0.11.15, omit the `/v1` in the URL). |
README.md
Outdated
|
|
||
| If you're serving `mavlink-camera-manager` in the same machine as Cockpit, activate the checkmark for "WebRTC connection" and use `ws://0.0.0.0:6020` there. |
There was a problem hiding this comment.
Suggested change
| If you're serving `mavlink-camera-manager` in the same machine as Cockpit, activate the checkmark for "WebRTC connection" and use `ws://0.0.0.0:6020` there. | |
| If you're serving `mavlink-camera-manager` in the same machine as Cockpit, activate the checkmark for "WebRTC connection" and use `ws://127.0.0.1:6020` there. |
There was a problem hiding this comment.
Actually it worked for Don using 0.0.0.0. Have you tested with 127.0.0.1? If so I will change.
There was a problem hiding this comment.
it works, but it doesn't mean it is right. if they are on the same machine, 127.0.0.1 will work.
There was a problem hiding this comment.
Yes yes, you're right. 0.0.0.0 usually just means "anyone" for server side. I'm just afraid for no reason haha
Will change.
ES-Alexander
approved these changes
Nov 24, 2023
rafaellehmkuhl
force-pushed
the
improve-readme
branch
from
edee5a2
to
bde31f3
Compare
rafaellehmkuhl
force-pushed
the
improve-readme
branch
from
bde31f3
to
70c507c
Compare
Williangalvani
approved these changes
Nov 24, 2023
README.md
Outdated
| 2. Run the MAVLink router, connecting it to your vehicle or [SITL instance](https://ardupilot.org/dev/docs/sitl-simulator-software-in-the-loop.html). | ||
| 3. Install [mavlink2rest](https://github.com/mavlink/mavlink2rest). | ||
| 4. Run `mavlink2rest`, pointing it to the endpoint provided by the MAVLink router. Remember to serve the API over the 6040 port by running it with `--server 127.0.0.1:6040`. |
There was a problem hiding this comment.
I dont mind servers at 0.0.0.0, as that means "bind to all interfaces available". Just connecting to 0.0.0.0 as a client that is conceptually... dubious
There was a problem hiding this comment.
I changed that one by mistake 🤦
That's exactly the case for 0.0.0.0 haha
Fixing before merging.
Good catch.
…er` connection to README.
rafaellehmkuhl
force-pushed
the
improve-readme
branch
from
70c507c
to
828f211
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It was reported by @DonLakeFlyer that
bun, when installed from Snap, has not been able to install the repository libraries.