> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nodexpanel.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Get started with Nodex and deploy your first server in minutes.

## Create a node

Start by creating a [node](/nodes). If you already have a Linux server, you may connect it to Nodex. If you don't have one, you may use our built-in integrations with cloud providers such as DigitalOcean and Vultr.

<Tabs>
  <Tab title="On DigitalOcean or Vultr">
    <Steps>
      <Step title="Create a node from your dashboard">
        From your main Nodex dashboard, click **+ Create Node**.

        <Frame>
          <img src="https://mintcdn.com/nodexdocs/i-aTHJx7exH9dvNI/images/dashboard.png?fit=max&auto=format&n=i-aTHJx7exH9dvNI&q=85&s=06120c64ec027c4b7a89d9dd9382221f" alt="Dashboard" width="1920" height="1080" data-path="images/dashboard.png" />
        </Frame>
      </Step>

      <Step title="Connect your cloud provider">
        Select **Connect Vultr** or **Connect DigitalOcean** and follow the dialog. Depending on the provider, you'll either paste in an API access token or authenticate through OAuth.

        <Frame>
          <img src="https://mintcdn.com/nodexdocs/i-aTHJx7exH9dvNI/images/connect_cloud_provider.png?fit=max&auto=format&n=i-aTHJx7exH9dvNI&q=85&s=1396eb53bdc93f5f09a4613a4c24fd69" alt="Connect Cloud Provider" width="1920" height="1080" data-path="images/connect_cloud_provider.png" />
        </Frame>
      </Step>

      <Step title="Configure and create the node">
        Give your node an optional name, then choose a region and an instance size. Click **Submit** when you're done.

        <Frame>
          <img src="https://mintcdn.com/nodexdocs/i-aTHJx7exH9dvNI/images/create_cloud_node.png?fit=max&auto=format&n=i-aTHJx7exH9dvNI&q=85&s=e8546590e3e8932e07d8c1540619ddaf" alt="Create Cloud Node" width="1920" height="1080" data-path="images/create_cloud_node.png" />
        </Frame>

        <Note>
          This creates a real instance with your cloud provider, billed at their standard rate as if you'd created it manually. Nodex has no control over your provider's charges.
        </Note>
      </Step>

      <Step title="Wait for the node to provision">
        Nodex installs and configures the software the node needs to run servers. This usually takes a few minutes.

        <Frame>
          <img src="https://mintcdn.com/nodexdocs/i-aTHJx7exH9dvNI/images/provision_cloud_node.png?fit=max&auto=format&n=i-aTHJx7exH9dvNI&q=85&s=0f854ac4787d38c0f8ac1c4be79873e1" alt="Provision Cloud Node" width="1920" height="1080" data-path="images/provision_cloud_node.png" />
        </Frame>
      </Step>

      <Step title="Your node is connected">
        You're ready to create a server on it.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Using a custom VPS">
    Before connecting your own Linux server, make sure it meets the [custom VPS requirements](/custom-vps).

    <Steps>
      <Step title="Create a node from your dashboard">
        From your main Nodex dashboard, click **+ Create Node**.

        <Frame>
          <img src="https://mintcdn.com/nodexdocs/i-aTHJx7exH9dvNI/images/dashboard.png?fit=max&auto=format&n=i-aTHJx7exH9dvNI&q=85&s=06120c64ec027c4b7a89d9dd9382221f" alt="Dashboard" width="1920" height="1080" data-path="images/dashboard.png" />
        </Frame>
      </Step>

      <Step title="Choose &#x22;Using a custom VPS&#x22;">
        Give your node an optional name, then click **Submit**.

        <Frame>
          <img src="https://mintcdn.com/nodexdocs/i-aTHJx7exH9dvNI/images/create_custom_node.png?fit=max&auto=format&n=i-aTHJx7exH9dvNI&q=85&s=db464d238eedaf17071dacccfcfcb7bd" alt="Create Custom Node" width="1920" height="1080" data-path="images/create_custom_node.png" />
        </Frame>
      </Step>

      <Step title="Copy the installation command">
        Click the clipboard button to copy the command.

        <Frame>
          <img src="https://mintcdn.com/nodexdocs/i-aTHJx7exH9dvNI/images/install_node.png?fit=max&auto=format&n=i-aTHJx7exH9dvNI&q=85&s=3ca9ac4eea4097857ce5f7d144e0405c" alt="Install Node" width="1920" height="1080" data-path="images/install_node.png" />
        </Frame>
      </Step>

      <Step title="Run the command on your server">
        Paste and run the copied command over SSH, then wait for it to finish.

        <Frame>
          <img src="https://mintcdn.com/nodexdocs/i-aTHJx7exH9dvNI/images/execute_install_command.png?fit=max&auto=format&n=i-aTHJx7exH9dvNI&q=85&s=dd3808c75311984efd83e78564aec7fd" alt="Execute Install Command" width="1922" height="1292" data-path="images/execute_install_command.png" />
        </Frame>
      </Step>

      <Step title="Your node is connected">
        You're ready to create a server on it.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## Create a server

Now you can create a dedicated game [server](/servers) on your node.

<Steps>
  <Step title="Open the overview page of the node you just created">
    Click the blue **+ Create Server** button. 

    <Frame>
      <img src="https://mintcdn.com/nodexdocs/i-aTHJx7exH9dvNI/images/node_overview.png?fit=max&auto=format&n=i-aTHJx7exH9dvNI&q=85&s=68ed0707d48deda0a379c588ee65e2ef" alt="Node Overview" width="1920" height="1080" data-path="images/node_overview.png" />
    </Frame>
  </Step>

  <Step title="Choose the game for your server">
    The list of supported games is constantly expanding.

    <Frame>
      <img src="https://mintcdn.com/nodexdocs/i-aTHJx7exH9dvNI/images/choose_game.png?fit=max&auto=format&n=i-aTHJx7exH9dvNI&q=85&s=0455e704b18e40355347dac1ce308b69" alt="Choose Game" width="1920" height="1080" data-path="images/choose_game.png" />
    </Frame>
  </Step>

  <Step title="Customize your server">
    Give it a title, assign port allocations, and customize the startup parameters. Click **Submit** once you're done.

    <Frame>
      <img src="https://mintcdn.com/nodexdocs/i-aTHJx7exH9dvNI/images/customize_server.png?fit=max&auto=format&n=i-aTHJx7exH9dvNI&q=85&s=818d64b2d5b32c680a9b6e2b4f88048d" alt="Customize Server" width="1920" height="1080" data-path="images/customize_server.png" />
    </Frame>
  </Step>

  <Step title="Wait for it to install">
    The server takes a few minutes to install, then starts automatically. Once it's ready to play, it enters the **Running** state.

    <Frame>
      <img src="https://mintcdn.com/nodexdocs/i-aTHJx7exH9dvNI/images/server_overview.png?fit=max&auto=format&n=i-aTHJx7exH9dvNI&q=85&s=e0c8d6eb277c4fa940689fbc43f0fce7" alt="Server Overview" width="1920" height="1080" data-path="images/server_overview.png" />
    </Frame>
  </Step>

  <Step title="Join the server using its IP address">
    <Frame>
      <img src="https://mintcdn.com/nodexdocs/i-aTHJx7exH9dvNI/images/join_server.png?fit=max&auto=format&n=i-aTHJx7exH9dvNI&q=85&s=d8a2666cce5e3869c57627d860afca78" alt="Join Server" width="1605" height="900" data-path="images/join_server.png" />
    </Frame>
  </Step>
</Steps>

Congratulations! Your server is now running on Nodex.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.