Skip to content

Update all links to Runpod console to console.runpod.io #292

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.

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

Merged
merged 2 commits into from
Jun 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -475,7 +475,7 @@
"anchors": [
{
"anchor": "Console",
"href": "https://runpod.io/console/",
"href": "https://console.runpod.io/",
"icon": "code"
},
{
Expand All @@ -500,7 +500,7 @@
"links": [
{
"label": "Sign up",
"href": "https://runpod.io/console/signup"
"href": "https://console.runpod.io/signup"
}
],
"primary": {
Expand Down
8 changes: 4 additions & 4 deletions get-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ If you're new to Runpod, follow this guide to learn how to create an account, de

Start by creating a Runpod account to access GPU Pods and Serverless compute resources:

1. [Sign up here](https://www.runpod.io/console/signup).
1. [Sign up here](https://www.console.runpod.io/signup).
2. Verify your email address.
3. Set up two-factor authentication (recommended for security).

## Step 2: Deploy a Pod

Now that you've created your account, you're ready to deploy your first Pod:

1. Open the [Pods page](https://www.runpod.io/console/pods) in the web interface.
1. Open the [Pods page](https://www.console.runpod.io/pods) in the web interface.
2. Click the **Deploy** button.
3. Select **RTX 2000 Ada** from the list of graphics cards.

Expand All @@ -40,7 +40,7 @@ If you haven't set up payments yet, you'll be prompted to add a payment method a

After your Pod has finished starting up (this may take a minute or two), you can connect to it:

1. On the [Pods page](https://www.runpod.io/console/pods), find the Pod you just created and click the **Connect** button. If it's greyed out, your Pod hasn't finished starting up yet.
1. On the [Pods page](https://www.console.runpod.io/pods), find the Pod you just created and click the **Connect** button. If it's greyed out, your Pod hasn't finished starting up yet.

<Frame>
<img src="/images/192c2a1a-quickstart-connect-button.png" />
Expand All @@ -62,7 +62,7 @@ Congratulations! You just ran your first line of code using Runpod.

To avoid incurring unnecessary charges, make sure to:

1. Return to the [Pods page](https://www.runpod.io/console/pods).
1. Return to the [Pods page](https://www.console.runpod.io/pods).
2. Click the **Stop button** (square icon) to stop your Pod.
3. Confirm by clicking the **Stop Pod** button.

Expand Down
6 changes: 3 additions & 3 deletions get-started/api-keys.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Legacy API keys generated before November 11, 2024 have either Read/Write or Rea

Follow these steps to create a new Runpod API key:

1. In the Runpod console, navigate to the [Settings page](https://www.runpod.io/console/user/settings).
1. In the Runpod console, navigate to the [Settings page](https://www.console.runpod.io/user/settings).

2. Expand the **API Keys** section and select **Create API Key**.

Expand All @@ -37,15 +37,15 @@ Runpod does not store your API key, so you may wish to save it elsewhere (e.g.,

To edit an API key:

1. Navigate to the [Settings page](https://www.runpod.io/console/user/settings).
1. Navigate to the [Settings page](https://www.console.runpod.io/user/settings).
2. Under **API Keys**, select the pencil icon for the key you wish to update
3. Update the key with your desired permissions, then select **Update**.

## Enable/disable an API key

To enable/disable an API key:

1. Navigate to the [Settings page](https://www.runpod.io/console/user/settings).
1. Navigate to the [Settings page](https://www.console.runpod.io/user/settings).
2. Under **API Keys**, select the toggle for the API key you wish to enable/disable, then select **Yes** in the confirmation modal.

## Delete an API key
Expand Down
2 changes: 1 addition & 1 deletion get-started/connect-to-runpod.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Runpod offers multiple ways to connect and manage your compute resources. Choose

The Runpod console provides an intuitive web interface to launch and manage Pods, monitor resource usage, access Pod terminals, and view billing and usage history.

[Launch the Runpod console →](https://www.runpod.io/console)
[Launch the Runpod console →](https://www.console.runpod.io)

## REST API

Expand Down
4 changes: 2 additions & 2 deletions get-started/manage-accounts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ To access Runpod resources, you'll need to either create your own account or joi

## Create an account

Sign up for an account at [Runpod.io](https://www.runpod.io/console/signup).
Sign up for an account at [Runpod.io](https://www.console.runpod.io/signup).

### Convert personal account to a team account

Expand Down Expand Up @@ -79,6 +79,6 @@ Full control over the account, ideal for administrators.

## Audit logs

Runpod includes audit logs to help you understand which actions were used. Go to the [Audit logs](https://www.runpod.io/console/user/audit-logs) settings.
Runpod includes audit logs to help you understand which actions were used. Go to the [Audit logs](https://www.console.runpod.io/user/audit-logs) settings.

You can view and filter the audit logs by date range, user, resource, resource ID, and action.
2 changes: 1 addition & 1 deletion hosting/burn-testing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ When everything is verified okay, start the Runpod agent again by running
sudo systemctl start runpod
```

Then, on your [machine dashboard](https://www.runpod.io/console/host/machines), self rent your machine to ensure it's working well with most popular templates.
Then, on your [machine dashboard](https://www.console.runpod.io/host/machines), self rent your machine to ensure it's working well with most popular templates.
2 changes: 1 addition & 1 deletion hub/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Whether you're a veteran developer who wants to share your work or a newcomer ex

You can deploy a repo from the Hub in seconds:

1. Navigate to the [Hub page](https://www.runpod.io/console/hub) in the Runpod console.
1. Navigate to the [Hub page](https://www.console.runpod.io/hub) in the Runpod console.
2. Browse the collection and select a repo that matches your needs.
3. Review the repo details, including hardware requirements and available configuration options to ensure compatibility with your use case.
4. Click the **Deploy** button in the top-right of the repo page. You can also use the dropdown menu to deploy an older version.
Expand Down
15 changes: 5 additions & 10 deletions hub/publishing-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Publish your repositories to the Runpod Hub."
tag: "NEW"
---

Learn how to publish a GitHub repository to the [Runpod Hub](https://www.runpod.io/console/hub), including how to configure your repository with the required `hub.json` and `tests.json` files.
Learn how to publish your repositories to the [Runpod Hub](https://www.console.runpod.io/hub), including how to configure your repository with the required `hub.json` and `tests.json` files.

<Frame>
<img src="/images/hub-publish-page.png" />
Expand All @@ -15,15 +15,10 @@ Learn how to publish a GitHub repository to the [Runpod Hub](https://www.runpod.

Follow these steps to add your repository to the Hub:

1. Navigate to the [Hub page](https://www.runpod.io/console/hub) in the Runpod console.
2. Under **Add your repo** click **Get Started**. If you haven't linked your GitHub account to Runpod, you'll be prompted to do so.
<Warning>
To publish a repository to the Hub, you must have appropriate GitHub access permissions:
- For personal repositories: Owner or collaborator.
- For GitHub organizations: Write, maintain, or admin (or an equivelant custom role). See: [Repository roles](https://docs.github.com/en/enterprise-cloud@latest/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization) for more details.
</Warning>
3. Enter your GitHub repository URL.
4. Follow the guided steps in the interface to add your repository to the Hub.
1. Navigate to the [Hub page](https://www.console.runpod.io/hub) in the Runpod console.
2. Under **Add your repo** click **Get Started**.
3. Enter your GitHub repo URL.
4. Follow the UI steps to add your repo to the Hub.

The Hub page will guide you through the following steps:

Expand Down
6 changes: 3 additions & 3 deletions instant-clusters/axolotl.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Follow the steps below to deploy a cluster and start training your models effici

## Step 1: Deploy an Instant Cluster

1. Open the [Instant Clusters page](https://www.runpod.io/console/cluster) on the Runpod web interface.
1. Open the [Instant Clusters page](https://www.console.runpod.io/cluster) on the Runpod web interface.
2. Click **Create Cluster**.
3. Use the UI to name and configure your Cluster. For this walkthrough, keep **Pod Count** at **2** and select the option for **16x H100 SXM** GPUs. Keep the **Pod Template** at its default setting (Runpod PyTorch).
4. Click **Deploy Cluster**. You should be redirected to the Instant Clusters page after a few seconds.
Expand Down Expand Up @@ -90,11 +90,11 @@ Congrats! You've successfully trained a model using Axolotl on an Instant Cluste

## Step 4: Clean up

If you no longer need your cluster, make sure you return to the [Instant Clusters page](https://www.runpod.io/console/cluster) and delete your cluster to avoid incurring extra charges.
If you no longer need your cluster, make sure you return to the [Instant Clusters page](https://www.console.runpod.io/cluster) and delete your cluster to avoid incurring extra charges.

<Info>

You can monitor your cluster usage and spending using the **Billing Explorer** at the bottom of the [Billing page](https://www.runpod.io/console/user/billing) section under the **Cluster** tab.
You can monitor your cluster usage and spending using the **Billing Explorer** at the bottom of the [Billing page](https://www.console.runpod.io/user/billing) section under the **Cluster** tab.

</Info>

Expand Down
6 changes: 3 additions & 3 deletions instant-clusters/pytorch.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Follow the steps below to deploy a cluster and start running distributed PyTorch

## Step 1: Deploy an Instant Cluster

1. Open the [Instant Clusters page](https://www.runpod.io/console/cluster) on the Runpod web interface.
1. Open the [Instant Clusters page](https://www.console.runpod.io/cluster) on the Runpod web interface.
2. Click **Create Cluster**.
3. Use the UI to name and configure your Cluster. For this walkthrough, keep **Pod Count** at **2** and select the option for **16x H100 SXM** GPUs. Keep the **Pod Template** at its default setting (Runpod PyTorch).
4. Click **Deploy Cluster**. You should be redirected to the Instant Clusters page after a few seconds.
Expand Down Expand Up @@ -118,11 +118,11 @@ This diagram illustrates how local and global ranks are distributed across multi

## Step 5: Clean up

If you no longer need your cluster, make sure you return to the [Instant Clusters page](https://www.runpod.io/console/cluster) and delete your cluster to avoid incurring extra charges.
If you no longer need your cluster, make sure you return to the [Instant Clusters page](https://www.console.runpod.io/cluster) and delete your cluster to avoid incurring extra charges.

<Info>

You can monitor your cluster usage and spending using the **Billing Explorer** at the bottom of the [Billing page](https://www.runpod.io/console/user/billing) section under the **Cluster** tab.
You can monitor your cluster usage and spending using the **Billing Explorer** at the bottom of the [Billing page](https://www.console.runpod.io/user/billing) section under the **Cluster** tab.

</Info>

Expand Down
8 changes: 4 additions & 4 deletions instant-clusters/slurm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ Follow the steps below to deploy a cluster and start running distributed SLURM w

## Requirements

* You've created a [Runpod account](https://www.runpod.io/console/home) and funded it with sufficient credits.
* You've created a [Runpod account](https://www.console.runpod.io/home) and funded it with sufficient credits.
* You have basic familiarity with Linux command line.
* You're comfortable working with [Pods](/pods/overview) and understand the basics of [SLURM](https://slurm.schedmd.com/).

## Step 1: Deploy an Instant Cluster

1. Open the [Instant Clusters page](https://www.runpod.io/console/cluster) on the Runpod web interface.
1. Open the [Instant Clusters page](https://www.console.runpod.io/cluster) on the Runpod web interface.
2. Click **Create Cluster**.
3. Use the UI to name and configure your cluster. For this walkthrough, keep **Pod Count** at **2** and select the option for **16x H100 SXM** GPUs. Keep the **Pod Template** at its default setting (Runpod PyTorch).
4. Click **Deploy Cluster**. You should be redirected to the Instant Clusters page after a few seconds.
Expand Down Expand Up @@ -120,11 +120,11 @@ Check the output file created by the test (`test_simple_[JOBID].out`) and look f

## Step 8: Clean up

If you no longer need your cluster, make sure you return to the [Instant Clusters page](https://www.runpod.io/console/cluster) and delete your cluster to avoid incurring extra charges.
If you no longer need your cluster, make sure you return to the [Instant Clusters page](https://www.console.runpod.io/cluster) and delete your cluster to avoid incurring extra charges.

<Info>

You can monitor your cluster usage and spending using the **Billing Explorer** at the bottom of the [Billing page](https://www.runpod.io/console/user/billing) section under the **Cluster** tab.
You can monitor your cluster usage and spending using the **Billing Explorer** at the bottom of the [Billing page](https://www.console.runpod.io/user/billing) section under the **Cluster** tab.

</Info>

Expand Down
2 changes: 1 addition & 1 deletion integrations/mods.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To start using Mods, follow these step-by-step instructions:

1. **Obtain Your API Key**:

* Visit the [Runpod Settings](https://www.runpod.io/console/user/settings) page to retrieve your API key.
* Visit the [Runpod Settings](https://www.console.runpod.io/user/settings) page to retrieve your API key.
* If you haven't created an account yet, you'll need to sign up before obtaining the key.

2. **Install Mods**:
Expand Down
2 changes: 1 addition & 1 deletion integrations/skypilot.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This integration leverages the Runpod CLI infrastructure, streamlining the proce

To begin using Runpod with SkyPilot, follow these steps:

1. **Obtain Your API Key**: Visit the [Runpod Settings](https://www.runpod.io/console/user/settings) page to get your API key. If you haven't created an account yet, you'll need to do so before obtaining the key.
1. **Obtain Your API Key**: Visit the [Runpod Settings](https://www.console.runpod.io/user/settings) page to get your API key. If you haven't created an account yet, you'll need to do so before obtaining the key.

2. **Install Runpod**: Use the following command to install the latest version of Runpod:

Expand Down
2 changes: 1 addition & 1 deletion pods/configuration/expose-ports.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This means that uvicorn would be listening on all interfaces on port 4000. Let's

### Through Runpod's Proxy

In this case, you would want to make sure that the port you want to expose (4000 in this case) is set on the [Template](https://www.runpod.io/console/user/templates) or [Pod](https://www.runpod.io/console/pods) configuration page. You can see here that I have added 4000 to the HTTP port list in my pod config. You can also do this on your template definition.
In this case, you would want to make sure that the port you want to expose (4000 in this case) is set on the [Template](https://www.console.runpod.io/user/templates) or [Pod](https://www.console.runpod.io/pods) configuration page. You can see here that I have added 4000 to the HTTP port list in my pod config. You can also do this on your template definition.

<Frame caption="">
<img src="/images/f750ab73-1386a3c-image-00ce91cf90cd62e743f1382d8d722b0a.png" />
Expand Down
2 changes: 1 addition & 1 deletion pods/configuration/use-ssh.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The basic terminal SSH access that Runpod exposes is not a full SSH connection a
<img src="/images/004be354-4655a01-1-6b0dd022d29cebe257e9e5df21a52fb4.png" />
</Frame>

2. Add your public key to your [Runpod user settings](https://www.runpod.io/console/user/settings).
2. Add your public key to your [Runpod user settings](https://www.console.runpod.io/user/settings).

<Frame caption="">
<img src="/images/58c926ba-4972691-2-8c4764cae5d826dd756d264474f818d5.png" />
Expand Down
2 changes: 1 addition & 1 deletion pods/connect-to-a-pod.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ To connect using this method:
ssh-ed25519 AAAAC4NzaC1lZDI1JTE5AAAAIGP+L8hnjIcBqUb8NRrDiC32FuJBvRA0m8jLShzgq6BQ [email protected]
```

3. Copy and paste the output into the **SSH Public Keys** field in your [Runpod user account settings](https://www.runpod.io/console/user/settings).
3. Copy and paste the output into the **SSH Public Keys** field in your [Runpod user account settings](https://www.console.runpod.io/user/settings).
4. To get the SSH command for your Pod, navigate to the [Pods page](https://console.runpod.io/pods) in the Runpod console.
5. Expand your Pod and select **Connect**.
6. Select the SSH tab. Copy the command listed under **SSH**. It should look something like this:
Expand Down
10 changes: 5 additions & 5 deletions pods/manage-pods.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ runpodctl config --apiKey [RUNPOD_API_KEY]
<Tab title="Web">
To create a Pod using the Runpod console:

1. Open the [Pods page](https://www.runpod.io/console/pods) in the Runpod console and click the **Deploy** button.
1. Open the [Pods page](https://www.console.runpod.io/pods) in the Runpod console and click the **Deploy** button.
2. (Optional) Specify a [network volume](/pods/storage/create-network-volumes) if you need to share data between multiple Pods, or to save data for later use.
3. Select **GPU** or **CPU** using the buttons in the top-left corner of the window, and follow the configuration steps below.

Expand Down Expand Up @@ -86,7 +86,7 @@ After a Pod is stopped, you will still be charged for its [disk volume](/pods/st
<Tab title="Web">
To stop a Pod:

1. Open the [Pods page](https://www.runpod.io/console/pods).
1. Open the [Pods page](https://www.console.runpod.io/pods).
2. Find the Pod you want to stop and expand it.
3. Click the **Stop button** (square icon).
4. Confirm by clicking the **Stop Pod** button.
Expand Down Expand Up @@ -142,7 +142,7 @@ Pods start as soon as they are created, but you can resume a Pod that has been s
<Tab title="Web">
To start a Pod:

1. Open the [Pods page](https://www.runpod.io/console/pods).
1. Open the [Pods page](https://www.console.runpod.io/pods).
2. Find the Pod you want to start and expand it.
3. Click the **Start** button (play icon).

Expand Down Expand Up @@ -171,7 +171,7 @@ Terminating a Pod permanently deletes all associated data that isn't stored in a
<Tab title="Web">
To terminate a Pod:

1. Open the [Pods page](https://www.runpod.io/console/pods).
1. Open the [Pods page](https://www.console.runpod.io/pods).
2. Find the Pod you want to terminate and expand it.
3. [Stop the Pod](#stop-a-pod) if it's running.
4. Click the **Terminate** button (trash icon).
Expand All @@ -198,7 +198,7 @@ runpodctl remove pods my-bulk-task --podCount 40

## List Pods

You can find a list of all your Pods on the [Pods page](https://www.runpod.io/console/pods) of the web interface.
You can find a list of all your Pods on the [Pods page](https://www.console.runpod.io/pods) of the web interface.

If you're using the CLI, use the following command to list your Pods:

Expand Down
2 changes: 1 addition & 1 deletion pods/networking.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Global networking is currently only available on NVIDIA GPU Pods.

**Enable global networking**

1. Go to [Pods](https://www.runpod.io/console/pods) section and select **+ Deploy**.
1. Go to [Pods](https://www.console.runpod.io/pods) section and select **+ Deploy**.
2. Toggle the **Global Networking** to select Pods that have global networking enabled.
3. Configure your GPUs and select **Deploy**.

Expand Down
Loading