Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

JSON-RPC: Update for --jsonrpcbindip #871

Merged
merged 1 commit into from
Dec 7, 2022
Merged

JSON-RPC: Update for --jsonrpcbindip #871

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions wiki/en/Include-Shared-Commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
- `-p` or `--port` Sets the local UDP port number. Default is 22124
- `--jsonrpcport` Enables JSON-RPC API server to control the app, set TCP port number (EXPERIMENTAL, APIs might change; only accessible from localhost). Please see [the JSON-RPC API Documentation file](https://github.com/jamulussoftware/jamulus/blob/master/docs/JSON-RPC.md).
- `--jsonrpcsecretfile` Required when using `--jsonrpcport`. Sets a path to a text file containing an authentication string for getting access to the JSON-RPC API.
- `--jsonrpcbindip` The IP address the JSON-RPC server should bind to. (optional, defaults to 127.0.0.1)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The spacing looks off at least here on Github, probably as there's a tab while other places use spaces.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

None of this will render nicely. Seems like a markdown table is needed.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We used to have that and it made it even harder to read :-)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://tucc.us/u/ouchy.html

Maybe we could roll our own HTML rather than using Markdown's design.

Copy link
Contributor

@mcfnord mcfnord Dec 3, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this harder to read?

Copy link
Member

@gilgongo gilgongo Dec 3, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if it's wise to use in-line HTML (if that's what's happening - or it is working with the CSS?). Also it needs to work with https://jamulus.io/wiki/Software-Manual#command-line-options - and the Server manual - that's why it's an include.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, this is in-line HTML with a pinch of CSS. I am curious what Markdown would make, and haven't looked yet. Markdown lets HTML co-exist inline (user beware, sure), and presumably we have our own CSS such that we can tweak the standard table if need be.

Copy link
Member

@gilgongo gilgongo Dec 3, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually just tried it and the markdown doesn't look too bad (I think before we had more text in the cells so the rows looked odd or something). Just means the Client manual will have two tables but that doesn't look awful. It's easier to read. I'll give it a go.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll wait for the PR to finalise before making the change though. Making a note on my PR so I don't forget.

- `-Q` or `--qos` Sets the quality of service DS Field byte. Default is 128 (DSCP/CS4). QoS is ignored by Windows. To enable it, [see this page](QOS-Windows)
- `-t` or `--notranslation` Disable UI language translations
- `-6` or `--enableipv6` Enable IPv6 addressing (IPv4 is always enabled)
Expand Down