Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
cc3e43d
Updated readme to make deprecation more prominent
pradameinhof Apr 1, 2025
806b8ff
Added creators
pradameinhof Apr 1, 2025
b9987f2
Retriggering GitHub Actions
pradameinhof Apr 1, 2025
0736820
Deprecation notice updates
pradameinhof Apr 18, 2025
f11e387
Updated index.rst
pradameinhof Apr 18, 2025
967d09f
Trigger build (empty signed commit)
pradameinhof Apr 18, 2025
fd42029
Revert "Updated index.rst"
pradameinhof Apr 23, 2025
6675198
Revert "Deprecation notice updates"
pradameinhof Apr 23, 2025
5ae0124
Re-commit with only source files
pradameinhof Apr 23, 2025
dad7cba
Merge branch 'master' of github.com:SpecterOps/BloodHound-Legacy into…
StephenHinck May 6, 2025
9ff76a0
chore: BED-5823 Update setup-node to use v4 (#738)
StephenHinck May 2, 2025
7018a01
Deprecation notice updates
pradameinhof Apr 18, 2025
bb7b2d0
Updated index.rst
pradameinhof Apr 18, 2025
3950485
Trigger build (empty signed commit)
pradameinhof Apr 18, 2025
1a84c6d
Revert "Updated index.rst"
pradameinhof Apr 23, 2025
f6c2c77
Revert "Deprecation notice updates"
pradameinhof Apr 23, 2025
56625d1
Re-commit with only source files
pradameinhof Apr 23, 2025
50bd587
Update .gitignore - don't update SharpHound.exe
pradameinhof May 8, 2025
e0565f2
Merge branch 'ReadTheDocs-Redirects' of https://github.com/pradameinh…
pradameinhof May 8, 2025
2533418
Update .gitignore - ignore all Sphinx build output files
pradameinhof May 8, 2025
c0f3e5f
Update .gitignore - another SharpHound location
pradameinhof May 8, 2025
bbad9da
Merge branch 'ReadTheDocs-Redirects' of https://github.com/pradameinh…
pradameinhof May 8, 2025
11b92e8
Fixing CSS and warning deprecation message on main page
pradameinhof May 8, 2025
bb8a65a
Update .gitignore - Reverted added lines
pradameinhof May 8, 2025
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
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ npm-debug.log
*.csv
graph.json
.DS_Store
.idea
.idea
11 changes: 11 additions & 0 deletions docs/_build/html/_static/css/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
/* Custom style for 'deprecated' admonitions */
div.admonition.deprecated {
border-left: 4px solid #e03e2d; /* Strong red border */
background-color: #ffeaea; /* Light red background */
}

/* Title bar styling */
div.admonition.deprecated .admonition-title {
background-color: #e03e2d;
color: white;
}
11 changes: 11 additions & 0 deletions docs/_static/css/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
/* Custom style for 'deprecated' admonitions */
div.admonition.deprecated {
border-left: 4px solid #e03e2d; /* Strong red border */
background-color: #ffeaea; /* Light red background */
}

/* Title bar styling */
div.admonition.deprecated .admonition-title {
background-color: #e03e2d;
color: white;
}
8 changes: 8 additions & 0 deletions docs/_templates/layout.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{% extends "!layout.html" %}

{% block extrahead %}
{{ super() }}
{% if meta is defined and meta.canonical %}
<link rel="canonical" href="{{ meta.canonical }}" />
{% endif %}
{% endblock %}
14 changes: 14 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
import sphinx_rtd_theme
extensions = [
"sphinx_rtd_theme",
"sphinx.ext.todo",
]

# Add any paths that contain templates here, relative to this directory.
Expand All @@ -51,6 +52,19 @@
#
html_theme = 'sphinx_rtd_theme'

# Canonical URL for SEO
html_context = {
"canonical_url": "https://bloodhound.specterops.io/"
}

# Static files path
html_static_path = ['_static']

# Load custom CSS so that deprecated notice boxes are displayed in red
def setup(app):
app.add_css_file('css/custom.css') # relative to _static/


# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
Expand Down
11 changes: 11 additions & 0 deletions docs/css/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
/* Custom style for 'deprecated' admonitions */
div.admonition.deprecated {
border-left: 4px solid #e03e2d; /* Strong red border */
background-color: #ffeaea; /* Light red background */
}

/* Title bar styling */
div.admonition.deprecated .admonition-title {
background-color: #e03e2d;
color: white;
}
11 changes: 7 additions & 4 deletions docs/data-analysis/bloodhound-gui.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
.. note::
This documentation applies to Legacy BloodHound and is no longer maintained.
.. admonition:: Deprecated Documentation
:class: deprecated

See up-to-date documentation for BloodHound CE here: `BloodHound Support`_
**This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).**

.. _BloodHound Support: https://support.bloodhoundenterprise.io/hc/en-us
Please use the `current BloodHound CE Documentation <https://bloodhound.specterops.io/analyze-data/bloodhound-gui/cypher-search>`_.

.. meta::
:canonical: https://bloodhound.specterops.io/analyze-data/bloodhound-gui/cypher-search

The BloodHound GUI
==================
Expand Down
11 changes: 7 additions & 4 deletions docs/data-analysis/edges.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
.. note::
This documentation applies to Legacy BloodHound and is no longer maintained.
.. admonition:: Deprecated Documentation
:class: deprecated

See up-to-date documentation for BloodHound CE here: `About BloodHound Edges`_
**This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).**

.. _About BloodHound Edges: https://support.bloodhoundenterprise.io/hc/en-us/articles/17224136169371
Please use the `current BloodHound CE Documentation <https://bloodhound.specterops.io/resources/edges/overview>`_.

.. meta::
:canonical: https://bloodhound.specterops.io/resources/edges/overview

Edges
=====
Expand Down
11 changes: 7 additions & 4 deletions docs/data-analysis/nodes.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
.. note::
This documentation applies to Legacy BloodHound and is no longer maintained.
.. admonition:: Deprecated Documentation
:class: deprecated

See up-to-date documentation for BloodHound CE here: `About BloodHound Nodes`_
**This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).**

.. _About BloodHound Nodes: https://support.bloodhoundenterprise.io/hc/en-us/articles/17605671475867
Please use the `current BloodHound CE Documentation <https://bloodhound.specterops.io/resources/nodes/overview>`_.

.. meta::
:canonical: https://bloodhound.specterops.io/resources/nodes/overview

Nodes
=====
Expand Down
11 changes: 7 additions & 4 deletions docs/data-collection/azurehound-all-flags.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
.. note::
This documentation applies to Legacy BloodHound and is no longer maintained.
.. admonition:: Deprecated Documentation
:class: deprecated

See up-to-date documentation for BloodHound CE here: `All AzureHound Community Edition Flags, Explained`_
**This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).**

.. _All AzureHound Community Edition Flags, Explained: https://support.bloodhoundenterprise.io/hc/en-us/articles/17481642843803
Please use the `current BloodHound CE Documentation <https://bloodhound.specterops.io/collect-data/ce-collection/azurehound-flags>`_.

.. meta::
:canonical: https://bloodhound.specterops.io/collect-data/ce-collection/azurehound-flags

All AzureHound Flags, Explained
===============================
Expand Down
11 changes: 7 additions & 4 deletions docs/data-collection/azurehound.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
.. note::
This documentation applies to Legacy BloodHound and is no longer maintained.
.. admonition:: Deprecated Documentation
:class: deprecated

See up-to-date documentation for BloodHound CE here: `AzureHound Community Edition`_
**This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).**

.. _AzureHound Community Edition: https://support.bloodhoundenterprise.io/hc/en-us/articles/17481394564251
Please use the `current BloodHound CE Documentation <https://bloodhound.specterops.io/collect-data/ce-collection/azurehound>`_.

.. meta::
:canonical: https://bloodhound.specterops.io/collect-data/ce-collection/azurehound

AzureHound
==========
Expand Down
11 changes: 7 additions & 4 deletions docs/data-collection/bloodhound-py.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
.. note::
This documentation applies to Legacy BloodHound and is no longer maintained.
.. admonition:: Deprecated Documentation
:class: deprecated

See up-to-date documentation for BloodHound.py here: `BloodHound.py`_
**This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).**

.. _BloodHound.py: https://github.com/dirkjanm/BloodHound.py
Please use the `current BloodHound CE Documentation <https://bloodhound.specterops.io/get-started/introduction>`_.

.. meta::
:canonical: https://bloodhound.specterops.io/get-started/introduction


BloodHound.py
Expand Down
11 changes: 7 additions & 4 deletions docs/data-collection/sharphound-all-flags.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
.. note::
This documentation applies to Legacy BloodHound and is no longer maintained.
.. admonition:: Deprecated Documentation
:class: deprecated

See up-to-date documentation for BloodHound CE here: `All SharpHound Community Edition Flags, Explained`_
**This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).**

.. _All SharpHound Community Edition Flags, Explained: https://support.bloodhoundenterprise.io/hc/en-us/articles/17481375424795
Please use the `current BloodHound CE Documentation <https://bloodhound.specterops.io/collect-data/ce-collection/sharphound-flags>`_.

.. meta::
:canonical: https://bloodhound.specterops.io/collect-data/ce-collection/sharphound-flags

All SharpHound Flags, Explained
===============================
Expand Down
12 changes: 8 additions & 4 deletions docs/data-collection/sharphound.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
.. note::
This documentation applies to Legacy BloodHound and is no longer maintained.
.. admonition:: Deprecated Documentation
:class: deprecated

See up-to-date documentation for BloodHound CE here: `SharpHound CE`_
**This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).**

Please use the `current BloodHound CE Documentation <https://bloodhound.specterops.io/collect-data/ce-collection/sharphound>`_.

.. meta::
:canonical: https://bloodhound.specterops.io/collect-data/ce-collection/sharphound

.. _SharpHound CE: https://support.bloodhoundenterprise.io/hc/en-us/articles/17481151861019

SharpHound
==========
Expand Down
11 changes: 7 additions & 4 deletions docs/further-reading/further-reading.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
.. note::
This documentation applies to Legacy BloodHound and is no longer maintained.
.. admonition:: Deprecated Documentation
:class: deprecated

See up-to-date documentation for BloodHound CE here: `BloodHound Support`_
**This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).**

.. _BloodHound Support: https://support.bloodhoundenterprise.io/hc/en-us
Please use the `current BloodHound CE Documentation <https://bloodhound.specterops.io/collect-data/ce-collection/overview>`_.

.. meta::
:canonical: https://bloodhound.specterops.io/collect-data/ce-collection/overview

Further Reading/Viewing
=======================
Expand Down
11 changes: 7 additions & 4 deletions docs/further-reading/json.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
.. note::
This documentation applies to Legacy BloodHound and is no longer maintained.
.. admonition:: Deprecated Documentation
:class: deprecated

See up-to-date documentation for BloodHound CE here: `BloodHound Support`_
**This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).**

.. _BloodHound Support: https://support.bloodhoundenterprise.io/hc/en-us
Please use the `current BloodHound CE Documentation <https://bloodhound.specterops.io/integrations/bloodhound-api/working-with-api>`_.

.. meta::
:canonical: https://bloodhound.specterops.io/integrations/bloodhound-api/working-with-api

BloodHound JSON Formats
=======================
Expand Down
12 changes: 8 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
.. note::
This documentation applies to Legacy BloodHound and is no longer maintained.
.. admonition:: Deprecated Documentation
:class: deprecated

See up-to-date documentation for BloodHound CE here: `BloodHound Support`_
**This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).**

Please use the `current BloodHound CE Documentation <https://bloodhound.specterops.io/>`_.

.. meta::
:canonical: https://bloodhound.specterops.io/

.. _BloodHound Support: https://support.bloodhoundenterprise.io/hc/en-us

BloodHound: Six Degrees of Domain Admin
=======================================
Expand Down
11 changes: 7 additions & 4 deletions docs/installation/linux.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
.. note::
This documentation applies to Legacy BloodHound and is no longer maintained.
.. admonition:: Deprecated Documentation
:class: deprecated

See up-to-date documentation for BloodHound CE here: `Install BloodHound Community Edition with Docker Compose`_
**This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).**

.. _Install BloodHound Community Edition with Docker Compose: https://support.bloodhoundenterprise.io/hc/en-us/articles/17468450058267
Please use the `current BloodHound CE Documentation <https://bloodhound.specterops.io/get-started/quickstart/community-edition-quickstart>`_.

.. meta::
:canonical: https://bloodhound.specterops.io/get-started/quickstart/community-edition-quickstart

Linux
=====
Expand Down
11 changes: 7 additions & 4 deletions docs/installation/osx.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
.. note::
This documentation applies to Legacy BloodHound and is no longer maintained.
.. admonition:: Deprecated Documentation
:class: deprecated

See up-to-date documentation for BloodHound CE here: `Install BloodHound Community Edition with Docker Compose`_
**This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).**

.. _Install BloodHound Community Edition with Docker Compose: https://support.bloodhoundenterprise.io/hc/en-us/articles/17468450058267
Please use the `current BloodHound CE Documentation <https://bloodhound.specterops.io/get-started/quickstart/community-edition-quickstart>`_.

.. meta::
:canonical: https://bloodhound.specterops.io/get-started/quickstart/community-edition-quickstart

macOS
=====
Expand Down
11 changes: 7 additions & 4 deletions docs/installation/windows.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
.. note::
This documentation applies to Legacy BloodHound and is no longer maintained.
.. admonition:: Deprecated Documentation
:class: deprecated

See up-to-date documentation for BloodHound CE here: `Install BloodHound Community Edition with Docker Compose`_
**This documentation refers to deprecated BloodHound Legacy (version 4.3, released in 2023).**

.. _Install BloodHound Community Edition with Docker Compose: https://support.bloodhoundenterprise.io/hc/en-us/articles/17468450058267
Please use the `current BloodHound CE Documentation <https://bloodhound.specterops.io/get-started/quickstart/community-edition-quickstart>`_.

.. meta::
:canonical: https://bloodhound.specterops.io/get-started/quickstart/community-edition-quickstart

Windows
=======
Expand Down
Loading