Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Upgrade packages + Migrate to Boostrap 5 #872

Merged
merged 1 commit into from
Jan 9, 2024
Merged

chore: Upgrade packages + Migrate to Boostrap 5 #872

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions _templates/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
{{ super() }}

<script>
$(document).ready(function(){
$('[data-toggle="popover"]').popover();
});
const popoverTriggerList = Array.from(
document.querySelectorAll('[data-bs-toggle="popover"]')
).map((el) => new bootstrap.Popover(el));
</script>

{% endblock scripts_end %}
Binary file added _vendor/pydata_sphinx_theme-0.15.1-py3-none-any.whl
View file
Open in desktop
Binary file not shown.
32 changes: 19 additions & 13 deletions conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
"sphinx_design",
"notfound.extension",
"sphinx_copybutton",
"sphinx_favicon",
]

myst_enable_extensions = [
Expand All @@ -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"

Expand All @@ -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
Expand All @@ -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 ----------------------------

Expand Down
2 changes: 1 addition & 1 deletion ingesters/win_file_follow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Download the Gravwell Windows File Follower installer:

| Ingester Name | Installer | More Info |
| :------------ | :----------- | :-------- |
| Windows File Follower | <a data-custom-class="hash-popover" href="https://update.gravwell.io/archive/5.4.3/installers/gravwell_file_follow_5.4.3.msi">Download <i class="fa-solid fa-download"></i></a>&nbsp;&nbsp;&nbsp;<a data-custom-class="hash-popover" href="javascript:void\(0\)" data-toggle="popover" data-placement="bottom" data-html="true" data-content='<code class="docutils literal notranslate"><span class="pre">4abaadbf25a512fc1dc55197da2664b8e518b0285f2d2034facd69dabe97695e</span></code>'>(SHA256)</a> | [Documentation](/ingesters/win_file_follow) |
| Windows File Follower | <a data-bs-custom-class="hash-popover" href="https://update.gravwell.io/archive/5.4.3/installers/gravwell_file_follow_5.4.3.msi">Download <i class="fa-solid fa-download"></i></a>&nbsp;&nbsp;&nbsp;<a data-bs-custom-class="hash-popover" href="javascript:void(0);" data-bs-toggle="popover" data-bs-placement="bottom" data-bs-html="true" data-bs-content='<code class="docutils literal notranslate"><span class="pre">4abaadbf25a512fc1dc55197da2664b8e518b0285f2d2034facd69dabe97695e</span></code>'>(SHA256)</a> | [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.

Expand Down
2 changes: 1 addition & 1 deletion ingesters/winevent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Download the Gravwell Windows Events installer:

| Ingester Name | Installer | More Info |
| :------------ | :----------- | :-------- |
| Windows Events | <a data-custom-class="hash-popover" href="https://update.gravwell.io/archive/5.4.3/installers/gravwell_win_events_5.4.3.msi">Download <i class="fa-solid fa-download"></i></a>&nbsp;&nbsp;&nbsp;<a data-custom-class="hash-popover" href="javascript:void\(0\)" data-toggle="popover" data-placement="bottom" data-html="true" data-content='<code class="docutils literal notranslate"><span class="pre">8e8ced912bc88cf2450ca1da920e4f4fbea797f734d5f29acb7b5048ef4952bb</span></code>'>(SHA256)</a> | [Documentation](/ingesters/winevent) |
| Windows Events | <a data-bs-custom-class="hash-popover" href="https://update.gravwell.io/archive/5.4.3/installers/gravwell_win_events_5.4.3.msi">Download <i class="fa-solid fa-download"></i></a>&nbsp;&nbsp;&nbsp;<a data-bs-custom-class="hash-popover" href="javascript:void(0);" data-bs-toggle="popover" data-bs-placement="bottom" data-bs-html="true" data-bs-content='<code class="docutils literal notranslate"><span class="pre">8e8ced912bc88cf2450ca1da920e4f4fbea797f734d5f29acb7b5048ef4952bb</span></code>'>(SHA256)</a> | [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.

Expand Down
50 changes: 38 additions & 12 deletions packages.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
Loading