You are reading Edgio v5 docs. Check out our latest docs for Edgio v7.
Edgio
Edgio

Getting Started

Get started with Edgio by satisfying our prerequisites and then performing these steps:

  1. Create an Edgio property.
  2. Test your property.
  3. Deploy your property to Edgio.
  4. Next steps.

Quick Start

If you already have Node.js v14.x and an Edgio account, then you can use a single command to:

  • Install the Edgio CLI.
  • Create an Edgio property for your website.
  • Deploy a property to Edgio.

An alternative approach is to perform each of the above tasks individually.

Learn more.

Run one of the following commands from the root directory of your web application or website:

  • Origin: Run this command if you have web servers that will serve as the origin.
  • Framework: Run this command to render your web app within our cloud through Sites.

Replace <PROPERTY> with the name for this configuration. If you are also setting <DOMAIN>, then you should replace it with your website’s domain or IP address.

Bash
1npx @edgio/cli@latest init \
2	--name <PROPERTY> \
3	--environment default \
4	--origin <DOMAIN> \
5	--deploy

You are now ready to optimize and secure the delivery of your website. Learn more.

Prerequisites

Edgio requires:

  • Node.js v14.x

  • npm or yarn package manager

    npm is installed with Node.js, while yarn requires a separate installation.

  • Edgio CLI

  • Edgio account

Edgio CLI Installation

Use the Edgio CLI to build, test, and deploy your website to Edgio. Install it through either npm or yarn.

Bash
1npm i -g @edgio/cli

Edgio Account Creation

Signing up for an Edgio account is free and quick.

  1. Sign up now by either:

    • Manually creating an account.
      1. Provide your name, email (user name), and a password. Click Create Account.
      2. Check your email for confirmation instructions. Click CONFIRM MY ACCOUNT to load the Edgio Developer console.
    • Using your existing Github or Google account. You will need to log in to Github or Google and then authorize linking Edgio to your account.

  2. Click Accept to accept our terms of service and privacy policy.

Step 1: Create an Edgio Property

Each website that will run behind Edgio requires an Edgio property. A property determines how Edgio will process your website’s traffic.

  1. From the Edgio Developer console, set the What is your website’s URL? option to your website’s URL and then click Launch my site.

    If you have previously created a site, you will need to click + New Site, provide your website’s URL, and then click Create my site.

  2. From the command line or terminal, navigate to a directory where project files will be stored.

    If possible, try to use your website’s root directory.

  3. Run one of the following commands:

    • Origin: Run this command if you have web servers that will serve as the origin.
    • Framework: Run this command to render your web apps within our cloud through Sites.

    Replace <PROPERTY> with the domain defined in step 1. If you are also setting <DOMAIN>, then you should replace it with your website’s domain or IP address.

    Bash
    1edgio init --name <PROPERTY> \
    2    --environment production \
    3    --origin <DOMAIN>

  4. When prompted, confirm the selection of Use the current directory by pressing the ENTER key.

  5. When prompted, select either the npm or yarn package manager and then press the ENTER key.

Step 2: Testing Locally

You may run Edgio in local development mode to preview your website on your local machine prior to deployment. Local development mode allows for rapid development by allowing you to quickly test changes prior to deployment.

  1. From the command line or terminal, type edgio dev.
  2. Preview your website by loading https://127.0.0.1:3000 from within your preferred web browser.

Step 3: Deploying Your Property

Run the following command from your property’s root directory to deploy it to Edgio:

Bash
1edgio deploy

Next Steps

Once you have successfully deployed your property to Edgio, our CLI provides the following URLs:

  • Edgio Developer Console: View detailed information about this deployment, including its edge link and permalink, from within the Edgio Developer console.

  • Permalink: Preview your website behind Edgio without edge caching. Bypassing our cache will affect performance.

  • Edge: Preview your website behind Edgio and gain performance insights through our DevTools.

You are now ready to set up:

  • Performance. Learn how to:
    • Optimize website performance through our CDN-as-code approach to caching, routing your content, and predictive prefetching.
    • Gain performance insights through which you can fine-tune your configuration through our Observability solution.
    • Speed up development by quickly iterating through different variations of your site through our Traffic Splitting solution.
  • Security. We automatically provide distributed denial-of-service (DDOS) protection to traffic that runs behind Edgio. Apply additional protection to your web applications and APIs through our Web Application Firewall and Managed Bot Defense solutions. Contact your account manager or our sales department at 1 (866) 200 - 5463 to upgrade your account.
  • Sites. If you are currently using a JavaScript framework, then you can improve your website’s performance by using our serverless workers to quickly render server-side content in a scalable manner.