> For the complete documentation index, see [llms.txt](https://docs-launchpad.energyweb.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs-launchpad.energyweb.org/launchpad-by-ew/launchpad-by-energy-web/blockchain-infrastructure/collator-nodes/collator-node-quick-start-guide.md).

# Collator node Quick Start Guide

This page will guide you through the steps of purchasing a Collator node subscription and setting up your node. You cannot set-up nodes on Launchpad without an active subscription.

Subscription

Purchasing a subscription is the first step to setting up your Collator node(s) on the Energy Web X Parachain. Follow the steps below to subscribe.

1. Login to Launchpad with your account or create an account
2. Switch to the **VaaS** environment of Launchpad using the toggle on the top right of the Launchpad screen.
3. Under **Node** in the left hand bar menu, go to "**Purchase**"

   <div align="left"><figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2Fcio1siXTgAFCMje3AVm4%2FScreenshot%202024-11-15%20at%2011.44.14.png?alt=media&amp;token=b97a6b46-247b-45c9-acf6-09d7ba365e6c" alt="" width="271"><figcaption></figcaption></figure></div>
4. Currently, you can only purchase a Collator node with EW managed cloud. Chose the number of nodes you would like to purchase.<br>
5. Validate your choice by clicking on "**Subscribe**". This will take you to the payment screen.&#x20;

Once your payment is validated, your subscription is active and you can start setting up your nodes.<br>

## Collator Node Creation and Deployment

Once your subscription is active, follow the steps below to set-up and manage your nodes.

1. Under **Collator Node**, go to "**Manage**". You will see your purchased bundle of nodes that are ready for deployment.

<div align="left"><figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2FkGsX1CPUPTDATDG2r5xC%2FScreenshot%202024-11-15%20at%2011.48.30.png?alt=media&amp;token=661a4d4b-0d13-4101-8a82-0ecc72e1967d" alt="" width="563"><figcaption></figcaption></figure></div>

2. Click "**Deploy**"&#x20;
3. Fill in the necessary configurations details and go to "**Deploy**"

<div align="left"><figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2F5yNBbrJAPiBgGYoQszud%2FScreenshot%202024-11-15%20at%2011.49.33.png?alt=media&amp;token=e58f5322-8cd9-4245-91e1-97a53302b6ee" alt="" width="563"><figcaption></figcaption></figure></div>

4. You will find your newly deployed node under **Collator Nodes** by clicking "**Manage**". It can take up to 48 hours for the node to sync.<br>

Once your node is deployed, a request for IP whitelisting will be automatically sent. You can kick off your Collator node's onboarding into the EWX parachain once the IP was whitelisted.

## Collator node details

You can access more information about your collator node details by clicking on "**View Details**" when in the manage view.

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2Fl2kUUkWuM5i3KYCQWGOw%2FScreenshot%202024-11-15%20at%2011.55.09.png?alt=media&amp;token=f8d113e8-2c24-4a62-a30d-33c7597d48fc" alt=""><figcaption></figcaption></figure>

This section will include all general and specific details about your node and will allow you to kick off and track onboarding.

The onboarding status is an indication of the stage of your node's status on the EWX parachain. The status are as follows:

1. **Pending whitelisting:** The request for IP whitelisting was sent and is pending. Once the IP of your node was whitelisted, you will be able to start onboarding your node on EWX.
2. **Ready for onboarding:** Your node's IP was whitelisted, you can kick off the onboarding onto EWX by clicking "Start onboarding"
3. **Onboarding:** Your onboarding request was sent and is pending
4. **Ready:** Your Collator node was onboarded onto EWX and is now active

## Collator Node onboarding

Once your node's IP was whitelisted, you can kick off the onboarding for your node by clicking "Start Onboarding" under the **About** section of the details page.

<div align="left"><figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2FEtj6Ts8BeGJH88GETirP%2FScreenshot%202024-11-15%20at%2012.24.13.png?alt=media&amp;token=2b7f69c2-3866-43ad-a018-fbe97efd0139" alt="" width="181"><figcaption></figcaption></figure></div>

You can choose between **Manual onboarding** and **Automatic onboarding**.&#x20;

<div align="left"><figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2Fx60kg2Kfh8V0nf0PRUwi%2FScreenshot%202024-11-15%20at%2016.09.23.png?alt=media&amp;token=e45dc778-ad00-4b6b-bbe3-39c629e8a20b" alt="" width="563"><figcaption></figcaption></figure></div>

#### Automatic onboarding

With the Automatic onboarding, all the necessary steps will be automatically done by the Launchpad platform, allowing you to get started immediately with your Collator node.

<div><figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2F6injo0bLjDf9yLEjF8US%2FScreenshot%202024-11-15%20at%2012.21.29.png?alt=media&amp;token=c5d826d8-700e-4f48-84e7-e91e2e6833a3" alt=""><figcaption><p>Automatic onboarding: in progress</p></figcaption></figure> <figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2Fov4bRYVmWJmMGSLJX7qP%2FScreenshot%202024-11-15%20at%2012.27.57.png?alt=media&amp;token=c53a8248-470b-4dd1-9da8-77f118025b1f" alt=""><figcaption><p>Automatic onboarding: ready for request</p></figcaption></figure></div>

Once the steps are completed, you can click on "Request for Collator Authorization". You will be informed via email when your Collator is ready and the Onboarding status under the details screen will change to "**Ready**".

#### Manual onboarding

With the Manual onboarding, you will need to follow each step and take action manually. Some steps are still automated and you will be provided guides for each manual step.

<div align="left"><figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2FpxNd3Q3GKBFCSTNvA9VX%2FScreenshot%202024-11-15%20at%2016.09.35.png?alt=media&amp;token=33e190db-f249-43c1-9509-af060976349c" alt="" width="188"><figcaption></figcaption></figure></div>

## Analytics

The analytics will provide in depth information about your Collator node's activities and health. You can find them by clicking on the "Monitor Node" button under "**Manage**", or via "View Analytics" in the details page.

<figure><img src="https://4257445316-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fnf3YeoQlQerc93GsC2Me%2Fuploads%2FqM7IZlphludmWLNEBDnU%2FScreenshot%202024-11-15%20at%2011.59.52.png?alt=media&amp;token=0a68e5f5-e27c-4246-9b99-a4ed84dfa481" alt=""><figcaption></figcaption></figure>
