summaryrefslogtreecommitdiff
path: root/docs/guide
diff options
context:
space:
mode:
authorAlexander Taylor <alex@vector35.com>2024-09-03 17:19:13 -0400
committerAlexander Taylor <alex@vector35.com>2024-09-13 10:52:48 -0400
commit590b594850ccd15b9e2cb2b0e8f3050d782647b3 (patch)
tree7d204faf40705c4f99918ecb7fca901dae0282c1 /docs/guide
parente610029c1425fdb791b3570a4397dffcad420111 (diff)
Ultimate.
Diffstat (limited to 'docs/guide')
-rw-r--r--docs/guide/enterprise/index.md20
-rw-r--r--docs/guide/index.md4
-rw-r--r--docs/guide/projects.md2
-rw-r--r--docs/guide/troubleshooting.md6
-rw-r--r--docs/guide/types/typearchives.md2
5 files changed, 17 insertions, 17 deletions
diff --git a/docs/guide/enterprise/index.md b/docs/guide/enterprise/index.md
index a5ec1486..cb568434 100644
--- a/docs/guide/enterprise/index.md
+++ b/docs/guide/enterprise/index.md
@@ -1,20 +1,20 @@
# Binary Ninja Enterprise
!!! note
- This section only applies to the `Enterprise` edition of Binary Ninja.
+ This section only applies to the Ultimate edition of Binary Ninja.
-The Enterprise edition of Binary Ninja seamlessly integrates remote collaboration functionality within the client. This includes remote project management, push/pull of analysis database and type archive snapshots, real-time chat, and more.
+The Ultimate edition of Binary Ninja seamlessly integrates remote collaboration functionality, provided by the Binary Ninja Enterprise server, within the client. This includes remote project management, push/pull of analysis database and type archive snapshots, real-time chat, and more.
## Licensing
-Opening your Enterprise client for the first time, you will be greeted by the following dialog:
+Starting Ultimate for the first time, you will be greeted by the following dialog:
![License Dialog](../../img/enterprise/license-dialog.png){: style="max-width:500px; display: block; margin: auto;"}
-If you have a *named* license, your experience should be identical to that of a Commercial client (with extra features). Click the "Used Named License..." button and select the `license.dat` that was provided when you purchased your license. This will be placed in your [user folder](../index.md#user-folder).
+If you have a *named* license, your experience should be identical to that of a Commercial edition build, but with the additional features of Ultimate. Click the "Used Named License..." button and select the `license.dat` that was provided when you purchased your license. This will be placed in your [user folder](../index.md#user-folder).
-Otherwise, the Enterprise client will need to check out a *floating* license from your Enterprise server. Enter your server location into the box and click "Connect". (All connections should happen over HTTPS and the default port is 3535.)
+Otherwise, you will need to check out a *floating* license from your Enterprise server. Enter your server location into the box and click "Connect". (All connections should happen over HTTPS and the default port is 3535.)
## Authentication
@@ -29,15 +29,15 @@ This dialog will have up to 5 fields:
* **Username**: This text box contains your username if you are logging in with an Enterprise server account (hidden if using SSO).
* **Password**: This text box contains your password if you are logging in with an Enterprise server account (hidden if using SSO).
* **Remember Me**: This checkbox will remember the settings you choose and try to log you in the same way in the future.
-* **Checkout Duration**: This drop-down provides a selection of license durations. The default is "Until I Quit", which will refresh your license every 15 minutes until you quit the Enterprise client.
+* **Checkout Duration**: This drop-down provides a selection of license durations. The default is "Until I Quit", which will refresh your license every 15 minutes until you quit Binary Ninja.
## Configuration
-The Enterprise client has a number of settings that let you change its behavior. These settings can be found in the main Settings window (`Edit -> Preferences`) within Binary Ninja. See the [Settings](../settings.md) documentation for more details.
+Binary Ninja has a number of settings that let you change how it connects to and uses the Enterprise server. These settings can be found in the main Settings window (`Edit -> Preferences`) within Binary Ninja. See the [Settings](../settings.md) documentation for more details.
## User Interface
-The Enterprise edition of Binary Ninja adds a few extra items in the user interface. These include:
+The Ultimate edition of Binary Ninja adds a few extra items in the user interface. These include:
* An extra [status indicator](#status-indicator) in the status bar
* The [Remote Dialog](#remote-dialog)
@@ -65,7 +65,7 @@ The sync button has four indicators, some of which may be hidden:
* If you see a `*` next to the number, that indicates that you have unsaved local changes that are not yet part of a snapshot.
* If this indicator is missing, it means your user does not have permission to push snapshots to the Enterprise server for this file.
* `# ↓`: This indicates the number of remote snapshots that have not yet been pulled from the Enterprise server.
-* `↻`: This indicates that the client is in the process of checking with the Enterprise server to see if there are any new snapshots available.
+* `↻`: This indicates that Binary Ninja is in the process of checking with the Enterprise server to see if there are any new snapshots available.
!!! note
Clicking this button will cause a save to occur. It's not possible to sync without having all changes in a snapshot, which requires a save.
@@ -169,7 +169,7 @@ The left-hand side of the dialog will show the conflicts in a list. The right-ha
## API Examples
-Examples of using the `collaboration` and `enterprise` APIs (which are unique to the Enterprise edition of the client) can be found bundled with the client:
+Examples of using the `collaboration` and `enterprise` APIs (which are unique to the Ultimate edition) can be found bundled with your installation:
* **macOS**: `Binary\ Ninja.app/Contents/Resources/python/binaryninja/collaboration/examples`
* **Linux**: `binaryninja/python/binaryninja/collaboration/examples`
diff --git a/docs/guide/index.md b/docs/guide/index.md
index 541b5089..d8f44780 100644
--- a/docs/guide/index.md
+++ b/docs/guide/index.md
@@ -165,11 +165,11 @@ The Recent files list can be cleared via using the Command Palette (`[CTRL] + P`
Hotkeys (macOS: `[CMD] + 0` - `[CMD] + 9`, Windows/Linux: `[CTRL] + 0` - `[CTRL + 9]`) can also be used to quickly open a file. The hotkey for a given entry will be shown on the right.
-### Commercial/Enterprise Features
+### Commercial/Ultimate Features
![new tab](../img/newtab-projects.png "New Tab Projects Version"){ width="700" }
-On Commercial and Enterprise, the New Tab file list also contains a separate tab for Recent Projects. These tabs can be docked, rearranged, split, or unified, and their split is adjustable. Layout changes will be saved.
+On Commercial and Ultimate, the New Tab file list also contains a separate tab for Recent Projects. These tabs can be docked, rearranged, split, or unified, and their split is adjustable. Layout changes will be saved.
While Projects themselves are presented in their own tab, files opened in Projects will be located in the usual Recent Files list.
diff --git a/docs/guide/projects.md b/docs/guide/projects.md
index bcb31234..0579fc2a 100644
--- a/docs/guide/projects.md
+++ b/docs/guide/projects.md
@@ -3,7 +3,7 @@
Projects provide a way to keep and organize related binaries, databases, and resources in a managed format.
???+ Important "Supported Editions"
- Projects are only available in the Commercial and Enterprise editions of Binary Ninja
+ Projects are only available in the Commercial and Ultimate editions of Binary Ninja
## Creating a Project
diff --git a/docs/guide/troubleshooting.md b/docs/guide/troubleshooting.md
index cf605b8f..ca811023 100644
--- a/docs/guide/troubleshooting.md
+++ b/docs/guide/troubleshooting.md
@@ -36,7 +36,7 @@ In addition to the above-mentioned method of disabling user-plugins, you can als
While third party plugins are not officially supported, there are a number of troubleshooting tips that can help identify the cause. The most important is to enable debug logging as suggested in the previous section. This will often highlight problems with python paths or any other issues that prevent plugins from running.
-Additionally, if you're having trouble running a plugin in headless mode (without a GUI calling directly into the core), make sure you're running the Commercial version of Binary Ninja as the Student/Non-Commercial edition does not support headless processing.
+Additionally, if you're having trouble running a plugin in headless mode (without a GUI calling directly into the core), make sure you're running the Commercial or Ultimate edition of Binary Ninja as the Non-Commercial edition does not support headless processing.
Next, if running a python plugin, make sure the python requirements are met by your existing installation. Note that on Windows, the bundled python is used and python requirements should be installed either by manually copying the modules to the `plugins` [folder](./index.md#directories), or by switching to a different interpreter in the settings.
@@ -59,7 +59,7 @@ Binary Ninja will refuse to run as root on Linux and macOS platforms. You can wo
Binary Ninja currently uses SQLite for its analysis databases (`.bndb`), projects (`.bnpr`), and type archives (`.bnta`). This means it is only able to have a single instance of these open at any time.
-The message `Error while saving database snapshot: database is locked` means multiple copies are open at the same time. All instances will need to be closed and a new one opened to allow saving again (this includes syncing in Enterprise).
+The message `Error while saving database snapshot: database is locked` means multiple copies are open at the same time. All instances will need to be closed and a new one opened to allow saving again (this includes syncing to an Enterprise server).
### Large File Size
@@ -253,7 +253,7 @@ Other [analysis settings](settings.md#all-settings) can also help. Check the des
## Collaboration Issues
!!! note
- This section only applies to the `Enterprise` edition of Binary Ninja.
+ This section only applies to the Binary Ninja Ultimate edition when being used with the Enterprise server.
### Cannot Connect to Server
There are a number of reasons why you might not be able to connect to a server, including:
diff --git a/docs/guide/types/typearchives.md b/docs/guide/types/typearchives.md
index ce605c0d..d9357fd4 100644
--- a/docs/guide/types/typearchives.md
+++ b/docs/guide/types/typearchives.md
@@ -16,7 +16,7 @@ Using the context menu in the [Type List](basictypes.md#the-type-list) in Types
Attached Type Archives are remembered in saved analysis databases, and will be attached on reopen, provided the file still exists. If the Type Archive file is moved (or deleted), then the Type List will report the Type Archive as Disconnected (but still attached). You can reconnect the Type Archive by using **Connect Type Archive** and pointing Binary Ninja at the new location of the Type Archive file.
-Enterprise users can create Type Archives in Remote Projects in the same manner, and all changes made to Type Archives in Remote Projects will be automatically synced with the Collaboration Server. Updates made by you are sent immediately, whereas updates made by other users on your server are fetched periodically in the background every 30 seconds (configurable by the `collaboration.autoPollInterval` setting). Once changes have been fetched, you can pull them into your analysis in the same way as described below. You may also attach Type Archives created outside your Remote Project, but note they will not be synced to the Collaboration Server.
+Ultimate users working with an Enterprise server can create Type Archives in Remote Projects in the same manner, and all changes made to Type Archives in Remote Projects will be automatically synced with the Collaboration Server. Updates made by you are sent immediately, whereas updates made by other users on your server are fetched periodically in the background every 30 seconds (configurable by the `collaboration.autoPollInterval` setting). Once changes have been fetched, you can pull them into your analysis in the same way as described below. You may also attach Type Archives created outside your Remote Project, but note they will not be synced to the Collaboration Server.
## Managing Types