| Name | fixinventorycore JSON |
| Version |
4.1.0
JSON |
| download |
| home_page | None |
| Summary | Keeps all the things. |
| upload_time | 2024-07-18 16:38:42 |
| maintainer | None |
| docs_url | None |
| author | Some Engineering Inc. |
| requires_python | >=3.11 |
| license | AGPLv3 |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# `fixcore`
Fix Inventory core graph platform
## Table of contents
* [Overview](#overview)
* [Usage](#usage)
* [Contact](#contact)
* [License](#license)
## Overview
The Fix Inventory graph platfrom `fixcore` is the persistance and search backend of fix. It maintains the graph
of resources and provides APIs to update and access them. Within `fixcore` there are workflows consisting of steps
that result in actions like `collect`, `cleanup` or `generate_metrics`. These actions are being received by components
like [`fixworker`](../fixworker/) and [`fixmetrics`](../fixmetrics/).
`fixcore` also provides the CLI API that [`fixshell`](../fixshell/) calls.
More information can be found in [the docs](https://inventory.fix.security/docs/concepts/components/core).
## Usage
```
--psk PSK Pre-shared key
--graphdb-server GRAPHDB_SERVER
Graph database server (default: http://localhost:8529)
--graphdb-database GRAPHDB_DATABASE
Graph database name (default: fix)
--graphdb-username GRAPHDB_USERNAME
Graph database login (default: fix)
--graphdb-password GRAPHDB_PASSWORD
Graph database password (default: "")
--graphdb-root-password GRAPHDB_ROOT_PASSWORD
Graph root database password used for creating user and database if not existent.
--graphdb-bootstrap-do-not-secure
Leave an empty root password during system setup process.
--graphdb-type GRAPHDB_TYPE
Graph database type (default: arangodb)
--graphdb-no-ssl-verify
If the connection should not be verified (default: False)
--graphdb-request-timeout GRAPHDB_REQUEST_TIMEOUT
Request timeout in seconds (default: 900)
--no-tls Disable TLS and use plain HTTP.
--cert CERT Path to a single file in PEM format containing the host certificate. If no certificate is provided, it is created using the CA.
--cert-key CERT_KEY In case a --cert is provided. Path to a file containing the private key.
--cert-key-pass CERT_KEY_PASS
In case a --cert is provided. Optional password to decrypt the private key file.
--ca-cert CA_CERT Path to a single file in PEM format containing the CA certificate.
--ca-cert-key CA_CERT_KEY
Path to a file containing the private key for the CA certificate. New certificates can be created when a CA certificate and private key is provided. Without the private key, the
CA certificate is only used for outgoing http requests.
--ca-cert-key-pass CA_CERT_KEY_PASS
Optional password to decrypt the private ca-cert-key file.
--version Print the version of fixcore and exit.
--override CONFIG_OVERRIDE [CONFIG_OVERRIDE ...], -o CONFIG_OVERRIDE [CONFIG_OVERRIDE ...]
Override configuration parameters. Format: path.to.property=value. The existing configuration will be patched with the provided values. A value can be a simple value or a comma
separated list of values if a list is required. Note: this argument allows multiple overrides separated by space. Example: --override
fixcore.api.web_hosts=localhost,some.domain fixcore.api.web_port=12345
--verbose, -v Enable verbose logging.
--debug Enable debug mode. If not defined use configuration.
--ui-path UI_PATH Path to the UI files. If not defined use configuration..
```
## Contact
If you have any questions feel free to [join our Discord](https://discord.gg/fixsecurity) or [open a GitHub issue](https://github.com/someengineering/fix/issues/new).
## License
See [LICENSE](../LICENSE) for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "fixinventorycore",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": null,
"author": "Some Engineering Inc.",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/bf/d0/1a21925f1754db1dc4341e3d9cf971ca759a373f3a1b1cfd1997c19520ff/fixinventorycore-4.1.0.tar.gz",
"platform": null,
"description": "# `fixcore`\nFix Inventory core graph platform\n\n\n## Table of contents\n\n* [Overview](#overview)\n* [Usage](#usage)\n* [Contact](#contact)\n* [License](#license)\n\n\n## Overview\nThe Fix Inventory graph platfrom `fixcore` is the persistance and search backend of fix. It maintains the graph\nof resources and provides APIs to update and access them. Within `fixcore` there are workflows consisting of steps\nthat result in actions like `collect`, `cleanup` or `generate_metrics`. These actions are being received by components\nlike [`fixworker`](../fixworker/) and [`fixmetrics`](../fixmetrics/).\n\n`fixcore` also provides the CLI API that [`fixshell`](../fixshell/) calls.\n\nMore information can be found in [the docs](https://inventory.fix.security/docs/concepts/components/core).\n\n\n## Usage\n```\n --psk PSK Pre-shared key\n --graphdb-server GRAPHDB_SERVER\n Graph database server (default: http://localhost:8529)\n --graphdb-database GRAPHDB_DATABASE\n Graph database name (default: fix)\n --graphdb-username GRAPHDB_USERNAME\n Graph database login (default: fix)\n --graphdb-password GRAPHDB_PASSWORD\n Graph database password (default: \"\")\n --graphdb-root-password GRAPHDB_ROOT_PASSWORD\n Graph root database password used for creating user and database if not existent.\n --graphdb-bootstrap-do-not-secure\n Leave an empty root password during system setup process.\n --graphdb-type GRAPHDB_TYPE\n Graph database type (default: arangodb)\n --graphdb-no-ssl-verify\n If the connection should not be verified (default: False)\n --graphdb-request-timeout GRAPHDB_REQUEST_TIMEOUT\n Request timeout in seconds (default: 900)\n --no-tls Disable TLS and use plain HTTP.\n --cert CERT Path to a single file in PEM format containing the host certificate. If no certificate is provided, it is created using the CA.\n --cert-key CERT_KEY In case a --cert is provided. Path to a file containing the private key.\n --cert-key-pass CERT_KEY_PASS\n In case a --cert is provided. Optional password to decrypt the private key file.\n --ca-cert CA_CERT Path to a single file in PEM format containing the CA certificate.\n --ca-cert-key CA_CERT_KEY\n Path to a file containing the private key for the CA certificate. New certificates can be created when a CA certificate and private key is provided. Without the private key, the\n CA certificate is only used for outgoing http requests.\n --ca-cert-key-pass CA_CERT_KEY_PASS\n Optional password to decrypt the private ca-cert-key file.\n --version Print the version of fixcore and exit.\n --override CONFIG_OVERRIDE [CONFIG_OVERRIDE ...], -o CONFIG_OVERRIDE [CONFIG_OVERRIDE ...]\n Override configuration parameters. Format: path.to.property=value. The existing configuration will be patched with the provided values. A value can be a simple value or a comma\n separated list of values if a list is required. Note: this argument allows multiple overrides separated by space. Example: --override\n fixcore.api.web_hosts=localhost,some.domain fixcore.api.web_port=12345\n --verbose, -v Enable verbose logging.\n --debug Enable debug mode. If not defined use configuration.\n --ui-path UI_PATH Path to the UI files. If not defined use configuration..\n```\n\n\n## Contact\nIf you have any questions feel free to [join our Discord](https://discord.gg/fixsecurity) or [open a GitHub issue](https://github.com/someengineering/fix/issues/new).\n\n\n## License\nSee [LICENSE](../LICENSE) for details.\n\n",
"bugtrack_url": null,
"license": "AGPLv3",
"summary": "Keeps all the things.",
"version": "4.1.0",
"project_urls": {
"Homepage": "https://inventory.fix.security"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "705fb71bf127fa3d256d7e8b6447f20768dc9b8ac498978005967d54d34e3475",
"md5": "6ad556b303a83a3819b64a7fa812cabf",
"sha256": "8d226e8497ca2be9ee1d0de06d3c0ea8e138eca073323cfa5842cde4beac8a1d"
},
"downloads": -1,
"filename": "fixinventorycore-4.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6ad556b303a83a3819b64a7fa812cabf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 6792551,
"upload_time": "2024-07-18T16:38:40",
"upload_time_iso_8601": "2024-07-18T16:38:40.475572Z",
"url": "https://files.pythonhosted.org/packages/70/5f/b71bf127fa3d256d7e8b6447f20768dc9b8ac498978005967d54d34e3475/fixinventorycore-4.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bfd01a21925f1754db1dc4341e3d9cf971ca759a373f3a1b1cfd1997c19520ff",
"md5": "6aec6f9970d1f8ae26e338ad8e941449",
"sha256": "2e5cd747e657054d6eee759704c7add72eb88d33ed6a75e1a2ec4414d2dfb6c2"
},
"downloads": -1,
"filename": "fixinventorycore-4.1.0.tar.gz",
"has_sig": false,
"md5_digest": "6aec6f9970d1f8ae26e338ad8e941449",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 6561058,
"upload_time": "2024-07-18T16:38:42",
"upload_time_iso_8601": "2024-07-18T16:38:42.182211Z",
"url": "https://files.pythonhosted.org/packages/bf/d0/1a21925f1754db1dc4341e3d9cf971ca759a373f3a1b1cfd1997c19520ff/fixinventorycore-4.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-18 16:38:42",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "fixinventorycore"
}
