Skip to content

Commit

Permalink
Add shortcode links (Velocidex#968)
Browse files Browse the repository at this point in the history
  • Loading branch information
predictiple authored Dec 19, 2024
1 parent 3298a57 commit 718f5bb
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion content/docs/clients/troubleshooting/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ weight: 80
### Debugging a remote client

In the section
[Debugging Velociraptor](/docs/deployment/troubleshooting/#debugging-velociraptor)
[Debugging Velociraptor]({{< ref "/docs/deployment/troubleshooting/#debugging-velociraptor" >}})
we explain how to bring up the debug server by providing the `--debug`
commandline, but existing clients are not normally already running with this
flag. Often we are trying to collect an artifact from a remote client and we
Expand Down
2 changes: 1 addition & 1 deletion content/docs/clients/vfs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,5 +144,5 @@ then click over multiple directories searching for these files.
To automate collection it is better to write special purpose `VQL
Artifacts` to identity the information of interest.

The [Artifacts](/docs/vql/artifacts/) section explores what Velociraptor
The [Artifacts]({{< ref "/docs/vql/artifacts/" >}}) section explores what Velociraptor
artifacts are and how we collect them.
18 changes: 9 additions & 9 deletions content/docs/deployment/clients/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ however this amounts to running the Velociraptor binary and providing it with a
client configuration file. The configuration file provides the client with
cryptographic material and settings. We saw how to generate the client
configuration file in
[this previous section](/docs/deployment/self-signed/#generate-the-configuration-file).
[this previous section]({{< ref "/docs/deployment/self-signed/#generate-the-configuration-file" >}}).

On this page we explain how to run, and optionally install, clients on the most
common platforms. There is no single "correct" way to deploy and use
Expand Down Expand Up @@ -97,7 +97,7 @@ the section [Agentless deployment](#agentless-deployment).
### Windows

The recommended way to install Velociraptor as a client on Windows is via the
release MSI which you can find on our [Downloads](/downloads/) page. Previous
release MSI which you can find on our [Downloads]({{< ref "/downloads/" >}}) page. Previous
releases can be found on the [Releases page at Github](https://github.com/Velocidex/velociraptor/releases).

An MSI is a standard Windows installer package. The benefit of using this
Expand Down Expand Up @@ -138,7 +138,7 @@ identify the location of *your* server, we can't package the configuration file
in the official release. Therefore, the official MSI does not include a valid
configuration file. You will need to modify the release MSI to include your
client configuration file, which you
[generated earlier](/docs/deployment/self-signed/#generate-the-configuration-file),
[generated earlier]({{< ref "/docs/deployment/self-signed/#generate-the-configuration-file" >}}),
and this is done through a process we call "repacking".

The official release installs the Velociraptor executable into
Expand All @@ -151,7 +151,7 @@ will be upgraded and the client configuration file will be overwritten.

The easiest way to repack the MSI package so that it includes your client config
file is by using the
[`Server.Utils.CreateMSI`](/artifact_references/pages/server.utils.createmsi/)
[`Server.Utils.CreateMSI`]({{< ref "/artifact_references/pages/server.utils.createmsi/" >}})
server artifact.

1. In the Velociraptor web GUI, simply switch to the relevant Organization, then
Expand Down Expand Up @@ -191,7 +191,7 @@ To repack the MSI with a custom config on the command line we use the `config`
command, and the `repack` subcommand, with the `--msi` flag.

In all cases we need to tell Velociraptor which MSI we want to repack (usually
it's the [official release MSI](/downloads/): either 64-bit or 32-bit) and what
it's the [official release MSI]({{< ref "/downloads/" >}}): either 64-bit or 32-bit) and what
the output file should be named.

{{< tabs >}} {{% tab name="Linux" %}}
Expand All @@ -211,7 +211,7 @@ velociraptor.exe config repack --msi velociraptor-windows.msi client.config.yaml
{{% /tab %}}
{{< /tabs >}}

If you are using Velociraptor [organizations](/docs/deployment/orgs/) ("orgs")
If you are using Velociraptor [organizations]({{< ref "/docs/deployment/orgs/" >}}) ("orgs")
then you can obtain the client configuration file for each org from the Home
page in the GUI. Ensure that you are in the `root` org so that the configs for
all orgs are accessible.
Expand Down Expand Up @@ -452,7 +452,7 @@ provide specific advice or step-by-step instructions for these tools.

Some of the additional considerations and complexities with deployments in macOS
environments are described in
[this presentation](/presentations/2022_velocon/#mac-response--the-good-the-bad-and-the-ugly).
[this presentation]({{< ref "/presentations/2022_velocon/#mac-response--the-good-the-bad-and-the-ugly" >}}).

### Linux

Expand Down Expand Up @@ -623,7 +623,7 @@ the Go 1.20 release. This means that Windows XP, Windows server 2003, and
Windows 7/Vista can no longer be built using a supported version of Go. We may
make occasional (depending on demand for it) builds for Windows 7 using an old
unsupported version of Go, but these will not be supported and may not be the
latest version. Please see [our Support Policy](/docs/overview/support/).
latest version. Please see [our Support Policy]({{< ref "/docs/overview/support/" >}}).

We also distribute 32-bit binaries for Windows but not for Linux. If you need
32-bit Linux builds you will need to build from source. You can do this easily
Expand Down Expand Up @@ -655,7 +655,7 @@ reboot. So this method is suitable for quick hunts on corporate (non roaming)
assets.

<!--
See this [blog post](/blog/html/2019/03/02/agentless_hunting_with_velociraptor.html) for details of how to deploy Velociraptor in agentless mode.
See this [blog post]({{< ref "/blog/html/2019/03/02/agentless_hunting_with_velociraptor.html" >}}) for details of how to deploy Velociraptor in agentless mode.
-->

#### Create a network share
Expand Down
2 changes: 1 addition & 1 deletion content/docs/deployment/security/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -681,7 +681,7 @@ way regardless of who launched the collection in the first place.

However this may give lower privilege users a lot of power over the
entire network. For example the artifact
[Windows.System.PowerShell](/artifact_references/pages/windows.system.powershell/) allows
[Windows.System.PowerShell]({{< ref "/artifact_references/pages/windows.system.powershell/" >}}) allows
running arbitrary shell commands on the endpoint. While this is a
useful capability in limited situations it may lead to severe
compromise if misused!
Expand Down
4 changes: 2 additions & 2 deletions content/docs/gui/hunting/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ into the hunt.

Note that I can use this technique to automatically schedule clients
into various hunts using the VQL
[label()](/vql_reference/server/label/) function. Therefore I can use
[label()]({{< ref "/vql_reference/server/label/" >}}) function. Therefore I can use
this technique to automatically add clients to various hunts based on
previous findings.

Expand Down Expand Up @@ -208,7 +208,7 @@ to keep the old collection around or just delete it.
![Hunt with additional collection](manual_hunt_3.png)

You can add collections to a hunt using the
[hunt_add()](/vql_reference/server/hunt_add/) VQL function which
[hunt_add()]({{< ref "/vql_reference/server/hunt_add/" >}}) VQL function which
allows unlimited automation around which flows are added to hunt (and
can also automate the relaunching of the collections).

Expand Down
2 changes: 1 addition & 1 deletion content/docs/server_automation/server_api/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ will use that api configuration file to connect remotely to the API
server and run the query there.

Running VQL queries through the API client is equivalent to running them in a
[notebook](/docs/vql/notebooks/) on the server.
[notebook]({{< ref "/docs/vql/notebooks/" >}}) on the server.

This can be chained to other tools and automation orchestrated with a
simple bash script:
Expand Down

0 comments on commit 718f5bb

Please sign in to comment.