Skip to content

Commit

Permalink
Merge pull request #36 from fireeye/elazar-changes
Browse files Browse the repository at this point in the history
Update readme with additional instructions and dependencies.
  • Loading branch information
B0fH authored Nov 5, 2020
2 parents a69f651 + f417d8d commit 90d3b80
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,18 @@ To install HXTool:
- On Windows systems, pip.exe can be found in the "scripts" folder under your Python installation directory.
3. After installing the dependencies, run "python hxtool.py" from your operating system's command shell and the server will start listening to tcp port 8080 (HTTPS).
- Alternatively, on Windows, you should be able to double-click on the "hxtool.py" file.
4. Access the web user interface via a browser: https://127.0.0.1:8080 (tested with Google Chrome and Mozilla Firefox)
4. Access the web user interface via a browser: https://127.0.0.1:8080 (tested with Google Chrome and Mozilla Firefox)
5. You will need an account on the Endpoint Security (HX) controller that has either the api_admin or api_analyst role.
6. Don't forget to set the Background Processing credentials under Admin --> HXTool Settings. These credentials are used by the scheduler, and can be the same as what you have logged in with, or a separate set.

### Dependencies ###
Python 3.6 or greater (Python 2.x is deprecated, and while it may still work, it will no longer be supported.)
Python Flask library
Python Requests library
Python Pycryptodome library
Python TinyDB library
Python Pandas library
Python Pandas library
Optional: Python MongoDB library

### Configuration ###
Configuration for HXTool is held in the "conf.json" file, documentation is in README.CONFIG.
Expand Down

0 comments on commit 90d3b80

Please sign in to comment.