Getting Started with CDN-As-Code (EdgeJS)

1npx @edgio/cli@latest init \
2  --edgioVersion latest \
3  --name <PROPERTY> \
4  --deploy

1🚀 Let's get started with Edgio!
2
3  ✔ What is the hostname or IP address of the origin site that you will host on Edgio? … my-custom-property.com
4  ✔ Should we create a new directory for your Edgio app or use the current directory? › Create a new directory
5  ✔ Which package manager would you like to use? › npm
6  ✔ installing @edgio/core, @edgio/cli, @edgio/prefetch, @edgio/devtools... done.
7  > edgio.config.js not found, creating...
8  > routes.js not found, creating...
9  🔑 You are not logged in.
10
11  ? To log you in we're going to open your browser and visit Edgio Developer Console. › - Use arrow-keys. Return to submit.
12  ❯   Continue
13      Cancel

1🚀 Let's get started with Edgio!
2
3  ✔ What is the hostname or IP address of the origin site that you will host on Edgio? … my-custom-property.com
4  ✔ Should we create a new directory for your Edgio app or use the current directory? › Create a new directory
5  ✔ Which package manager would you like to use? › npm
6  ✔ installing @edgio/core, @edgio/cli, @edgio/prefetch, @edgio/devtools... done.
7  > edgio.config.js not found, creating...
8  > routes.js not found, creating...
9  🔑 You are not logged in.
10
11  ✔ To log you in we're going to open your browser and visit Edgio Developer Console. › Continue
12  Authenticating user!
13  Please visit this URL from any device and click on "Create access token" to authorize this device:
14  https://api.edgio.app/account/cli?name=CLI+Api+Key&sid=<ID>&action=deploy
15
16  Waiting for authentication...
17  🔑 You are now logged in as "xxx@yyy.zzz"
18
19  📋 Deploying to:
20  > Team: Private space
21  > Site: my-custom-property.com
22  > Environment: default
23  > Edgio version: 7.0.12
24  > Deployment #1
25
26  🛠️  Building your app for deployment on Edgio
27  > Bundling router... done.
28  > Bundling edge functions... done.
29  > Writing static asset aliases... done.
30  done 277ms
31
32  📦 Packaging...
33  > Zipping project folder
34  > Size: 674.22 KB
35  done 177ms
36
37  📡️ Uploading...
38  done 1s
39
40  ⌛ Deploying...
41  done 56s
42
43  ***** Deployment Complete *****************************************************
44  *                                                                             *
45  *  🖥  Edgio Developer Console:                                                *
46  *  https://edgio.app/<YOUR-ORGANIZATION>/my-custom-property.com/env/default/builds/1  *
47  *                                                                             *
48  *  🔗 Permalink:                                                              *
49  *  https://<YOUR-ORGANIZATION>-my-custom-property-com-1.free.edgio-perma.link         *
50  *                                                                             *
51  *  🌎 Edge:                                                                   *
52  *  https://<YOUR-ORGANIZATION>-my-custom-property-com-default.edgio.link              *
53  *                                                                             *
54  *******************************************************************************
55
56  To change directories to your new Edgio app:
57
58      cd my-custom-property.com
59
60  To run your app locally:
61
62      edg dev
63
64  To redeploy your app:
65
66      edg deploy

1// This file was automatically added by edgio init.
2// You should commit this file to source control.
3// Learn more about this file at https://docs.edg.io/applications/edgio_config
4module.exports = {
5  // The name of the property in Edgio to which this app should be deployed.
6  name: 'my-custom-property.com',
7
8  // The name of the organization in Edgio to which this app should be deployed.
9  // team: 'my-organization-name',
10
11  // Overrides the default path to the routes file. The path should be relative to the root of your app.
12  // routes: 'routes.js',
13
14  origins: [
15    {
16      // The name of the backend origin
17      name: 'web',
18
19      // Uncomment the following to override the host header sent from the browser when connecting to the origin
20      // override_host_header: 'example.com',
21
22      // The list of origin hosts to which to connect
23      hosts: [
24        {
25          // The domain name or IP address of the origin server
26          location: 'my-custom-property.com',
27        },
28      ],
29
30      // Uncomment the following to configure a shield
31      // shields: { us_east: 'DCD' },
32    },
33  ],
34
35  // Options for hosting Cloud Functions on Edgio
36  // serverless: {
37  //   // Set to true to include all packages listed in the dependencies property of package.json when deploying to Edgio.
38  //   // This option generally isn't needed as Edgio automatically includes all modules imported by your code in the bundle that
39  //   // is uploaded during deployment
40  //   includeNodeModules: true,
41  //
42  //   // Include additional paths that are dynamically loaded by your app at runtime here when building the bundle.
43  //   include: ['views/**/*'],
44  // },
45
46  // The maximum number of URLs that will be concurrently prerendered during deployment when static prerendering is enabled.
47  // Defaults to 200, which is the maximum allowed value.
48  // prerenderConcurrency: 200,
49
50  // A list of glob patterns identifying which source files should be uploaded when running edgio deploy --includeSources.
51  // This option is primarily used to share source code with Edgio support personnel for the purpose of debugging. If omitted,
52  // edgio deploy --includeSources will result in all files which are not gitignored being uploaded to Edgio.
53  //
54  // sources : [
55  //   '**/*', // include all files
56  //   '!(**/secrets/**/*)', // except everything in the secrets directory
57  // ],
58};

1origins: [
2  {
3    // The name of the backend origin
4    // Proxy requests to this origin by referencing this name within your router
5    name: 'web',
6
7    // Uncomment the following to override the host header sent from the browser when connecting to the origin
8    // override_host_header: 'example.com',
9
10    // The list of origin hosts to which to connect
11    hosts: [
12      {
13        // The domain name or IP address of the origin server
14        location: 'my-custom-property.com',
15      },
16    ],
17
18    // Uncomment the following to configure a shield
19    // shields: { us_east: 'DCD' },
20  },
21];

1// This file was added by edgio init.
2// You should commit this file to source control.
3import {Router, edgioRoutes} from '@edgio/core';
4
5export default new Router()
6  // Here is an example where we cache api/* at the edge but prevent caching in the browser
7  // .match('/api/:path*', {
8  //   caching: {
9  //     max_age: '1d',
10  //     stale_while_revalidate: '1h',
11  //     bypass_client_cache: true,
12  //     service_worker_max_age: '1d',
13  //   },
14  // })
15
16  // plugin enabling basic Edgio functionality
17  .use(edgioRoutes);

1router.match('/:path*', {
2   {
3     caching: {
4       max_age: "1h"
5     },
6     origin: {
7       set_origin: "web"
8     }
9   }
10 })

1router.get('/marketing/images/:path*', {
2  headers: {
3    set_response_headers: {
4      images: 'true',
5    },
6  },
7  origin: {
8    set_origin: 'web',
9  },
10});

1router.get('/old/path', {
2  url: {
3    url_redirect: {
4      code: 301,
5      source: '\\/old\\/path',
6      destination: '/new/path',
7    },
8  },
9});

1import {Router} from '@edgio/core';
2import {nextRoutes} from '@edgio/next';
3
4export default new Router()
5  // Send requests to the Edgio cloud and render the response with Next.js
6  .use(nextRoutes)
7
8  // Cache all requests to /products/:id for 1 hour
9  .get('/products/:id', {
10    caching: {max_age: {200: '1h'}, stale_while_revalidate: '1h'},
11  });

1edgio deploy

1edgio deploy --environment staging

1edgio deploy --environment production