Ap misc (#164)

* Ready for review.

* Now, ready.

* Optimised images with calibre/image-actions

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Author: ninjeeter

.vitepress/sidebars/guides.ts

@@ -140,6 +140,10 @@ export const guidesSidebar: DefaultTheme.SidebarItem[] = [
             text: "Replay",
             link: "/guides/replay",
           },
+          {
+            text: "Using Environment Variables in Replay",
+            link: "/guides/replay_environment_variables",
+          },
           {
             text: "Automate",
             link: "/guides/automate",
@@ -201,6 +205,10 @@ export const guidesSidebar: DefaultTheme.SidebarItem[] = [
         text: "Contributing to the Documentation",
         link: "/guides/contributions/documentation",
       },
+      {
+        text: "Joining Caido's Discord Server",
+        link: "/guides/discord",
+      },
     ],
   },
 ];

.vitepress/sidebars/reference.ts

@@ -8,6 +8,10 @@ export const referenceSidebar: DefaultTheme.SidebarItem[] = [
         text: "Introduction",
         link: "/reference/",
       },
+      {
+        text: "Environment",
+        link: "/reference/environment",
+      },
       {
         text: "HTTPQL",
         link: "/reference/httpql",

src/_images/add_global_env_variable.png

@@ -30,6 +30,10 @@ We do not collect any data stored on your Instances nor interactions within the
 
 You can ask for support and submit feature requests through our public <a href="https://links.caido.io/www-discord" target="_blank">Discord</a> or <a href="https://links.caido.io/www-github-issues" target="_blank">Github repository</a>. Both are great places to share feedback and help improve Caido.
 
+## How do I gain access to the dedicated Discord support channels?
+
+Caido Individual and Team level subscriptions come with prioritized customer support. To access these channels, you must first [link your Discord account](/guides/discord.md).
+
 ## What is the difference between Caido CLI and Caido Desktop?
 
 The Caido CLI is self-contained binary that launches the Caido proxy (also called Instance). You can use it on remote servers or locally and access the Instance using your browser. The Caido Desktop acts a connection manager to your Instances and can also launch the Caido proxy in the background. It uses webviews to access the Instance instead of the browser.

src/_images/add_user_a_env_variable.png

@@ -0,0 +1,17 @@
+# Joining Caido's Discord Server
+
+To link your Caido account to your Discord account, visit [https://dashboard.caido.io/settings](https://dashboard.caido.io/settings) and click the `Sign in with Discord` button.
+
+<img alt="Link Discord account." src="/_images/link_discord_account.png" center/>
+
+## Customer Support
+
+If you hold an active Individual tier subscription, you will receive prioritized customer support. Once you link your Caido account to your Discord account, you will be granted the Customer role and gain access to all of the Customers channels.
+
+<img alt="Customers Discord channel." src="/_images/customers_channel.png" center/>
+
+## Team Support
+
+All Team tier subscriptions include a dedicated, private support channel. To request yours, send an email to [[email protected]](mailto:[email protected]).
+
+<img alt="Teams Discord channel." src="/_images/teams_channel.png" center/>

src/_images/create_button.png

@@ -0,0 +1,39 @@
+# Using Environment Variables in Replay
+
+When testing targets using `Replay`, you can easily switch context by leveraging your custom environments and associated variables.
+
+## Creating Environment Variables
+
+To create a new environment and define its variables, navigate to the `Environment` interface in Caido.
+
+<img alt="Environment interface." src="/_images/env_interface.png" center/>
+
+To define a new variable, click on the `+ Add` button. A new variable row will be added to the table.
+
+Next, click on the pencil icon to edit it.
+
+<img alt="Editing an environment variable." src="/_images/edit_global_env_variable.png" center/>
+
+Once you have made the desired edits, click the floppy disk icon to save the variable.
+
+<img alt="Saving an environment variable." src="/_images/save_global_env_variable.png" center/>
+
+Then, depending on if the environment is new or existing, click on either the `Create` or `Update` button in the bottom left corner of the pane.
+
+<img alt="Create button for environment variable." src="/_images/create_button.png" center/>
+
+<img alt="Update button for environment." src="/_images/update_button.png" center/>
+
+## Inserting an Environment Variable
+
+With a defined environment variable, navigate to the [Replay](/guides/replay.md) interface. Within a request editing pane, click, hold, and drag the left mouse button over the value you want to be replaced and then click the `+` button to add it as a placeholder.
+
+<img alt="Adding a placeholder in a Replay request." src="/_images/replay_placeholder.png" center/>
+
+Next, click the edit button located to the right of the placeholder. Doing so will present the `Placeholder Settings` window. Select `Environment Variable` from the top dropdown menu. Then, select the desired environment variable by name from the other dropdown menu. Click on the `Add` button to save the configuration. The addition will be reflected in the list of `Active preprocessors`.
+
+<img alt="Adding an environment variable to a Replay request." src="/_images/replay_global_variable.png" center/>
+
+Close the settings window and send the request. To verify the addition was successful, you can view the request by navigating to the [Search](/guides/search.md) interface.
+
+<img alt="Viewing the Replay request environment variable addition." src="/_images/search_env_variable_request.png" center/>

src/_images/customers_channel.png

@@ -0,0 +1,43 @@
+# Environment
+
+The `Environment` interface allows you to define and manage sets of variables that can be used to quickly switch between different contexts.
+
+<img alt="Environment interface." src="/_images/env_interface.png" center/>
+
+## Global
+
+The `Global` environment is always active within a [Project](/guides/projects.md), and all variables in this environment are accessible, regardless of the active environment selected.
+
+<img alt="Global environment." src="/_images/global_environment.png" center/>
+
+---
+
+<img alt="Adding a global environment variable." src="/_images/add_global_env_variable.png" center/>
+
+## Custom Environments
+
+The variables of any custom environments created by you will only be accessible if actively selected.
+
+<img alt="Custom environment." src="/_images/user_a_environment.png" center/>
+
+---
+
+<img alt="Selecting a custom environment." src="/_images/environment_selection.png" center/>
+
+---
+
+<img alt="Adding a custom environment variable." src="/_images/add_user_a_env_variable.png" center/>
+
+::: warning NOTE
+If a `Global` environment variable and a custom environment variable share the same name, the custom variable value will take precedence.
+:::
+
+::: info
+When creating an environment variable, you will be able to select between `Plaintext` and `Secret`. When an environment variable is `Secret`, it is obfuscated in the frontend as well as on disk.
+:::
+
+## What's next?
+
+[Learn how to use environment variables in Replay.](/guides/replay_environment_variables.md)
+
+[Learn how to resign AWS requests by defining the components of the signing key as environment variables.](/tutorials/aws_signature.md)

src/_images/edit_global_env_variable.png

@@ -135,4 +135,4 @@ The order of the rules in the Active Rules section determines the order in which
 
 ## What's next?
 
-[Learn how to create match and replace rules for three different use cases here.](/guides/match_replace.md)
+[Learn how to create match and replace rules for three different use cases.](/guides/match_replace.md)