diff --git a/_templates/layout.html b/_templates/layout.html index f467b6ba..62abf13b 100644 --- a/_templates/layout.html +++ b/_templates/layout.html @@ -15,9 +15,9 @@ {{ super() }} {% endblock scripts_end %} diff --git a/_vendor/pydata_sphinx_theme-0.15.1-py3-none-any.whl b/_vendor/pydata_sphinx_theme-0.15.1-py3-none-any.whl new file mode 100644 index 00000000..0bf579ff Binary files /dev/null and b/_vendor/pydata_sphinx_theme-0.15.1-py3-none-any.whl differ diff --git a/conf.py b/conf.py index 3978e5cb..4394a463 100644 --- a/conf.py +++ b/conf.py @@ -31,6 +31,7 @@ "sphinx_design", "notfound.extension", "sphinx_copybutton", + "sphinx_favicon", ] myst_enable_extensions = [ @@ -41,7 +42,7 @@ templates_path = ["_templates"] -exclude_patterns = ["README.md", "_build", "Thumbs.db", ".DS_Store", "env"] +exclude_patterns = ["README.md", "_build", "Thumbs.db", ".DS_Store", "env", "_vendor"] language = "en" @@ -56,16 +57,9 @@ html_css_files = ["css/custom.css"] html_theme_options = { "logo": { - "image_light": "images/Gravwell-Color.svg", - "image_dark": "images/Gravwell-Color-Reverse.svg", + "image_light": "_static/images/Gravwell-Color.svg", + "image_dark": "_static/images/Gravwell-Color-Reverse.svg", }, - "favicons": [ - { - "rel": "icon", - "sizes": "48x48", - "href": "favicon.ico", - }, - ], "icon_links": [ { # Label for this link @@ -89,13 +83,25 @@ }, ], "header_links_before_dropdown": 6, - "footer_items": [ - "git-commit-footer", - "copyright", + "footer_start": [ "sphinx-version", + "theme-version", ], + "footer_end": [ + "copyright", + "git-commit-footer", + ], + "navigation_with_keys": False, } +# sphinx-favicon +favicons = [ + { + "rel": "icon", + "sizes": "48x48", + "href": "favicon.ico", + }, +] # -- Gravwell Query Language Config ---------------------------- diff --git a/ingesters/win_file_follow.md b/ingesters/win_file_follow.md index 126311bc..49970196 100644 --- a/ingesters/win_file_follow.md +++ b/ingesters/win_file_follow.md @@ -14,7 +14,7 @@ Download the Gravwell Windows File Follower installer: | Ingester Name | Installer | More Info | | :------------ | :----------- | :-------- | -| Windows File Follower | Download    (SHA256) | [Documentation](/ingesters/win_file_follow) | +| Windows File Follower | Download    (SHA256) | [Documentation](/ingesters/win_file_follow) | The Gravwell Windows file follower is installed using a signed MSI package. Gravwell signs both the Windows executable and MSI installer with our private key pairs, but depending on download volumes, you may see a warning about the MSI being untrusted. This is due to the way Microsoft "weighs" files. Basically, as they see more people download and install a given package, it becomes more trustworthy. Don't worry though, we have a well audited build pipeline and we sign every package. diff --git a/ingesters/winevent.md b/ingesters/winevent.md index 69c332d8..a82d5099 100644 --- a/ingesters/winevent.md +++ b/ingesters/winevent.md @@ -49,7 +49,7 @@ Download the Gravwell Windows Events installer: | Ingester Name | Installer | More Info | | :------------ | :----------- | :-------- | -| Windows Events | Download    (SHA256) | [Documentation](/ingesters/winevent) | +| Windows Events | Download    (SHA256) | [Documentation](/ingesters/winevent) | Run the .msi installation wizard to install the Gravwell events service. On first installation the installation wizard will prompt to configure the indexer endpoint and ingest secret. Subsequent installations and/or upgrades will identify a resident configuration file and will not prompt. diff --git a/packages.nix b/packages.nix index 11e6f38d..9ff406fe 100644 --- a/packages.nix +++ b/packages.nix @@ -2,38 +2,64 @@ let # use a specific (although arbitrarily chosen) version of the Nix package collection pkgs = import (fetchTarball { url = - "https://github.com/NixOS/nixpkgs/archive/c3616ce8370f4a00e6b62af80fdaace308c13b68.tar.gz"; + "https://github.com/NixOS/nixpkgs/archive/24fe8bb4f552ad3926274d29e083b79d84707da6.tar.gz"; # the sha256 makes sure that the downloaded archive really is what it was when this # file was written - sha256 = "0cbf5y66zllj63ndlcng5jlc5fhpp7ph1ribgi989xmdplf0h1r1"; + sha256 = "1ica2sangr5daiv19bj743mysp9cs46zl1mfpy909qyamh85612p"; }) { }; custom-aspell = pkgs.aspellWithDicts (d: [ d.en d.en-computers d.en-science ]); - not-found-extension = with pkgs.python310.pkgs; + sphinx-favicon = with pkgs.python310.pkgs; buildPythonPackage rec { - pname = "sphinx_notfound_page"; - version = "0.8.3"; + pname = "sphinx_favicon"; + version = "1.0.1"; format = "wheel"; - src = fetchPypi { - inherit pname version format; - sha256 = - "c4867b345afccef72de71fb410c412540dfbb5c2de0dc06bde70b331b8f30469"; + src = pkgs.fetchurl { + url = + "https://files.pythonhosted.org/packages/92/c2/152bd6c211b847e525d2c7004fd98e3ac5baeace192716da8cd9c9ec2427/sphinx_favicon-1.0.1-py3-none-any.whl"; + hash = "sha256-fJPWtjTLTJaHzqtnqFJvBdOwJnnflOJz5RpDKC5rA0w="; }; - buildInputs = [ pkgs.python310Packages.sphinx ]; + propagatedBuildInputs = [ sphinx ]; + pythonImportsCheck = [ "sphinx_favicon" ]; + }; + + custom-pydata-sphinx-theme = with pkgs.python310.pkgs; + buildPythonPackage rec { + pname = "pydata-sphinx-theme"; + version = "0.15.1"; + + format = "wheel"; + + disabled = pythonOlder "3.8"; + + src = ./_vendor/pydata_sphinx_theme-0.15.1-py3-none-any.whl; + + propagatedBuildInputs = [ + sphinx + accessible-pygments + beautifulsoup4 + docutils + packaging + typing-extensions + ]; + + pythonImportsCheck = [ "pydata_sphinx_theme" ]; + }; pythonBundle = pkgs.python310.withPackages (ps: with ps; [ sphinx + sphinx-favicon sphinx-autobuild sphinx-copybutton myst-parser - pydata-sphinx-theme + custom-pydata-sphinx-theme sphinx-design black - not-found-extension + sphinx-notfound-page ]); in { diff --git a/quickstart/downloads.md b/quickstart/downloads.md index 8b495af9..76b9321b 100644 --- a/quickstart/downloads.md +++ b/quickstart/downloads.md @@ -4,8 +4,8 @@ | Ingester Name | Installer | More Info | | :------------ | :----------- | :-------- | -| Windows Events | Download    (SHA256) | [Documentation](/ingesters/winevent) | -| Windows File Follower | Download    (SHA256) | [Documentation](/ingesters/win_file_follow) | +| Windows Events | Download    (SHA256) | [Documentation](/ingesters/winevent) | +| Windows File Follower | Download    (SHA256) | [Documentation](/ingesters/win_file_follow) | ## Other Installers @@ -18,7 +18,7 @@ The Debian and RHEL repositories are more easily maintained than these standalon The Gravwell core installer contains the indexer and webserver frontend. You'll need a license; either get a Community Edition free license, or contact info@gravwell.io for commercial options. -Download Gravwell Core Installer Download    (SHA256) +Download Gravwell Core Installer Download    (SHA256) ### Ingesters @@ -27,24 +27,24 @@ The core suite of ingesters are available for download as installable packages. #### Current Ingester Releases | Ingester Name | Installer | More Info | | :------------ | :----------- | :-------- | -| Amazon Kinesis | Download    (SHA256) | [Documentation](/ingesters/kinesis)| -| Amazon S3 | Download    (SHA256) | [Documentation](/ingesters/s3)| -| Amazon SQS | Download    (SHA256) | [Documentation](/ingesters/sqs)| -| Apache Kafka | Download    (SHA256) | [Documentation](/ingesters/kafka)| -| Apache Kafka Federator | Download    (SHA256) | [Documentation](/ingesters/federators/kafkafederator)| -| Collectd Collector | Download    (SHA256) | [Documentation](/ingesters/collectd) | -| File Follower | Download    (SHA256) | [Documentation](/ingesters/file_follow) | -| Google PubSub | Download    (SHA256) | [Documentation](/ingesters/pubsub)| -| HTTP Ingester | Download    (SHA256) | [Documentation](/ingesters/http) | -| Ingest Federator | Download    (SHA256) | [Documentation](/ingesters/federators/federator) | -| IPMI Ingester | Download    (SHA256) | [Documentation](/ingesters/ipmi)| -| Microsoft Azure EventHub | Download    (SHA256) | [Documentation](/ingesters/eventhubs)| -| Microsoft Graph API | Download    (SHA256) | [Documentation](/ingesters/msg)| -| Netflow Capture | Download    (SHA256) | [Documentation](/ingesters/netflow) | -| Network Capture | Download    (SHA256) | [Documentation](/ingesters/pcap) | -| Office 365 Logs | Download    (SHA256) | [Documentation](/ingesters/o365)| -| Simple Relay | Download    (SHA256) | [Documentation](/ingesters/simple_relay)| -| SNMP Traps | Download    (SHA256) | [Documentation](/ingesters/snmp)| +| Amazon Kinesis | Download    (SHA256) | [Documentation](/ingesters/kinesis)| +| Amazon S3 | Download    (SHA256) | [Documentation](/ingesters/s3)| +| Amazon SQS | Download    (SHA256) | [Documentation](/ingesters/sqs)| +| Apache Kafka | Download    (SHA256) | [Documentation](/ingesters/kafka)| +| Apache Kafka Federator | Download    (SHA256) | [Documentation](/ingesters/federators/kafkafederator)| +| Collectd Collector | Download    (SHA256) | [Documentation](/ingesters/collectd) | +| File Follower | Download    (SHA256) | [Documentation](/ingesters/file_follow) | +| Google PubSub | Download    (SHA256) | [Documentation](/ingesters/pubsub)| +| HTTP Ingester | Download    (SHA256) | [Documentation](/ingesters/http) | +| Ingest Federator | Download    (SHA256) | [Documentation](/ingesters/federators/federator) | +| IPMI Ingester | Download    (SHA256) | [Documentation](/ingesters/ipmi)| +| Microsoft Azure EventHub | Download    (SHA256) | [Documentation](/ingesters/eventhubs)| +| Microsoft Graph API | Download    (SHA256) | [Documentation](/ingesters/msg)| +| Netflow Capture | Download    (SHA256) | [Documentation](/ingesters/netflow) | +| Network Capture | Download    (SHA256) | [Documentation](/ingesters/pcap) | +| Office 365 Logs | Download    (SHA256) | [Documentation](/ingesters/o365)| +| Simple Relay | Download    (SHA256) | [Documentation](/ingesters/simple_relay)| +| SNMP Traps | Download    (SHA256) | [Documentation](/ingesters/snmp)| ### Other downloads @@ -52,8 +52,8 @@ Some Gravwell components are distributed as optional additional installers, such | Component Name | Installer | More Info | | :------------- | :----------- | :-------- | -| Datastore | Download    (SHA256) | [Documentation](/distributed/frontend) | -| Cloud Archive Server | Download    (SHA256) | [Documentation](/configuration/archive) | -| Offline Replicator | Download    (SHA256) | [Documentation](/configuration/replication) | -| Load Balancer | Download    (SHA256) | [Documentation](/distributed/loadbalancer) | -| Gravwell Tools | Download    (SHA256) | [Documentation](/tools/tools)| +| Datastore | Download    (SHA256) | [Documentation](/distributed/frontend) | +| Cloud Archive Server | Download    (SHA256) | [Documentation](/configuration/archive) | +| Offline Replicator | Download    (SHA256) | [Documentation](/configuration/replication) | +| Load Balancer | Download    (SHA256) | [Documentation](/distributed/loadbalancer) | +| Gravwell Tools | Download    (SHA256) | [Documentation](/tools/tools)|