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.

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

Binja EE Server Welcome Page - Add location for settings.json file #5663

Closed
mwales opened this issue Jun 25, 2024 · 3 comments
Closed

Binja EE Server Welcome Page - Add location for settings.json file #5663

mwales opened this issue Jun 25, 2024 · 3 comments
Assignees
Labels
Component: Documentation Issue needs changes to our documentation Edition: Ultimate Effort: Low Issue should take < 1 week Impact: Low Issue is a papercut or has a good, supported workaround Type: Enhancement Issue is a small enhancement to existing functionality
Milestone

Comments

@mwales
Copy link

mwales commented Jun 25, 2024

Version and Platform (required):

  • Binary Ninja Version: Enterprise Server 1.2.208-stable
  • OS: Redhat something? / Ubuntu 20.04 for client
  • OS Version: [e.g. 22.04]
  • CPU Architecture: x64

Bug Description:
Go to Enterprise welcome page. I can download Binja from links on the page from step 1.

Step 2 should says where settings.json should go / full path. I guessed ~/.binaryninja, but I know other Linux programs use different conventions for path to settings file. So I think you should say where to put the settings file (depending on OS I presume it changes).

The comma at the end of the line doesn't work (if its the only setting in between the braces). and i assume the elipses wont work either. I was somewhat concerned that if I made my own settings.json (that is only 1 setting), would that somehow break / prevent Binja from creating it's own populated with defaults when it finally does get up and running in happy state. But my personal version of Binja looks like it never created one at all, so maybe not an issue.

Or just have settings.json get shoved into your download links and look in the folder where binaryninja is located.

@fuzyll
Copy link
Contributor

fuzyll commented Jun 25, 2024

We're actually working on an entirely new workflow for setting the initial server URL right now for the upcoming 4.1 release next month that should obviate the need for this. (It'll wind up creating the settings.json for you with the server you specify.) Keeping this issue open until we've got the fix in for this on a dev build and have modified the instructions on the server, though.

For completeness:

  • The user folder location is documented here and includes all 3 platforms.
  • Since it's a JSON file, the trailing comma will be an error if it's the last entry.
  • Creating your own one-line settings.json file of { "enterprise.server.url": "https://your-server-here.com:3535" } should be perfectly fine and not interfere with Binja making changes (assuming ownership is set properly on the file).

@fuzyll fuzyll added Type: Enhancement Issue is a small enhancement to existing functionality Component: UI Issue needs changes to the user interface Impact: High Issue adds or blocks important functionality Effort: Low Issue should take < 1 week Edition: Ultimate labels Jun 25, 2024
@fuzyll fuzyll added this to the Elysium milestone Jun 25, 2024
@CouleeApps
Copy link
Member

As of 4.1.5591 there is now an updated workflow for configuring a server when you first start, where you can enter the server url manually (or the other methods still work). That brings this down to being a documentation issue now, which should be pretty easy to resolve.

@CouleeApps CouleeApps added Component: Documentation Issue needs changes to our documentation Impact: Low Issue is a papercut or has a good, supported workaround and removed Impact: High Issue adds or blocks important functionality Component: UI Issue needs changes to the user interface labels Jun 26, 2024
@fuzyll
Copy link
Contributor

fuzyll commented Jul 15, 2024

I re-wrote step 2 of the welcome page to address the new changes we made. This should now be complete as of last Friday.

@fuzyll fuzyll closed this as completed Jul 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation Issue needs changes to our documentation Edition: Ultimate Effort: Low Issue should take < 1 week Impact: Low Issue is a papercut or has a good, supported workaround Type: Enhancement Issue is a small enhancement to existing functionality
Projects
None yet
Development

No branches or pull requests

3 participants