From 431dad36edd8c55a0c32759c7b939a5d017d5c46 Mon Sep 17 00:00:00 2001 From: Jordan Wiens Date: Fri, 17 Feb 2017 15:25:26 -0500 Subject: update aur link --- docs/guide/troubleshooting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/guide') diff --git a/docs/guide/troubleshooting.md b/docs/guide/troubleshooting.md index af91f6f1..423a325c 100644 --- a/docs/guide/troubleshooting.md +++ b/docs/guide/troubleshooting.md @@ -42,7 +42,7 @@ QT_PLUGIN_PATH=./qt ./binaryninja - If the GUI launches but the license file is not valid when launched from the command-line, check that you're using the right version of Python. Only a 64-bit Python 2.7 is supported at this time. Additionally, the [personal][purchase] edition does not support headless operation. [known issues]: https://github.com/Vector35/binaryninja-api/issues?q=is%3Aissue -[libcurl-compat]: https://aur.archlinux.org/packages/libcurl-compat/ +[libcurl-compat]: https://www.archlinux.org/packages/community/x86_64/libcurl-compat/ [archrepo]: https://wiki.archlinux.org/index.php/Official_repositories [recover]: https://binary.ninja/recover.html [support]: https://binary.ninja/support.html -- cgit v1.3.1 From 27f1271083efb09efc6405f91be893ab38dad9a0 Mon Sep 17 00:00:00 2001 From: Jordan Wiens Date: Fri, 3 Mar 2017 18:10:53 -0500 Subject: add more linux troubleshooting --- docs/guide/troubleshooting.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) (limited to 'docs/guide') diff --git a/docs/guide/troubleshooting.md b/docs/guide/troubleshooting.md index 423a325c..560b0f1f 100644 --- a/docs/guide/troubleshooting.md +++ b/docs/guide/troubleshooting.md @@ -22,10 +22,18 @@ Running Binary Ninja with debug logging will make your bug report more useful. Given the diversity of Linux distributions, some work-arounds are required to run Binary Ninja on platforms that are not [officially supported][faq]. +### Headless Ubuntu + +If you're having trouble getting Binary Ninja installed in a headless server install where you want to be able to X-Forward the GUI on a remote machine, the following should meet requiremetns (for at least 14.04 LTS): + +``` +apt-get install libgl1-mesa-glx libfontconfig1 libxrender1 libegl1-mesa libxi6 libnspr4 libsm6 +``` + ### Arch Linux - - Install python2 from the [official repositories][archrepo] - - Install the [libcurl-compat] library from AUR, and run Binary Ninja via `LD_PRELOAD=libcurl.so.3 ~/binaryninja/binaryninja` + - Install python2 from the [official repositories][archrepo] (`sudo pacman -S python2`) and create a sym link: `sudo ln -s /usr/lib/libpython2.7.so.1.0 /usr/lib/libpython2.7.so.1` + - Install the [libcurl-compat] library with `sudo pacman -S libcurl-compat`, and run Binary Ninja via `LD_PRELOAD=libcurl.so.3 ~/binaryninja/binaryninja` ### KDE -- cgit v1.3.1 From 3501dd765d8ad917fb60b72f2e6983ed76eb31bc Mon Sep 17 00:00:00 2001 From: Jordan Wiens Date: Tue, 23 May 2017 20:48:42 -0400 Subject: basic plugin usage --- docs/getting-started.md | 14 ++++++++++++++ docs/guide/troubleshooting.md | 6 +++++- 2 files changed, 19 insertions(+), 1 deletion(-) (limited to 'docs/guide') diff --git a/docs/getting-started.md b/docs/getting-started.md index dbc99ae3..53aba268 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -14,6 +14,10 @@ Once the license key is installed, you can change it, back it up, or otherwise i - Linux: `~/.binaryninja` - Windows: `%APPDATA%\Binary Ninja` +## Linux Setup + +Because linux install locations can vary widely, we do not assume a Binary Ninja has been installed in any particular folder on linux. Rather, you can simply run `binaryninja/scripts/linux-setup.sh` after extracting the zip and various file associations, icons, and other settings will be set up. Run it with `-h` to see the customization options. + ## Loading Files You can load files in many ways: @@ -186,6 +190,16 @@ Note !!! Tip "Note" The current script console only supports Python at the moment, but it's fully extensible for other programming languages for advanced users who with to implement their own bindings. +## Using Plugins + +Plugins can be installed by one of two methods. First, they can be manually installed by adding the plugin (either a `.py` file or a folder implementing a python module with a `__init__.py` file) to the appropriate path: + +- OS X: `~/Library/Application Support/Binary Ninja/plugins/` +- Linux: `~/.binaryninja/plugins/` +- Windows: `%APPDATA%\Binary Ninja\plugins` + +Alternatively, plugins can be installed with the new [pluginmanager](https://api.binary.ninja/binaryninja.pluginmanager-module.html) API. + ## Preferences/Updates ![preferences >](/images/preferences.png "Preferences") diff --git a/docs/guide/troubleshooting.md b/docs/guide/troubleshooting.md index 560b0f1f..efd9fab9 100644 --- a/docs/guide/troubleshooting.md +++ b/docs/guide/troubleshooting.md @@ -3,7 +3,7 @@ ## Basics - Have you searched [known issues]? - - Is your computer powered on? + - Have you tried rebooting? (Kidding!) - Did you read all the items on this page? - Then you should contact [support]! @@ -13,6 +13,10 @@ Running Binary Ninja with debug logging will make your bug report more useful. ./binaryninja --debug --stderr-log ``` +## Plugin Troubleshooting + +While third party plugins are not officially supported, there are a number of troubleshooting tips that can help identify the cause. The most importat 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. + ## License Problems - If experiencing problems with Windows UAC permissions during an update, the easiest fix is to completely un-install and [recover][recover] the latest installer and license. Preferences are saved outside the installation folder and are preserved, though you might want to remove your [license](/getting-started/index.html#license). -- cgit v1.3.1