Enter HX API credentials to use for background processing. This feature is used to post-process acquisitions as they come in (when you are not logged into HXTool). PLEASE NOTE: These credentials are stored in the database encrypted with a static key.
46 |
47 |
48 | {{ htPanel.widgetFooter() }}
49 |
50 | {% endblock %}
--------------------------------------------------------------------------------
/static/fontawesome-free-5.7.2-web/LICENSE.txt:
--------------------------------------------------------------------------------
1 | Font Awesome Free License
2 | -------------------------
3 |
4 | Font Awesome Free is free, open source, and GPL friendly. You can use it for
5 | commercial projects, open source projects, or really almost whatever you want.
6 | Full Font Awesome Free license: https://fontawesome.com/license/free.
7 |
8 | # Icons: CC BY 4.0 License (https://creativecommons.org/licenses/by/4.0/)
9 | In the Font Awesome Free download, the CC BY 4.0 license applies to all icons
10 | packaged as SVG and JS file types.
11 |
12 | # Fonts: SIL OFL 1.1 License (https://scripts.sil.org/OFL)
13 | In the Font Awesome Free download, the SIL OFL license applies to all icons
14 | packaged as web and desktop font files.
15 |
16 | # Code: MIT License (https://opensource.org/licenses/MIT)
17 | In the Font Awesome Free download, the MIT license applies to all non-font and
18 | non-icon files.
19 |
20 | # Attribution
21 | Attribution is required by MIT, SIL OFL, and CC BY licenses. Downloaded Font
22 | Awesome Free files already contain embedded comments with sufficient
23 | attribution, so you shouldn't need to do anything additional when using these
24 | files normally.
25 |
26 | We've kept attribution comments terse, so we ask that you do not actively work
27 | to remove them from files, especially code. They're a great way for folks to
28 | learn about Font Awesome.
29 |
30 | # Brand Icons
31 | All brand icons are trademarks of their respective owners. The use of these
32 | trademarks does not indicate endorsement of the trademark holder by Font
33 | Awesome, nor vice versa. **Please do not use brand logos for any purpose except
34 | to represent the company, product, or service to which they refer.**
35 |
--------------------------------------------------------------------------------
/templates/voltron_data.html:
--------------------------------------------------------------------------------
1 | {% extends "layout.html" %}
2 | {% block title %}HXTool - Analysis data{% endblock %}
3 | {% block navlocation %}Analysis data{% endblock %}
4 | {% block content %}
5 |
6 |
47 |
48 | {{ htPanel.widgetHeader("Analysis data", panelIcon="fa-desktop") }}
49 |
95 | {{ htDropdown.widgetHeader("Select a policy", "edit_policy", "false") }}
96 | {{ htDropdown.widgetItem("full", "full", elementIcon="fa-check") }}
97 | {{ htDropdown.widgetItem("edit_delete", "edit_delete", elementIcon="fa-check") }}
98 | {{ htDropdown.widgetItem("delete", "delete", elementIcon="fa-check") }}
99 | {{ htDropdown.widgetItem("read-only", "read-only", elementIcon="fa-check") }}
100 | {{ htDropdown.widgetFooter() }}
101 |
102 | {{ htModal.widgetMiddle() }}
103 |
104 |
105 | {{ htModal.widgetFooter() }}
106 |
107 | {% endblock %}
108 |
--------------------------------------------------------------------------------
/README.CONFIG:
--------------------------------------------------------------------------------
1 | The HXTool configuration lives in conf.json, and is/should be well formatted JSON.
2 | What follows is a description of the available configuration elements.
3 |
4 | 1. "log_handlers" # You can have as many handlers in this section as you'd like.
5 | - "handler type" : { .. configuration options .. }
6 | - Valid handler types are: "rotating_file_handler" and "syslog_handler"
7 | - Valid options for both handlers:
8 | - "level" : "string; optional; The name of the logging level to use. Valid values are debug, info, warning, error and critical. Defaults to warning"
9 | - "format" : "string; optiona; The logging entry format to use when writing to this log. See https://docs.python.org/2/howto/logging.html#formatters for valid options.
10 | - Valid options for "rotating_file_handler": # See https://docs.python.org/2/library/logging.handlers.html#logging.handlers.RotatingFileHandler
11 | - "file" : "string; required; The path and file name that the log will be written to, relative paths are allowed."
12 | - "max_bytes" : long integer; optional; The file size threshold of which the file will be rolled over and a new log file created.
13 | - "backup_count" : integer; optional; The number of previous (rolled over) log files to retain.
14 | - Valid options for "syslog_handler": # See https://docs.python.org/2/library/logging.handlers.html#sysloghandler
15 | - "address" : "string; optional; The fully qualified domain name(FQDN) or IP address of the logging target. Defaults to 127.0.0.1"
16 | - "port" : integer; optional; The port with which to connect to the logging target on. Defaults to 514
17 | - "facility" : "string; optional; The name of the logging facility to use. Defaults to LOG_USER, see the above link for valid names."
18 | - "protocol" : "string; optional; The protocol with which to communicate with the logging target. Valid values are tcp or udp. Defaults to udp"
19 |
20 | 2. "network"
21 | - "ssl" : "string; required; Enable or disable SSL/TLS for the HXTool web interface. Valid values are enabled or disabled. Defaults to enabled."
22 | - "listen_address" : "string; required; The IP address with which the HXTool web interface listens on. Defaults to 0.0.0.0 (any)."
23 | - "port" : integer; required; The port with which the HXTool web interface listens on. Defaults to 8080
24 | - "session_timeout" : integer; optional; Unused (at the moment)
25 | - "proxies" : { .. "http" or "https" .. } # Note: only HTTPS will be used, and only the first entry
26 | - "https" : "string; optional; The fully qualified URN of the proxy to use when communicating with the HX controller. Valid values are https://user:password@host:port or socks5://user:password@host:port"
27 |
28 | 3. "ssl"
29 | - "cert" : "string; required if ssl is enabled in network; The path to the SSL certificate file."
30 | - "key" : "string; required if ssl is enabled in network; The path to the SSL certificate key file."
31 |
32 | 4. "headers" : { "name" : "value" .. }
33 | - "name" : "value" - string; optional; The name and value of any headers to add to any API request made to the HX controller. You can add as many as you'd like.
34 |
35 | 5. "cookies" : { "name" : "value" .. }
36 | - "name" : "value" - string; optional; The name and value of any cookies to add to any API request made to the HX controller. You can add as many as you'd like.
37 |
38 | 6 "scheduler" - Used by the scheduler.
39 | - "thread_count" : value - integer; required; The number of threads to be used by the scheduler. Defaults to null, which means the scheduler will use the number of CPUs in the system plus 1.
40 | - "defer_interval" : value - integer; required; The number of seconds the scheduler will use as a base to defer a task, i.e. bulk acquisition that hasn't completed yet.
41 |
42 | 7. "apicache" (requires background credentials set)
43 | - "enabled" : "boolean; required; Enables and disables the API cache in TinyDB"
44 | - "fetcher_interval" : "integer; number of seconds between each attempt to get new data from HX"
45 | - "updater_interval" : "integer; number of seconds between each attempt to update dirty cache records"
46 | - "objects_per_poll" : "integer; number of new objects that will be transferred for each attempt"
47 | - "max_refresh_per_run" : "integer; number of dirty objects that will be updated each attempt to update"
48 | - "refresh_interval" : "integer; age (seconds) when an object is considered to be dirty"
49 |
50 | 8. "db" (right now only for MongoDB usage)
51 | - "type" : "string; required; only acceptable value is mongodb"
52 | - "host" : "string; required; IP or FQDN of the database server"
53 | - "port" : "integer; optional; the port with which to contact the database server on, defaults vary by database type"
54 | - "user" : "string; required; username with which to authenticate with"
55 | - "password" : "string; required; password with which to authenticate with"
56 | - "auth_source" : "string; required; MongoDB only, authentication source database"
57 | - "auth_mechanism" : "string; optional; MongoDB only, the authentication mechanism to use, defaults to SCRAM-SHA-256"
58 | - "db_name" : "string; optional; The name of the database to use, defaults to hxtool"
--------------------------------------------------------------------------------