Fix typos and spelling errors in documentation (#1720)

Corrects various typos and spelling errors across Markdown documentation files, including README.md and files in the docs/ directory.

Changes include:
- Fixed "Production ready" to "Production-ready"
- Fixed "file based" to "file-based"
- Fixed "graphql" to "GraphQL"
- Fixed "managment" to "management"
- Fixed "MTIRE" to "MITRE"
- Fixed "starlark" to "Starlark"
- Fixed "specififed" to "specified"
- Fixed "embed files" to "embedded files"
- Fixed "UUID4" to "UUIDv4"
- Fixed "useable" to "usable"
- Fixed "initalized" to "initialized"
- Fixed "reuseable" to "reusable"
- Fixed "deploy it's" to "deploy its"
- Capitalized "Tavern C2" and "Best Beacon per Host"
- Corrected protocols to "gRPC, HTTP/1.1, and DNS"

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
Co-authored-by: KCarretto <16250309+KCarretto@users.noreply.github.com>

Author: KCarretto

README.md

@@ -33,7 +33,7 @@ Want to get involved? [Join our Discord!](https://discord.gg/W4cfwWRNZK)
 
 ## Quick Start
 
-*To deploy a production ready instance see the [setup guide](https://docs.realm.pub/admin-guide/tavern).*
+*To deploy a production-ready instance see the [setup guide](https://docs.realm.pub/admin-guide/tavern).*
 
 ```bash
 # Clone Realm
@@ -55,15 +55,15 @@ cd realm/implants/imix && cargo run
 - Written in Rust with support for MacOS, Linux, and Windows.
 - Supports long running tasks by reading output from tasks in real time.
 - Interval callback times.
-- Simple file based configuration.
+- Simple file-based configuration.
 - Embedded files.
 - Built-in interpreter.
 
 ### Server (tavern)
 
 - Web interface.
 - Group actions.
-- graphql backend for easy API access.
+- GraphQL backend for easy API access.
 - OAuth login support.
 - Cloud native deployment with pre-made terraform for production deployments.
 

docs/_docs/admin-guide/tavern.md

@@ -14,7 +14,7 @@ If you would like to help contribute to Tavern, please take a look at our [open
 
 ## Deployment
 
-This section will walk you through deploying a production ready instance of Tavern to GCP. If you're just looking to play around with Tavern, feel free to run the [docker image (spellshift/tavern:latest)](https://hub.docker.com/r/spellshift/tavern) locally.
+This section will walk you through deploying a production-ready instance of Tavern to GCP. If you're just looking to play around with Tavern, feel free to run the [docker image (spellshift/tavern:latest)](https://hub.docker.com/r/spellshift/tavern) locally.
 
 ### 1. Create a GCP Project
 

docs/_docs/dev-guide/imix.md

@@ -51,24 +51,24 @@ And add a new enum definition to `tavern/internal/c2/c2pb/enum_<MESSAGE NAME>_<E
 
 ## Host Selector
 
-The host selector defined in `implants/lib/host_unique` allows imix to reliably identify which host it's running on. This is helpful for operators when creating tasking across multiple beacons as well as when searching for command results. Uniqueness is stored as a UUID4 value.
+The host selector defined in `implants/lib/host_unique` allows imix to reliably identify which host it's running on. This is helpful for operators when creating tasking across multiple beacons as well as when searching for command results. Uniqueness is stored as a UUIDv4 value.
 
 Out of the box realm comes with two options `File` and `Env` to determine what host it's on.
 
-`File` will create a file on disk that stores the UUID4 Eg. Linux:
+`File` will create a file on disk that stores the UUIDv4 Eg. Linux:
 
 ```bash
 [~]$ cat /etc/system-id
 36b3c472-d19b-46cc-b3e6-ee6fd8da5b9c
 ```
 
-`Env` will read from the agent environment variables looking for `IMIX_HOST_ID` if it's set it will use the UUID4 string set there.
+`Env` will read from the agent environment variables looking for `IMIX_HOST_ID` if it's set it will use the UUIDv4 string set there.
 
 There is a third option available on Windows systems to store the UUID value inside a registry key. Follow the steps below to update `lib.rs` to include `Registry` as a default before `File` to enable it. On hosts that are not Windows, imix will simply skip `Registry`.
 
-If no selectors succeed a random UUID4 ID will be generated and used for the bot. This should be avoided.
+If no selectors succeed a random UUIDv4 ID will be generated and used for the bot. This should be avoided.
 
-## Develop A Host Uniqueness Selector
+## Develop a Host Uniqueness Selector
 
 To create your own:
 

docs/_docs/dev-guide/introduction.md

@@ -48,7 +48,7 @@ All code changes to Tavern must be tested. Below are some standards for test wri
 
 ##### Tavern Tests (Front End)
 
-At the time of writing, the Tavern UI is still in an early stage, and therefore minimal testing exists for it. Once the UI is considered more stable, this documentation will be updated. If the Tavern UI is useable and this documentation still exists, please [file an issue](https://github.com/spellshift/realm/issues/new?labels=documentation&title=Documentation%20Discrepancy:&body=Please%20include%20the%20location%20of%20the%20inaccurate%20documentation%20and%20a%20helpful%20description%20of%20what%20needs%20improvement.).
+At the time of writing, the Tavern UI is still in an early stage, and therefore minimal testing exists for it. Once the UI is considered more stable, this documentation will be updated. If the Tavern UI is usable and this documentation still exists, please [file an issue](https://github.com/spellshift/realm/issues/new?labels=documentation&title=Documentation%20Discrepancy:&body=Please%20include%20the%20location%20of%20the%20inaccurate%20documentation%20and%20a%20helpful%20description%20of%20what%20needs%20improvement.).
 
 ### Linear History
 

docs/_docs/dev-guide/tavern.md

@@ -194,7 +194,7 @@ For example to add Hashicorp Vault as an OIDC backend you'll need to:
 
 1. Setup an OIDC provider in vault - <https://developer.hashicorp.com/vault/docs/secrets/identity/oidc-provider>
 2. Get the relevant variables from the '.well-known/openid-configuration` endpoint: `authorization_endpoint`,`token_endpoint`,`userinfo_endpoint`,`scopes_supported`
-3. Open the `tavern/config.go` file and find where the `oauth2.Config` is initalized.
+3. Open the `tavern/config.go` file and find where the `oauth2.Config` is initialized.
 4. You'll need to change `Endpoint: google.Endpoint` to  `oauth2.Endpoint{}` and fill in the `AuthURL` and `TokenURL` with `authorization_endpoint` and `token_endpoint` respectively.
 5. Update the `cfg.userProfiles` link with the `userinfo_endpoint`
 6. Update `Scopes:` with the scopes in `scopes_supported`

docs/_docs/user-guide/getting-started.md

@@ -51,7 +51,7 @@ The warnings you see here indicate that there are settings recommended for produ
 
 ### Tavern (Redirector)
 
-If your adventure requires you to roll for stealth, Tavern's redirectors have your back! Redirectors allow you to forward traffic from multiple different IPs, Domains, and even protocols. Including GRPC, HTTP1, and DNS. Out of the box tavern c2 only uses grpc but by adding a redirector you unlock any supported protocol.
+If your adventure requires you to roll for stealth, Tavern's redirectors have your back! Redirectors allow you to forward traffic from multiple different IPs, Domains, and even protocols. Including gRPC, HTTP/1.1, and DNS. Out of the box, Tavern C2 only uses gRPC, but by adding a redirector you unlock any supported protocol.
 
 ```bash
 git clone https://github.com/spellshift/realm.git
@@ -97,7 +97,7 @@ Now from the left navigation menu, select "Create new quest".
 
 ![create-new-quest](/assets/img/user-guide/getting-started/create-new-quest.png)
 
-This view will show all of our active [Beacons](/user-guide/terminology#beacon) available for tasking. You can use the "View one beacon per host" toggle to filter and display only the best beacon per host, which prioritizes beacons with admin privileges and better transport protocols (GRPC > HTTP > DNS). This is useful when you have multiple beacons on the same host and want to task only the most capable one. For now, simply select your creatively-named [Beacon](/user-guide/terminology#beacon) and click "Continue".
+This view will show all of our active [Beacons](/user-guide/terminology#beacon) available for tasking. You can use the "View one beacon per host" toggle to filter and display only the Best Beacon per Host, which prioritizes beacons with admin privileges and better transport protocols (gRPC > HTTP > DNS). This is useful when you have multiple beacons on the same host and want to task only the most capable one. For now, simply select your creatively-named [Beacon](/user-guide/terminology#beacon) and click "Continue".
 
 #### Tome Selection
 

docs/_docs/user-guide/golem.md

@@ -72,7 +72,7 @@ name: List files # The name of your tome.
 description: List the files and directories found at the path # A description to help users understand what your tome does.
 author: hulto # Your Github username.
 support_model: FIRST_PARTY # Is this a tome that ships with Realm or not?
-tactic: RECON # Which MTIRE ATT&CK Tactic best describes this tome?
+tactic: RECON # Which MITRE ATT&CK Tactic best describes this tome?
 paramdefs: # A list of inputs the tome requires.
 - name: path # The name of the input parameter `input_params['path']`.
   type: string # The type of the input parameter.
@@ -84,7 +84,7 @@ paramdefs: # A list of inputs the tome requires.
 
 Eldritch while it looks like python is distinct and many features in python do not exist in Eldritch.
 
-For an almost complete list of syntax checkout the starlark (DSL which Eldritch is based on) docs <https://bazel.build/rules/language>
+For an almost complete list of syntax checkout the Starlark (DSL which Eldritch is based on) docs <https://bazel.build/rules/language>
 *Note: The docs may be incorrect in some places as we're using the starlark-rust implementation which doesn't always adhere to the starlark spec.*
 
 ```python

docs/_docs/user-guide/imix.md

@@ -199,7 +199,7 @@ The DNS transport enables covert C2 communication by tunneling traffic through D
 
 This transport doesn't support eldritch functions that require bi-directional streaming like reverse shell, or SOCKS5 proxying.
 
-*Note*: the uri parameter here is the dns server to communicate with. If `dns://*` is specififed the transport will attempt to use the local systems primary resolver. Custom ports can be specified with `dns://8.8.8.8:53`
+*Note*: the uri parameter here is the dns server to communicate with. If `dns://*` is specified the transport will attempt to use the local systems primary resolver. Custom ports can be specified with `dns://8.8.8.8:53`
 
 **Extra Keys Supported:**
 - `domain` - Base domain for DNS queries (e.g., `c2.example.com`)

docs/_docs/user-guide/terminology.md

@@ -28,7 +28,7 @@ Hosts are in-scope systems for the current engagement. A host can have multiple
 
 ### Quest
 
-Quests enable multi-beacon managment by taking a list of beacons and executing a tome with customized parameters against them. A quest is made up of tasks associated with a single beacon.
+Quests enable multi-beacon management by taking a list of beacons and executing a tome with customized parameters against them. A quest is made up of tasks associated with a single beacon.
 
 ### Task
 
@@ -40,4 +40,4 @@ Eldritch is our Pythonic Domain Specific Language (DSL), which can be used to pr
 
 ### Tome
 
-A Tome is a prebuilt Eldritch bundle, which includes execution instructions and embed files. Tomes are how beacon actions are defined and change their behavior at runtime. Tavern's built-in Tomes are defined [here](https://github.com/spellshift/realm/tree/main/tavern/tomes).
+A Tome is a prebuilt Eldritch bundle, which includes execution instructions and embedded files. Tomes are how beacon actions are defined and change their behavior at runtime. Tavern's built-in Tomes are defined [here](https://github.com/spellshift/realm/tree/main/tavern/tomes).

docs/_docs/user-guide/tomes.md

@@ -144,7 +144,7 @@ Writing tomes will always be specific to your use case. Different teams, differe
 
 OPSEC considerations will tend towards avoiding calls to `shell` and `exec` instead using native functions to accomplish the function.
 
-In some situations you may also wish to avoid testing on target if that's the case you should test throughly off target before launching.
+In some situations you may also wish to avoid testing on target if that's the case you should test thoroughly off target before launching.
 
 If you test off target you can leverage native functions like [`sys.get_os`](/user-guide/eldritch#sysget_os) to ensure that your tome only runs against targets it's been tested on.