diff --git a/src/content/docs/en/pages/azion-edge-runtime/nextjs/2023-02-14-index copy.mdx b/src/content/docs/en/pages/azion-edge-runtime/nextjs/2023-02-14-index copy.mdx index a5f0e08179..1d5b03cbaa 100644 --- a/src/content/docs/en/pages/azion-edge-runtime/nextjs/2023-02-14-index copy.mdx +++ b/src/content/docs/en/pages/azion-edge-runtime/nextjs/2023-02-14-index copy.mdx @@ -75,8 +75,7 @@ To create a Next.js application on the Azion Platform you need: - An account on the Azion platform with **Edge Functions** enabled. - The Node.js runtime environment, version 16.x or 18.x, installed in a build environment. -- The latest [Azion CLI](/en/documentation/products/cli/first-steps/) version installed. +- The latest [Azion CLI](/en/documentation/products/azion-cli/overview/) version installed. -See how to have a Next.js project up and running on the Azion platform on [How to Build and Publish a Next.js Project with Server-side Rendering (SSR) on the Azion Platform](/en/documentation/products/guides/nextjs-ssr-on-azion-platform/). **Note**: currently, only Static HTML Export Next.js use cases are supported by the Azion Platform. diff --git a/src/content/docs/en/pages/cli/azion-cli-alpha/azion-overview/azion-overview.mdx b/src/content/docs/en/pages/cli/azion-cli-alpha/azion-overview/azion-overview.mdx index 13d69f4961..dca891ae1e 100644 --- a/src/content/docs/en/pages/cli/azion-cli-alpha/azion-overview/azion-overview.mdx +++ b/src/content/docs/en/pages/cli/azion-cli-alpha/azion-overview/azion-overview.mdx @@ -146,5 +146,5 @@ The `h` or `--help` option displays more information about the `azion` command. --- - \ No newline at end of file diff --git a/src/content/docs/en/pages/cli/azioncli-beta/azioncli-beta.mdx b/src/content/docs/en/pages/cli/azioncli-beta/azioncli-beta.mdx new file mode 100644 index 0000000000..dbc21220f8 --- /dev/null +++ b/src/content/docs/en/pages/cli/azioncli-beta/azioncli-beta.mdx @@ -0,0 +1,1848 @@ +--- +title: Azion CLI Beta +description: Azion's CLI (command-line interface) is an open source tool that enables the management of services offered by Azion. +meta_tags: CLI +namespace: documentation_CLI_beta +permalink: /documentation/products/cli/beta/ +no-index: true +--- +import Button from '~/components/Button.astro'; + +:::note +Azion CLI version 1.x.y is now available. From September 2023, Azion CLI version 0.x.y no longer receives updates. To check the version, run run `azioncli -v` or `azion -v` +::: + + + +Azion **Command-Line Interface** (CLI) is an [open source](https://github.com/aziontech/azion-cli/) tool that enables the management of services offered by Azion using a terminal. By using the **CLI**, you can create and manage services such as **Edge Functions** and **Edge Services**, as well as the provisioning of **Next.js** applications. + +Visit the framework's site at [Next.js](https://nextjs.org/) for more information. + +**Azion CLI** enables you to: + +- Manage Azion products. +- Create automation using scripts or CI/CD (Continuous Integration/Continuous Delivery) pipelines. +- Provision multiple services that make your application up with few commands. +- Manage your Azion settings as code. + +For an overview of the **CLI** commands, you can access its [reference documentation](https://github.com/aziontech/azion-cli/wiki/azioncli). + +> Azion CLI is currently in **Beta** version. Some functionalities can be modified until its release. Therefore, use it cautiously in production environments. While you try out the **Beta** version, our engineering team would love to hear from you in order to improve it. Contribute with your [feedback](https://forms.gle/uBBkyXZCVcrgpvAB8). + +## About Command-Line Interfaces + +Prior to the development of **Graphical User Interfaces** (GUI), software developers and users interacted with computers using a keyboard and monitor, known as **terminal**. + +The keyboard served as the input device, on which the user typed command lines. The computer then ran the command and output the result on the monitor screen, eventually with additional messages. + +> Commands typed on the keyboard followed rules that enabled creating an interface between the user and the computer. They were usually composed of a keyword, flags, and parameters. This interface, still used today, is the **Command-Line Interface** or **CLI**. + +Later, the GUIs attracted to the computer world users who found typing commands complex and challenging. However, the **CLI** has never lost its importance, especially in the software development environment. + +In fact, the **CLI** has many advantages when compared to using graphical interfaces, such as: + +- Ability to manipulate computer resources inaccessible by GUIs. +- Speed and simplicity to perform tasks. +- Flexibility in creating scripts for process automation. + +All modern operating systems have terminal-type applications in which the user can type command lines to perform tasks on the computer. + +## Installing + +### Installing the CLI using the RPM, Dpkg, or apk package managers + +1. Go to our [releases page](https://github.com/aziontech/azion-cli/releases) and download the desired package. +2. Execute the command in the **Install Command** column of the table below for the chosen installation package. The **CLI** will be installed automatically. + +> **Note**: replace the `` placeholder with the installation package file downloaded in step 1. + +| Package Manager | Website | Documentation | Install Command | +| ---------------------- | ------------ | -------- | ----------- | +| RPM | [RPM package manager](https://rpm.org/index.html) | [RPM Support Documentation](https://rpm.org/documentation.html) | `sudo rpm -i ` | +| Dpkg | [Debian® 5 operating system](https://www.debian.org/) | [Dpkg Support Documentation](https://wiki.debian.org/Teams/Dpkg)| `sudo dpkg -i ` | +| apk | [Alpine Linux® 6operating system](https://docs.alpinelinux.org/user-handbook/0.1a/Working/apk.html) | [support documentation apk](https://docs.alpinelinux.org/user-handbook/0.1a/Working/apk.html) | `apk add ` | + +3. Run the `azioncli --version` command to test the installation. The CLI displays its installed current version number on the terminal. + +### Installing the CLI using Homebrew + +1. To use Homebrew, visit the [official package installer website](https://brew.sh/) and follow the installation instructions located on its homepage. Then run the Install Command below: + +| Package Manager | Website | Documentation | Install Command | +| ---------------------- | ------------ | -------- | ----------- | +| Homebrew | [Homebrew package manager](https://brew.sh/) | [Homebrew Support Documentation](https://docs.brew.sh/Manpage) | `brew install aziontech/tap/azioncli` | + +2. Run the `azioncli --version` command to test the installation. The CLI displays its installed current version number on the terminal. + +### Alternatives + +Alternatively, you can [install Azion CLI manually](/en/documentation/products/guides/cli-installing-manually/). + +If you're installing the CLI on a macOS operating system, see [running Azion CLI on macOS](/en/documentation/products/guides/cli-running-macos/). + +--- + +## Authorization on the Azion Platform + +To manage your settings, you must generate a *token* that identifies you on the Azion platform. + +> For more information on how to create and manage your *tokens*, use the [Azion API](https://api.azion.com/#aab16606-2014-43d0-9b7a-dc564146a1ac) or see the [Personal Tokens](/en/documentation/products/accounts/personal-tokens/) documentation page. + +Once you've created your personal token and have it on your clipboard you can locally store it by using the following command: + +```bash + $ azioncli configure --token +``` + +All subsequent commands will use that same *token* and will consider all permissions granted to the account that *token* belongs to. + +> You can replace your *Personal Token* at any time by repeating the command above. + +## Commands + +### Edge application + + +#### Initializing + +The initialization process creates the necessary environment for building your edge application. To do this, you must first: + +- Choose one of the available types in the CLI: + - Next.js + - Static + - CDN +- Initialize a **JavaScript** project with **Node.js** runtime environment. + +#### Usage + +```bash + azioncli edge_applications init +``` + +#### Flags + +##### Name + +The `--name` option can be specified, but it isn't mandatory. If it isn't informed, the name of your project will be the same one that is in your `package.json` file. + +##### Type + +The `--type` option can be specified, but it isn't mandatory. If it isn't informed, the type of your project will be autodetected. + +The CLI currently provides three templates and the type `cdn` for building edge applications that follow `--type`: + +- Static + +```bash + azioncli edge_applications init --name <"application_name"> --type static +``` + +- Next.js + +```bash + azioncli edge_applications init --name <"application_name"> --type nextjs +``` + +- CDN + +```bash + azioncli edge_applications init --name <"application_name"> --type cdn +``` + +> **Note**: if there's no `package.json` configuration file in your edge application directory, the CLI will return the following error message: + +```bash + Error: Failed to find package.json in current directory. Verify if you are currently in your project's directory +``` + +In that case, create a `package.json` configuration file for your project in the same directory as your edge application. Then rerun the command in order to initialize the application. + +> **Tip**: the best solution for creating a `package.json` file is to start a Node.js project in your edge application directory. To do so, use the command below from the Node.js runtime environment: +> +> `npm init -y` + +Command response in terminal: + +```bash + Wrote to /Users//web-app-proj/package.json: + + { + "name": "web-app-proj", + "version": "1.0.0", + "description": "", + "main": "index.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "keywords": [], + "author": "", + "license": "ISC" + } +``` + +##### No + +The `--no` option forces a `no` response to all user inputs. + +#### Yes + +The `--yes` option forces a 'yes' response to all user inputs. + +--- + +#### Building + +The second step in creating an edge application is to build it based on the attributes provided in the `init` command. The command used to build the application is the `build` command. + +##### Usage + +```bash + azioncli edge_applications build +``` + +##### Flags + +##### Help + +The only flag available for the `build` command is `--help`, which displays a brief help screen. + +**Note**: a requirement for using the `build` command is the presence of the [webPack](https://webpack.js.org/) framework installed on your computer. + +--- + +#### Publishing + +The final step in creating an edge application is publishing it on the Azion platform. The `publish` command performs this task automatically. + +##### Usage + +```bash + azioncli edge_applications publish +``` + +##### Flags + +##### Help + +The only flag available for the `publish` command is `--help`, which displays a brief help screen. + +**Note**: publishing an edge application via **RTM** or CLI isn't an instantaneous process. There's a time to propagate and configure the application in Azion's edge locations. It may be necessary to wait a few minutes for the URL to be activated and the application page to be effectively displayed in the browser. + +--- + +#### Deleting + +The `delete` command is used when you want to delete an edge application. + +##### Usage + +```bash + azioncli edge_applications delete --application-id 1234 +``` + +##### Flags + +##### Application id +The `--application-id` is the unique identifier of your edge application. + +##### Help +The `--help` option displays more information about the `describe` command. + +--- + +#### Describing + +The `describe` command displays information about a specific edge application that matches the given ID, showing the application's attributes in detail. + +##### Usage + +```bash + azioncli edge_applications describe --application-id 4312 + azioncli edge_applications describe --application-id 1337 --out "./tmp/test.json" --format json + azioncli edge_applications describe --application-id 1337 --format json +``` + +##### Flags + +##### Application ID + +The `--application-id` option is the unique identifier of your edge application. + +##### Format + +The `--format` option changes the output format passing the JSON value to the flag. + +##### Help + +The `--help` option displays more information about the `describe` command. + +##### Out + +The `--out` option exports the output to the given ``. + +--- + +#### Listing + +The `list` command is used when you want to list your edge applications. + +##### Usage + +```bash + azioncli edge_applications list +``` + +##### Flags + +##### Details + +The `--details` option displays all relevant fields of your edge application. + +##### Filter + +The `--filter` option filters the applications by their names. + +##### Help + +The `--help` option displays more information about the `describe` command. + +##### Order by + +The `--order_by` option sorts the output based on the selected field. + +##### Page + +The `--page` option returns a page of the list according to its number (default 1). + +##### Page size + +The `--page_size` option defines how many items should be returned per page (default 10). + +##### Sort + +The `--sort` option defines the order of the items on the list. The options are ``. + +### Edge functions + + +#### Listing your edge functions + +List the edge functions available in your library, including the preconfigured `Azion - Hello World` function. + +##### Usage + +```bash + azioncli edge_functions list +``` + +##### Flags + +##### Details + +The `--details` option displays all relevant fields when listing. + +##### Filter + +The `--filter` option filters items by their name. + +##### Help + +The `--help` option displays more information about the list subcommand. + +##### Order by + +The `--order_by` option sorts the output based on the selected field. + +##### Page + +The `--page` option returns a page of the list according to its number (default 1). + +##### Page size + +The `--page_size` option defines how many items should be returned per page (default 10). + +##### Sort + +The `--sort` option defines the order of the items on the list. The options are ``. + +--- + +#### Creating your edge function + +Create a new edge function directly from the **CLI**, without having to resort to **Real-Time Manager (RTM)**. Initially, you'll need a **JavaScript** file containing the function's code. + +##### Usage + +```bash + azioncli edge_functions create --name my-new-ef --code ./my-func.js --active true +``` + +#### Flags + +##### Name + +The `--name` option informs the name of your edge function. + +##### Active + +The `--active` option informs whether your function is active or not. + +##### Args + +The `--args` option informs the path to the edge function's arguments JSON file. + +##### Code + +The `--code` option informs the path to the edge function's source code. + +##### Help + +The `--help` option displays more information about the create subcommand. + +##### In + +The `--in` option informs a given file path to create an edge function. You can use `-` for reading from stdin. + +--- + +#### Deleting your edge function + +Delete an edge function from the Edge Functions library based on its given ID. + +##### Usage + +```bash + azioncli edge_functions delete --function-id 1234 +``` + +##### Flags + +##### Function ID + +The `--function-id` option specifies which edge function will be deleted. + +##### Help + +The `--help` option displays more information about the delete subcommand. + +--- + +#### Describing your edge function + +Describe an edge function from the Edge Functions library based on its given ID. + +#### Usage + +```bash + azioncli edge_functions describe --function-id 4312 + azioncli edge_functions describe --function-id 1337 --with-code + azioncli edge_functions describe --function-id 1337 --out "./tmp/test.json" --format json + azioncli edge_functions describe --function-id 1337 --format json +``` + +#### Flags + +##### Function ID + +The `--function-id` option specifies which edge function will be described. + +##### Help + +The `--help` option displays more information about the `describe` subcommand. + +##### Format + +The `--format` option changes the output format passing the json value to the flag. + +##### Out + +The `--out` option exports the output to the given ``. + +##### With Code + +The `--with-code` option displays the edge function's code. It's disabled by default. + +--- + +#### Updating your edge function + +Update an edge function from the Edge Functions library based on its given ID. + +#### Usage + +```bash + azioncli edge_functions update --function-id 1234 --name 'Hello' + azioncli edge_functions update -f 4185 --code ./mycode/function.js --args ./mycode/myargs.json + azioncli edge_functions update -f 9123 --active true + azioncli edge_functions update -f 9123 --active false + azioncli edge_functions update --in "update.json" +``` + +##### Flags + +##### Name + +The `--name` option informs the name of your edge function. + +##### Active + +The `--active` option informs whether your function is active or not. + +##### Args + +The `--args` option informs the path to the edge function's arguments JSON file. + +##### Code + +The `--code` option informs the path to the edge function's source code. + +##### Help + +The `--help` option displays more information about the create subcommand. + +##### In + +The `--in` option informs a given file path to create an edge function. You can use `-` for reading from stdin. + +##### Function ID + +The `--function-id` option specifies which edge function will be updated. + +### Edge functions instances + +#### Listing your edge application's edge functions instances + +List the edge functions instances related to a specific edge application. + +##### Usage + +```bash + azioncli edge_functions_instances list --application-id 1234123423 +``` + +##### Required flags + +##### application-id + +The `--application-id` flag gives the ID for the edge application and, based on that, the edge functions instances related to the application are listed. + +#### Optional flags + +##### details + +The `--details` option displays all relevant fields when listing. + +##### filter + +The `--filter` option filters items by name. + +##### order_by + +The `--order_by` option sorts the output based on the informed field. + +##### page + +The `--page` option returns a page of the list based on the selected field. + +##### page_size + +The `--page_size` option defines how many items should be returned per page. By default, it's `10`. + +##### sort + +The `--sort` option defines the order of the items on the list. The value should be either `asc` or `desc`. + +##### help + +The `--help` option displays more information about the `list` subcommand. + +--- + +#### Creating an edge functions instance + +Create a new edge functions instance based on given attributes to be used with edge applications. + +#### Usage + +```bash + azioncli edge_functions_instances create --application-id 1673635839 --function-id 12314 --name "name" +``` + +#### Required flags + +##### application-id + +The `--application-id` flag gives the ID for the edge application related to this edge functions instance being created. + +##### function-id + +The `--function-id` flag gives the ID for the edge function related to this edge functions instance being created. + +##### name + +The `--name` flag specifies the name of the edge functions instance. + +#### Optional flags + +##### in + +The `--in` flag informs the file path to the file containing all attributes of the edge functions instance being created. You can use `-` for reading from stdin. + +##### args + +The `--args` option informs the JSON args of the current instance. + +##### help + +The `--help` option displays more information about the `create` subcommand. + +--- + +#### Updating an edge functions instance + +Update an edge functions instance based on given attributes. + +##### Usage + +```bash + azioncli edge_functions_instances update --application-id 10000 --instance-id 1000 --function-id 1000 +``` + +##### Required flags + +##### instance-id + +The `--instance-id` flag gives the ID for the instance being updated. + +##### application-id + +The `--application-id` flag gives the ID for the edge application related to this edge functions instance being updated. + +##### function-id + +The `--function-id` flag gives the ID for the edge function related to this edge functions instance being updated. + +#### Optional flags + +##### in + +The `--in` flag informs the file path to the file containing all attributes of the edge functions instance being updated. You can use `-` for reading from stdin. + +##### args + +The `--args` option informs the JSON args of the current instance. + +##### help + +The `--help` option displays more information about the `update` subcommand. + +--- + +#### Describing an edge functions instance + +Return details about a specific edge functions instance based on a given ID. + +#### Usage + +```bash + azioncli edge_functions_instances describe --application-id 123444 --instance-id 3121223 +``` + +#### Required flags + +##### instance-id + +The `--instance-id` flag gives the ID for the instance being described. + +##### application-id + +The `--application-id` flag gives the ID for the edge application related to the instance being described. + +#### Optional flags + +##### out + +The `--out` option exports the output of the `describe` command to a given filepath. + +##### format + +The `--format` option, followed by the value `json`, changes the output format to JSON. + +##### help + +The `--help` option displays more information about the `describe` subcommand. + +--- + +#### Deleting an edge functions instance + +Delete an edge functions instance on the Azion platform. + +##### Usage + +```bash + azioncli edge_functions_instances delete --application-id 1673635839 --instance-id 12312 +``` + +#### Required flags + +##### instance-id + +The `--instance-id` flag gives the ID for the edge functions instance being deleted. + +##### application-id + +The `--application-id` flag informs the ID of the edge application related to the instance being deleted. + + +#### Optional flags + +##### help + +The `--help` option displays more information about the `delete` subcommand. + +### Domains + + +#### Listing your domains + +List the domains available in your account. + +##### Usage + +```bash + azioncli domains list +``` + +##### Optional flags + +##### details + +The `--details` option displays all relevant fields when listing. + +##### help + +The `--help` option displays more information about the `list` subcommand. + +--- + +#### Creating a domain + +Create a domain on the Azion platform. + +##### Usage + +```bash + azioncli domains create --name domain --application-id 1234 +``` + +##### Required flags + +###### name + +The `--name` flag gives the domain's name. + +##### application-id + +The `--application-id` flag gives the ID for the edge application related to this domain. + +##### Optional flags + +##### help + +The `--help` option displays more information about the `create` subcommand. + +##### cnames + +The `--cnames` option gives a list of aliases to a domain name. + +##### cname-access-only + +The `--cname-access-only` option informs whether the domain will be accessed only through the CNAMES or not. + +##### digital-certificate-id + +The `--digital-certificate-id` option informs the ID of the digital certificate related to the domain being created. + +##### active + +The `--active` option informs whether the domain is active or not. + +##### in + +The `--in` option informs the filepath to a JSON file containing all attributes of the domain being created. + +> **Note**: if the flag `--in` is used, all information will be accessed through the filepath that was passed through the flag, so the other flags aren't necessary. + +--- + +#### Updating a domain + +Update an existing domain on the Azion platform. + +##### Usage + +```bash + azioncli domains update --domain-id 1234 --name 'Hello' +``` + +##### Required flags + +##### domain-id + +The `--domain-id` flag informs the ID of the domain being updated. + +##### Optional flags + +##### help + +The `--help` option displays more information about the `update` subcommand. + +##### application-id + +The `--application-id` option informs the ID of the edge application related to the domain being updated. + +##### digital-certificate-id + +The `--digital-certificate-id` option informs the ID of the digital certificate related to the domain being updated. + +##### name + +The `--name` option informs the new value for the name field, that will be updated. + +##### cnames + +The `--cnames` option gives a list of aliases to a domain name. + +##### cname-access-only + +The `--cname-access-only` option informs whether the domain will be accessed only through the CNAMES or not. + +##### active + +The `--active` option informs whether the domain is active or not. + +##### in + +The `--in` option informs the file path to a JSON file containing all attributes of the domain that will be updated. + +> **Note**: if the flag `--in` is given, all information will be accessed through the filepath that was passed through the flag, so the other flags aren't necessary. + +--- + +#### Describing a domain + +Describe an existing domain on the Azion platform. + +##### Usage + +```bash + azioncli domains describe --domain-id 1234 +``` + +##### Required flags + +##### domain-id + +The `--domain-id` flag informs the ID of the domain that will be described. + +#### Optional flags + +##### out + +The `--out` option exports the output of the `describe` command to a given filepath. + +##### format + +The `--format` option, followed by the value `json`, changes the output format to JSON. + +##### help + +The `--help` option displays more information about the `describe` subcommand. + +--- + +#### Deleting a domain + +Delete a domain on the Azion platform. + +#### Usage + +```bash + azioncli domains delete --domain-id 1234 +``` + +#### Required flags + +##### domain-id + +The `--domain-id` flag informs the ID of the domain that will be deleted. + +#### Optional flags +##### help + +The `--help` option displays more information about the `delete` subcommand. + +### Cache settings + + +#### Listing your cache settings + +List the cache settings configured in an edge application. + +##### Usage + +```bash + azioncli cache-settings --application-id 12738 +``` + +##### Required flags + +##### application-id + +The `--application-id` flag gives the ID for the edge application and, based on that, the cache settings related to the application are listed. + +##### Optional flags + +##### details + +The `--details` option displays all relevant fields when listing. + +##### filter + +The `--filter` option filters items by name. + +##### order_by + +The `--order_by` option sorts the output based on the informed field. + +##### page + +The `--page` option returns a page of the list based on the selected field. + +##### page_size + +The `--page_size` option defines how many items should be returned per page. By default, it's `10`. + +##### sort + +The `--sort` option defines the order of the items on the list. The value should be either `asc` or `desc`. + +##### help + +The `--help` option displays more information about the `list` subcommand. + +--- + +#### Creating cache settings + +Create a Cache Settings configuration based on given attributes to be used with edge applications. + +##### Usage + +```bash + azioncli cache_settings create --name cachesettingsname --application-id 00000000001 +``` + +##### Required flags + +##### name + +The `--name` flag gives the Cache Settings configuration name. + +##### application-id + +The `--application-id` flag gives the ID for the edge application related to this Cache Settings configuration. + +##### Optional flags + +##### help + +The `--help` option displays more information about the `create` subcommand. + +##### adaptive-delivery-action + +The `--adaptive-delivery-action` option informs the Cache Settings configuration adaptive delivery action. By default, it's set as `ignore`. + +##### browser-cache-settings + +The `--browser-cache-settings` option configures the amount of time the content is cached in the web browser. + +##### browser-cache-settings-maximum-ttl + +The `--browser-cache-settings-maximum-ttl` option informs the browser Cache Settings configuration maximum TTL. + +##### cache-by-cookies + +The `--cache-by-cookies` option defines whether cache by cookies is active or not. By default, it's `ignore`. + +##### cache-by-query-string + +The `--cache-by-query-string` option defines how you want the content to be cached according to variations of Query String in your URLs. By default, it's `ignore`. + +##### cdn-cache-settings + +The `--cdn-cache-settings` option configures the amount of time Azion's edge applications take to cache the content. It can either Honor Origin Cache Headers or Override Cache Settings. By default, it's `honor`. + +##### cdn-cache-settings-maximum-ttl + +The `--cdn-cache-settings-maximum-ttl` option informs CDN Cache Settings configuration maximum TTL. By default, it's `60`. + +##### cookie-names + +The `--cookie-names` option distinguishes objects in the Azion cache by name/value of cookies. + +##### enable-caching-for-options + +The `--enable-caching-for-options` option informs whether caching for options is active or not. By default, it's `false`. + +##### enable-caching-for-post + +The `--enable-caching-for-post` option informs whether caching for post is active or not. + +##### enable-caching-string-sort + +The `--enable-caching-string-sort` option informs whether caching string sort is active or not. + +##### in + +The `--in` option informs the file path to a JSON file containing all attributes of the Cache Settings configuration that will be created. + +> **Note**: if the `--in` and `--application-id` flags are given, all information will be accessed through the filepath that was passed through the flag, so the other flags aren't necessary. + +##### l2-caching-enabled + +The `--l2-caching-enabled` option informs whether L2 caching is active or not. + +##### query-string-fields + +The `--query-string-fields` option gives a list of query strings parameters to be considered in the Cache Settings configuration that will segregate the cache to the same URL. + +##### slice-configuration-enabled + +The `--slice-configuration-enabled` option informs whether slice configuration is active or not. + +##### slice-configuration-range + +The `--slice-configuration-range` option gives the slice configuration range. + +##### slice-l2-caching-enabled + +The `--slice-l2-caching-enabled` option informs whether slice L2 configuration is active or not. + +--- + +#### Updating cache settings + +Update a cache settings configuration based on the ID informed and given attributes. + +##### Usage + +```bash + azioncli cache_settings update --application-id 1673635839312 --cache-settings-id 115241237 --name "cachesettingstest" +``` + +##### Required flags + +##### application-id + +The `--application-id` flag informs the ID of the edge application related to the Cache Settings configuration. + +##### cache-settings-id + +The `--cache-settings-id` flag informs the unique identifier for a Cache Settings configuration. + +##### Optional flags + +##### help + +The `--help` option displays more information about the `update` subcommand. + +##### name + +The `--name` flag gives the Cache Settings configuration name. + +##### adaptive-delivery-action + +The `--adaptive-delivery-action` option informs the Cache Settings configuration adaptive delivery action. By default, it's set as `ignore`. + +##### browser-cache-settings + +The `--browser-cache-settings` option configures the amount of time the content is cached in the web browser. + +##### browser-cache-settings-maximum-ttl + +The `--browser-cache-settings-maximum-ttl` option informs the browser Cache Settings configuration maximum TTL. + +##### cache-by-cookies + +The `--cache-by-cookies` option defines whether cache by cookies is active or not. By default, it's `ignore`. + +##### cache-by-query-string + +The `--cache-by-query-string` option defines how you want the content to be cached according to variations of Query String in your URLs. By default, it's `ignore`. + +##### cdn-cache-settings + +The `--cdn-cache-settings` option configures the amount of time Azion's edge applications take to cache the content. It can either Honor Origin Cache Headers or Override Cache Settings. By default, it's `honor`. + +##### cdn-cache-settings-maximum-ttl + +The `cdn-cache-settings-maximum-ttl` option informs CDN Cache Settings configuration maximum TTL. By default, it's `60`. + +##### cookie-names + +The `--cookie-names` option distinguishes objects in the Azion cache by name/value of cookies. + +##### enable-caching-for-options + +The `--enable-caching-for-options` option informs whether caching for options is active or not. By default, it's `false`. + +##### enable-caching-for-post + +The `--enable-caching-for-post` option informs whether caching for post is active or not. + +##### enable-caching-string-sort + +The `--enable-caching-string-sort` option informs whether caching string sort is active or not. + +##### in + +The `--in` option informs the file path to a JSON file containing all attributes of the Cache Settings configuration that will be updated. + +> **Note**: if the `--in` and `--application-id` flags are given, all information will be accessed through the filepath that was passed through the flag, so the other flags aren't necessary. + +##### l2-caching-enabled + +The `--l2-caching-enabled` option informs whether L2 caching is active or not. + +##### query-string-fields + +The `--query-string-fields` option gives a list of query strings parameters to be considered in the Cache Settings configuration that will segregate the cache to the same URL. + +##### slice-configuration-enabled + +The `--slice-configuration-enabled` option informs whether slice configuration is active or not. + +##### slice-configuration-range + +The `--slice-configuration-range` option gives the slice configuration range. + +##### slice-l2-caching-enabled + +The `--slice-l2-caching-enabled` option informs whether slice L2 configuration is active or not. + +--- + +#### Describing a cache settings configuration + +Return details about a specific Cache Settings configuration, based on a given ID. + +##### Usage + +```bash + azioncli cache_settings describe --application-id 1673635839 --cache-settings-id 107313 +``` + +##### Required flags + +##### application-id + +The `--application-id` flag informs the ID of the edge application related to the Cache Settings configuration that will be described. + +##### cache-settings-id + +The `--cache-settings-id` flag informs the unique identifier for a Cache Settings configuration. + +##### Optional flags + +##### out + +The `--out` option exports the output of the `describe` command to a given filepath. + +##### format + +The `--format` option, followed by the value `json`, changes the output format to JSON. + +##### help + +The `--help` option displays more information about the `describe` subcommand. + +--- + +#### Deleting a cache settings configuration + +Delete a Cache Settings configuration on the Azion platform. + +##### Usage + +```bash + azioncli cache_settings delete --application-id 0000092 --cache-settings-id 0029 +``` + +##### Required flags + +##### application-id + +The `--application-id` flag informs the ID of the edge application related to the Cache Settings configuration that will be deleted. + +##### cache-settings-id + +The `--cache-settings-id` flag informs the unique identifier for a Cache Settings configuration. + +#### Optional flags + +##### help + +The `--help` option displays more information about the `delete` subcommand. + +### Origins + + +#### Listing your origins + +List the origins available in your account. + +#### Usage + +```bash + $ azioncli origins --application-id 12738 +``` + +#### Required flags + +##### application-id + +The `--application-id` flag gives the ID for the edge application and, based on that, the origins related to the application are listed. + +#### Optional flags + +##### details + +The `--details` option displays all relevant fields when listing. + +##### help + +The `--help` option displays more information about the `list` subcommand. + +--- + +#### Creating an origin + +Creates an origin based on given attributes to be used with edge applications. + +#### Usage + +```bash + $ azioncli origins create --application-id 1673635839 --name "name" --addresses "xxxxxx.me" --host-header "host" +``` + +#### Required flags + +##### name + +The `--name` flag gives the origin's name. + +##### application-id + +The `--application-id` flag gives the ID for the edge application related to this origin. + +##### addresses + +the `--addresses` flag passes a list of addresses linked to the origin being created. + +##### host-header + +The `--host-header` flag specifies the hostname of the server being accessed. + +#### Optional flags + +##### help + +The `--help` option displays more information about the `create` subcommand. + +##### hmac-authentication + +The `--hmac-authentication` option informs whether Hmac Authentication is used by the origin or not. + +Expected values: + +- `true` +- `false` + +##### hmac-access-key + +The `--hmac-access-key` option informs the Hmac access key, if the value informed through the `--hmac-authentication` flag is `true`. + +##### hmac-region-name + +The `--hmac-region-name` option informs the Hmac region name, if the value informed through the `--hmac-authentication` flag is `true`. + +##### hmac-secret-key + +The `--hmac-secret-key` option informs the Hmac Secret Key, if the value informed through the `--hmac-authentication` flag is `true`. + +##### host-header + +The `--host-header` option specifies the hostname of the server being accessed. + +##### origin-path + +The `--origin-path` option gives the path to be appended to the URI when forwarding the request to the origin. Leave it in blank to use only the URI. + +##### origin-protocol-policy + +The `--origin-protocol-policy` option informs the protocol policy used in the origin. + +##### origin-type + +The `--origin-type` option identifies the source of a record. + +Expected values: + +- `single_origin` +- `load_balancer` + +##### in + +The `--in` option informs the file path to a JSON file containing all attributes of the origin that will be created. + +> **Note**: if the flag `--in` is given, all information will be accessed through the filepath that was passed through the flag, so the other flags aren't necessary. + +--- + +#### Updating an origin + +Updates an Origin based on the ID informed and given attributes. + +##### Usage + +```bash + azioncli origins update --application-id 1673635839 --origin-key "58755fef-e830-4ea4-b9e0-6481f1ef496d" --name "newname" --addresses "xxxxxx.me" --host-header "host" +``` + +##### Required flags + +##### application-id + +The `--application-id` flag informs the ID of the edge application related to the origin. + +##### origin-key + +The `--origin-key` flag informs the origin key unique identifier. + +##### Optional flags + +##### name + +The `--name` flag gives the origin's name. + +##### addresses + +the `--addresses` flag passes a list of addresses linked to the origin being updated. + +##### host-header + +The `--host-header` flag specifies the hostname of the server being accessed. + +##### help + +The `--help` option displays more information about the `update` subcommand. + +##### hmac-authentication + +The `--hmac-authentication` option informs whether Hmac Authentication is used by the origin or not. + +Expected values: + +- `true` +- `false` + +##### hmac-access-key + +The `--hmac-access-key` option informs the Hmac access key, if the value informed through the `--hmac-authentication` flag is `true`. + +##### hmac-region-name + +The `--hmac-region-name` option informs the Hmac region name, if the value informed through the `--hmac-authentication` flag is `true`. + +##### hmac-secret-key + +The `--hmac-secret-key` option informs the Hmac Secret Key, if the value informed through the `--hmac-authentication` flag is `true`. + +##### host-header + +The `--host-header` option specifies the hostname of the server being accessed. + +##### origin-path + +The `--origin-path` option gives the path to be appended to the URI when forwarding the request to the origin. Leave it in blank to use only the URI. + +##### origin-protocol-policy + +The `--origin-protocol-policy` option informs the protocol policy used in the origin. + +##### origin-type + +The `--origin-type` option identifies the source of a record. + +Expected values: + +- `single_origin` +- `load_balancer` + +##### in + +The `--in` option informs the file path to a JSON file containing all attributes of the origin that will be updated. + +> **Note**: if the flag `--in` is given, all information will be accessed through the filepath that was passed through the flag, so the other flags aren't necessary. + +--- + +#### Describing an origin + +Returns details about a specific origin, based on a given ID. + +##### Usage + +```bash + $ azioncli origins describe --application-id 4312 --origin-id 31223 +``` + +##### Required flags + +##### application-id + +The `--application-id` flag informs the ID of the edge application related to the origin that will be described. + +##### origin-id + +The `--origin-id` flag informs the ID of the origin that will be described. + +##### Optional flags + +##### out + +The `--out` option exports the output of the `describe` command to a given filepath. + +##### format + +The `--format` option, followed by the value `json`, changes the output format to JSON. + +##### help + +The `--help` option displays more information about the `describe` subcommand. + +--- + +#### Deleting an origin + +Deletes an origin on the Azion platform. + +#### Usage + +```bash + $ azioncli origins delete --application-id 1234 --origin-key 03a6e7bf-8e26-49c7-a66e-ab8eaa425086 +``` + +#### Required flags + +##### application-id + +The `--application-id` flag informs the ID of the edge application related to the origin that will be deleted. + +##### origin-key + +The `--origin-key` flag informs the origin key unique identifier. + +#### Optional flags + +##### help + +The `--help` option displays more information about the `delete` subcommand. + +### Rules engine + +#### Listing your edge application's rules in Rules Engine + +List the rules related to a specific edge application. + +#### Usage + +```bash + azioncli rules_engine list --application-id 1000 --phase request +``` + +##### Required flags + +##### application-id + +The `--application-id` flag gives the ID for the edge application and, based on that, the rules related to the application are listed. + +##### phase + +The `--phase` flag informs if you want to list the `request` rules or the `response` rules. + +##### Optional flags + +##### details + +The `--details` option displays all relevant fields when listing. + +##### filter + +The `--filter` option filters items by name. + +##### order_by + +The `--order_by` option sorts the output based on the informed field. + +##### page + +The `--page` option returns a page of the list based on the selected field. + +##### page_size + +The `--page_size` option defines how many items should be returned per page. By default, it's `10`. + +##### sort + +The `--sort` option defines the order of the items on the list. The value should be either `asc` or `desc`. + +##### help + +The `--help` option displays more information about the `list` subcommand. + +--- + +#### Generating a template for the rules_engine create and update subcommands + +Generate a rules engine template to be used with the create and update subcommands. + +#### Usage + +```bash + azioncli rules_engine template +``` + +The template will be created, by default, inside the directory you're running Azion CLI on. It looks similar to: + +```json + { + "behaviors": [ + { + "name": "run_function", + "target": 0 + } + ], + "criteria": [ + [ + { + "conditional": "if", + "input_value": "/", + "operator": "starts_with", + "variable": "${uri}" + } + ] + ], + "name": "NewRulesEngine" + } +``` + +#### Optional flags + +##### help + +The `--help` option displays more information about the `template` subcommand. + +--- + +#### Creating a rule in Rules Engine + +Create a new rule in Rules Engine based on given attributes to be used with edge applications. + +##### Usage + +```bash + azioncli rules_engine create --application-id 100 --phase "response" --in ./file.json +``` + +##### Required flags + +##### application-id + +The `--application-id` flag gives the ID for the edge application related to this rule in Rules Engine being created. + +##### phase + +The `--phase` flag informs if you want to create a `request` rule or a `response` rule. + +##### in + +The `--in` flag informs the file path to the [template](#rules-engine-template), which must contain all attributes of the rule being created. + +##### Optional flags + +##### help + +The `--help` option displays more information about the `create` subcommand. + +--- + +#### Updating a rule in Rules Engine + +Update a rule in Rules Engine based on given attributes. + +##### Usage + +```bash + azioncli rules_engine update --application-id 1673635839 --phase request --in rule.json --rule-id +``` + +##### Required flags + +##### rule-id + +The `--rule-id` flag gives the ID for the rule being updated. + +##### application-id + +The `--application-id` flag gives the ID for the edge application related to this rule in Rules Engine being updated. + +##### phase + +The `--phase` flag informs the phase of the rule, `request` or `response`. + +##### in + +The `--in` flag informs the file path to the [template](#rules-engine-template), which must contain all attributes of the rule being updated. + +##### Optional flags + +##### help + +The `--help` option displays more information about the `update` subcommand. + +--- + +#### Describing a rule in Rules Engine + +Return details about a specific rule in Rules Engine, based on a given ID. + +##### Usage + +```bash + azioncli rules_engine describe --application-id 123456 --rule-id 1234 --phase request +``` + +##### Required flags + +##### rule-id + +The `--rule-id` flag gives the ID for the rule being described. + +##### application-id + +The `--application-id` flag gives the ID for the edge application related to the rule being described. + +##### phase + +The `--phase` flag informs the rule phase, `request` or `response`. + +##### Optional flags + +##### out + +The `--out` option exports the output of the `describe` command to a given filepath. + +##### format + +The `--format` option, followed by the value `json`, changes the output format to JSON. + +##### help + +The `--help` option displays more information about the `describe` subcommand. + +--- + +#### Deleting a rule in Rules Engine + +Delete a rule in Rules Engine on the Azion platform. + +##### Usage + +```bash + azioncli rules_engine delete --application-id 1673635839 --rule-id 12312 +``` + +##### Required flags + +##### application-id + +The `--application-id` flag informs the ID of the edge application related to the rule being deleted. + +##### rule-id + +The `--rule-id` flag gives the ID for the rule being deleted. + +##### Optional flags + +##### help + +The `--help` option displays more information about the `delete` subcommand. + +### Environment variables + + +#### Listing your environment variables + +List the environment variables set in your account. + +##### Usage + +```bash + azioncli variables list +``` + +##### Optional flags + +##### details + +The `--details` option displays all relevant fields when listing. + +##### help + +The `--help` option displays more information about the `list` subcommand. + +--- + +#### Creating an environment variable + +Create a new environment variable or secret to be used inside your edge functions. + +##### Usage + +```bash + azioncli variables create --key "Content-Type" --value "string" --secret false +``` + +##### Required flags if the --in flag isn't informed + +##### key + +The `--key` flag provides the variable's key. + +##### value + +The `--value` flag provides the variable's value. + +##### secret + +The `--secret` flag indicates whether the value is meant to be confidential. The default value is `true`. + +##### Optional flags + +##### in + +The `--in` flag informs the file path to the file containing all attributes of variable being created. You can use `-` for reading from stdin. + +##### help + +The `--help` option displays more information about the `create` subcommand. + +--- + +#### Updating an environment variable + +Update an environment variable based on given attributes. + +##### Usage + +```bash + azioncli variables update --variable-id 7a187044-4a00-4a4a-93ed-d2309004019201909321f3 --key 'Content-Type' --value 'json' --secret false +``` + +##### Required flags if the --in flag isn't informed + +##### variable-id + +The `--variable-id` flag gives the UUID for the variable being updated. + +##### key + +The `--key` flag provides the variable's key. + +##### value + +The `--value` flag provides the variable's value. + +##### secret + +The `--secret` flag indicates whether the value is meant to be confidential. The default value is `true`. + +##### Optional flags + +##### in + +The `--in` flag informs the file path to the file containing all attributes of variable being updated. You can use `-` for reading from stdin. + +##### help + +The `--help` option displays more information about the `update` subcommand. + +--- + +#### Describing an environment variable + +Return details about a specific environment variable based on a given UUID. + +##### Usage + +```bash + azioncli variables describe --variable-id 1673635839 +``` + +##### Required flags + +##### variable-id + +The `--variable-id` flag gives the UUID for the variable being described. + +##### Optional flags + +##### out + +The `--out` option exports the output of the `describe` command to a given filepath. + +##### format + +The `--format` option, followed by the value `json`, changes the output format to JSON. + +##### help + +The `--help` option displays more information about the `describe` subcommand. + +--- + +#### Deleting an environment variable + +Delete an environment variable on the Azion platform. + +##### Usage + +```bash + azioncli variables delete --variable-id 7a187044-4a00-4a4a-93ed-d230900423221f3 +``` + +##### Required flags + +##### variable-id + +The `--variable-id` flag provides the UUID for the environment variable being deleted. + +##### Optional flags + +##### help + +The `--help` option displays more information about the `delete` subcommand. diff --git a/src/content/docs/en/pages/guides/cli-static/index.mdx b/src/content/docs/en/pages/guides/cli-static/index.mdx deleted file mode 100644 index a7e3fcc585..0000000000 --- a/src/content/docs/en/pages/guides/cli-static/index.mdx +++ /dev/null @@ -1,322 +0,0 @@ ---- -title: How to deploy a static edge application with Azion CLI -description: Learn how to deploy a static application on the Azion platform with Azion CLI. -meta_tags: cli -namespace: documentation_how_to_cli_static_application -menu_namespace: cliMenu -og_image: '' -permalink: /documentation/products/guides/cli-static-application/ ---- - -import Badge from '~/components/Badge.astro'; - - - for previous versions of azion cli 1.x.y - - -## Static application - -A **static application** built with **HTML**, **CSS**, and **JavaScript** offers several advantages. It allows developers to easily create and maintain websites or informational pages with fixed content. - -The use of HTML provides a structured and organized layout for the application, while CSS enables beautiful and consistent styling, enhancing the overall visual appeal. JavaScript adds interactivity and basic functionality, enhancing the user experience. - -Static applications characteristics: - -- Are straightforward to develop. -- Require minimal server-side processing. -- Faster loading times. -- Efficient performance. - -Additionally, they are suitable for projects with limited complexity and provide a cost-effective solution for static content display. - ---- - -## Requirements - - -To deploy a static application with Azion CLI, you need: - -- The latest version of [Azion CLI installed](/en/documentation/products/cli/first-steps/). -- Basic knowledge on HTML, CSS and JavaScript. - ---- - -### Setting up the project - -1. Open the terminal and create a new folder for your project: - -```bash - mkdir static-application-azion -``` - -2. Access the project folder: - -```bash - cd static-application-azion -``` - -3. Inside the project folder, create an index.html file: - -```bash - touch index.html -``` - -4. Open the project directory in your preferred code editor, such as VSCode: - -```bash - code . -``` - -### Initializing and publishing the static application on the Azion Platform - -1. Copy the following HTML content inside the index.html file: - -```html - - - - - Static HTML Template - - - - - -
- -
- -
-

Welcome to My Website

-

This is the home page of the static HTML template.

- -
- - - - - - - -``` - -2. In the terminal, in your project's root directory, initialize the edge application: - -```bash - azioncli edge_applications init -``` - -**Output** - -```bash - Project name: -``` - -3. Inform the name of your application. - -**Output** - -```bash - Select Type: - nextjs - ▸ static - cdn -``` - -4. Select the type `static`. - -5. Run `azioncli edge_applications publish --path .`. - -**Output** - -```bash - Uploading static files - [##########] 100.00% index.html Upload completed successfully! - Created Edge Function static-test-10 with ID 0 - Created Edge Application static-test-10 with ID 0 - Created Domain static-test-10 with ID 0 - Created Cache Settings for web application - Created Rules Engine for web application - Your Edge Application was published successfully - - To visualize your application access the domain: https://eeaasdasdqwqdq3rxskj57ri.map.azionedge.net -``` - -You'll receive a *domain* to access your static project on the Azion Edge Platform. - -Wait a few minutes so the *propagation* takes place, and then access your application using the provided domain, that should be in the format `https://xxxxxxxxxxx.map.azionedge.net` diff --git a/src/content/docs/en/pages/guides/index.mdx b/src/content/docs/en/pages/guides/index.mdx index 4d48b8359e..c977f7623b 100644 --- a/src/content/docs/en/pages/guides/index.mdx +++ b/src/content/docs/en/pages/guides/index.mdx @@ -126,8 +126,6 @@ permalink: /documentation/products/guides/ - [Configuring Azion CLI's output](/en/documentation/products/guides/cli-output-configuration/) - [Creating an edge application using Azion CLI](/en/documentation/products/guides/cli-creating-edge-application/) - [Managing your edge functions with Azion CLI](/en/documentation/products/guides/cli-managing-edge-functions/) -- [How to Build and Publish a Next.js Project with Server-side Rendering (SSR) on the Azion Platform](/en/documentation/products/guides/nextjs-ssr-on-azion-platform/) -- [How to deploy a static application with Azion CLI](/en/documentation/products/guides/cli-static-application/) --- diff --git a/src/content/docs/en/pages/guides/nextjs/index.mdx b/src/content/docs/en/pages/guides/nextjs/index.mdx deleted file mode 100644 index 79d16b2a68..0000000000 --- a/src/content/docs/en/pages/guides/nextjs/index.mdx +++ /dev/null @@ -1,109 +0,0 @@ ---- -title: How to Build and Publish a Next.js Project with SSR on the Azion Platform -description: Next.js, a flexible framework based on the React library, provides powerful tools for building fast applications. SSR generates HTML for each request, offering several benefits. -meta_tags: javascript, edge computing, Next.js, ssr -namespace: docs_use_case_nextJS -permalink: /documentation/products/guides/nextjs-ssr-on-azion-platform/ ---- - -import Badge from '~/components/Badge.astro'; - - - - for previous versions of azion cli 1.x.y - - -## Next.js and Server-side Rendering (SSR) - -**Next.js**, a flexible framework based on the **React** library, provides powerful tools for building fast applications. - -**SSR** generates HTML for each request, offering several benefits, including: - -- Improved initial loading performance. -- Search engine optimization (SEO). -- Social media sharing. -- Enhanced user experience. -- Accessibility and compatibility. -- Code sharing and performance optimizations. - ---- - -## Next.js SSR Project on the Azion Platform - -### Requirements - -Before getting started, make sure you have: - -- An Azion platform account with Edge Functions enabled. -- Node.js runtime environment v18.x installed in your build environment. -- The latest version of Azion CLI installed. -- Next.js installed. - -To install Azion CLI, visit the [Installing Azion CLI manually](/en/documentation/products/guides/cli-installing-manually/) page. - -### Setting up the Project - -1. Create a new folder for your project: - -```bash - mkdir next-js-azion -``` - -2. Access the project folder: - -```bash - cd next-js-azion -``` - -3. Inside the project folder, use the following command to create a Next.js project: - -```bash - npx create-next-app azion-next-ssr && cd azion-next-ssr && npm i next -``` - -4. Open the project directory in your preferred code editor, such as VSCode: - -```bash - code . -``` - -### Configuring Next.js for Azion - -1. Open the `src/pages/api/hello.js` file in your project's root directory. -2. Paste the following content to the file: - -```js - // Next.js API route support: https://nextjs.org/docs/api-routes/introduction - - export const runtime = 'edge' // 'nodejs' (default) | 'edge' - - export default function handler(req, res) { - res.status(200).json({ name: 'John Doe' }) - } -``` - -### Building and Publishing the application on the Azion Platform - -1. In the terminal, in your project's root directory, initialize the Azion Edge Application: - -```bash - azioncli edge_applications init --type nextjs -``` - -2. Run the `build` command: - -```bash - azioncli edge_applications build -``` - -3. Publish the application: - -```bash - azioncli edge_applications publish -``` - -After running the `publish` command, you'll receive a domain for accessing your SSR Next.js project on the Azion Platform. - -Wait a few minutes so the *propagation* takes place, and then access your application using the provided domain, which should be similar to: - -`https://ala5yasjasdsa0pnm.map.azionedge.net` diff --git a/src/content/docs/pt-br/pages/cli/azion-cli-alpha/azion-overview/azion-overview.mdx b/src/content/docs/pt-br/pages/cli/azion-cli-alpha/azion-overview/azion-overview.mdx index 24ab47b466..fb1010c2e0 100644 --- a/src/content/docs/pt-br/pages/cli/azion-cli-alpha/azion-overview/azion-overview.mdx +++ b/src/content/docs/pt-br/pages/cli/azion-cli-alpha/azion-overview/azion-overview.mdx @@ -147,5 +147,5 @@ A opção `h` ou `--help` exibe mais informações sobre o comando `azion`. --- - diff --git a/src/content/docs/pt-br/pages/cli/azion-cli-beta/azioncli-beta.mdx b/src/content/docs/pt-br/pages/cli/azion-cli-beta/azioncli-beta.mdx new file mode 100644 index 0000000000..f4f22eb312 --- /dev/null +++ b/src/content/docs/pt-br/pages/cli/azion-cli-beta/azioncli-beta.mdx @@ -0,0 +1,1855 @@ +--- +title: Azion CLI Beta +description: A CLI (command-line interface) da Azion é uma ferramenta open source + que possibilita o gerenciamento de serviços oferecidos pela Azion. +meta_tags: CLI +namespace: documentation_CLI_beta +permalink: /documentacao/produtos/cli/beta/ + +--- + +import Button from '~/components/Button.astro' + +:::note +A Azion CLI versão 1.x.y já está disponível. A partir de Setembro de 2023, a Azion CLI Beta versão 0.x.y não receberá mais atualizações. Execute `azioncli -v` or `azion -v` para verificar a versão da mesma. +::: + + + +A **Command-Line Interface** (CLI) da Azion é uma ferramenta [open source](https://github.com/aziontech/azion-CLI/) que possibilita o gerenciamento de serviços oferecidos pela Azion utilizando um terminal. Através da **Azion CLI**, você pode criar e gerenciar serviços como **Edge Functions** e **Edge Services**, bem como provisionar aplicações **Next.js**. + +Visite o site do framework [Next.js](https://nextjs.org/) para maiores informações. + +Com a **Azion CLI**, você pode: + +- Gerenciar produtos da Azion. +- Criar automações utilizando scripts ou pipelines de CI/CD (Integração Contínua/Entrega Contínua). +- Provisionar múltiplos serviços para compor a sua aplicação com poucos comandos. +- Gerenciar suas configurações da Azion como código. + +Para uma visualização geral dos comandos da **CLI**, você pode acessar a [documentação de referência](https://github.com/aziontech/azion-cli/wiki/azioncli). + +> A **Azion CLI** está atualmente em fase **Beta**. Algumas funcionalidades podem ser modificadas até o seu lançamento. Portanto, use-a com cautela em ambientes de produção. Enquanto você experimenta a versão **Beta**, nossa equipe de engenharia adoraria ouvir a sua opinião a fim de aprimorá-la. Contribua com o seu [feedback](https://forms.gle/uBBkyXZCVcrgpvAB8). + +## Sobre as Interfaces de Linha de Comando + +Antes do desenvolvimento das **Interfaces Gráficas do Usuário** (GUI), desenvolvedores de software e usuários interagiam com os computadores utilizando um teclado e um monitor, conhecidos como **terminal**. + +O teclado servia como dispositivo de entrada, no qual o usuário digitava linhas de comando. O computador então processava o comando e apresentava o resultado na tela do monitor, eventualmente com alguma mensagem adicional. + +Os comandos digitados no teclado seguiam regras que permitiam criar uma interface entre o usuário e o computador, normalmente compostas de uma palavra-chave, sinalizadores, e parâmetros. Essa interface, utilizada até hoje, é a **Interface de Linha de Comando** ou **CLI**. + +Posteriormente, as **GUIs** atraíram para o mundo dos computadores os usuários que consideravam a digitação de comandos complexa e desafiadora. Entretanto, a **CLI** nunca perdeu a sua importância, especialmente no ambiente de desenvolvimento de software. + +Na realidade, a **CLI** possui muitas vantagens quando comparada com o uso de interfaces gráficas, como por exemplo: + +- Possibilidade de manipular recursos do computador inacessíveis pelas GUI. +- Rapidez e simplicidade para executar tarefas. +- Flexibilidade na criação de scripts para automação de processos. + +Todos os sistemas operacionais modernos possuem aplicativos do tipo terminal, no qual o usuário pode digitar linhas de comando a fim de executar tarefas no computador. + + +## Instalação + +### Para instalar a CLI utilizando os gerenciadores de pacotes RPM, Dpkg ou apk: + +1. Acesse a nossa [página de lançamentos](https://github.com/aziontech/azion-cli/releases) e baixe o pacote desejado. + +2. Execute o comando da coluna **Comando de instalação** da tabela a seguir referente ao pacote de instalação escolhido. A **CLI** será instalada automaticamente. + +> **Nota**: substitua `` com o pacote de instalação baixado no passo anterior. + +| Gerenciador de pacotes | Site | Documentação | Comando de instalação | +| --------------------- | ------------ | -------- | ----------- | +| RPM | [RPM package manager](https://rpm.org/index.html) | [RPM documentação de suporte](https://rpm.org/documentation.html) | `sudo rpm -i ` | +| Dpkg | [Debian® 5 operating system](https://www.debian.org/) | [Dpkg documentação de suporte](https://wiki.debian.org/Teams/Dpkg) | `sudo dpkg -i ` | +| apk | [Alpine Linux® 6operating system](https://docs.alpinelinux.org/user-handbook/0.1a/Working/apk.html) | [apk documentação de suporte](https://docs.alpinelinux.org/user-handbook/0.1a/Working/apk.html) | `apk add ` | + +3. Execute o comando `azioncli --version` para testar a instalação. A **CLI** apresenta no terminal o número da versão recém-instalada no seu computador. + +### Para instalar a CLI utilizando o Homebrew: + +1. Para utilizar o Homebrew, visite o [site oficial do instalador de pacotes](https://brew.sh/) e siga as instruções de instalação localizadas na sua homepage. + +| Gerenciador de pacotes | Site | Documentação | Comando de instalação | +| --------------------- | ------------ | -------- | ----------- | +| Homebrew | [Homebrew package manager](https://brew.sh/) | [Homebrew documentação de suporte](https://docs.brew.sh/Manpage) | `brew install aziontech/tap/azioncli` | + +Você também pode [instalar a Azion CLI manualmente](/pt-br/documentacao/produtos/guias/cli-instalando-manualmente/). + +Caso você esteja instalando a CLI em um sistema operacional macOS, veja a documentação de [Execução da CLI no sistema operacional macOS](/pt-br/documentacao/produtos/guias/cli-executando-macos/). + +--- + +## Autorização na plataforma da Azion + +Para administrar as suas configurações, você deve gerar um *token* que o identifique na plataforma da Azion. Caso contrário, a **CLI** apresentará uma mensagem de erro no terminal informando que o *token* é inválido ou está expirado. + +Para mais informações sobre como criar e gerenciar os seus *tokens*, utilize a [Azion API](https://api.azion.com/#aab16606-2014-43d0-9b7a-dc564146a1ac) ou veja a página [Personal Tokens](/pt-br/documentacao/produtos/gestao-de-contas/personal-tokens/) de nossa documentação. + +Você pode armazenar localmente um *token* existente e válido utilizando o seguinte comando: + +```bash +azioncli configure --token +``` + +Todos os comandos subsequentes utilizarão esse mesmo token e serão consideradas todas as permissões concedidas à conta que esse token pertence. + +> Você pode substituir o seu token a qualquer momento repetindo o mesmo comando acima. + +--- + + +## Comandos + +### Edge application + +#### Inicializando + +O processo de inicialização cria o ambiente necessário para a construção de sua edge application. Para isso, você precisa: + +- Escolher um dos templates disponíveis na **CLI**: + - Next.js + - Static + - CDN +- Inicializar um projeto **JavaScript** com o **Node.js** runtime environment. + +##### Uso + +```bash +azioncli edge_applications init +``` + +##### Flags + +##### Name + +A opção `--name` pode ser especificada, mas não é obrigatória. Caso não seja informada, o nome do seu projeto será o mesmo que está definido no `package.json` do projeto. + +##### Type + +A opção `--type` pode ser especificada, mas não é obrigatória. Caso não seja informada, o tipo do projeto será autodetectado. + +Atualmente, a CLI tem três templates disponíveis, e o tipo `cdn` para o desenvolvimento de uma edge application que seguem `--type`: + +- Static + +```bash +azioncli edge_applications init --name <"application_name"> --type static +``` + +- Next.js + +```bash + azioncli edge_applications init --name <"application_name"> --type nextjs +``` + +- CDN + +```bash + azioncli edge_applications init --name <"application_name"> --type cdn +``` + +Caso não exista o arquivo de configuração `package.json` no diretório de sua aplicação, a CLI retornará a seguinte mensagem de erro: + +```bash + Error: Failed to find package.json in current directory. Verify if you are currently in your project's directory +``` + +Nesse caso, crie o arquivo de configuração `package.json` no mesmo repositório que se encontra sua aplicação. Então, rode novamente o comando `--init` para inicializar a aplicação. + +> **Dica**: a melhor solução para a criação do arquivo `package.json` é inicializar um projeto **Node.js** no diretório da aplicação. Para fazer isso, use o comando do Node.js runtime environment: +> +> `npm init -y` + +Resposta do comando no terminal: + +```bash + Wrote to /Users//web-app-proj/package.json: + + { + "name": "web-app-proj", + "version": "1.0.0", + "description": "", + "main": "index.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "keywords": [], + "author": "", + "license": "ISC" + } +``` + +##### No + +A opção `--no` força a resposta 'no' para todos inputs do usuário. + +##### Yes + +A opção `--yes` força a resposta 'yes' para todos inputs do usuário. + +--- + +#### 2. Construindo + +O segundo passo na criação de uma edge application é a construção baseada nos atributos que foram passados no comando `init`. O comando usado na construção da aplicação é o `build`. + +##### Uso + +```bash + azioncli edge_applications build +``` + +##### Flags + +##### Help + +A única flag disponível para o comando `build` é `--help`, que mostra uma breve tela de ajuda. + +**Nota**: uma necessidade para o uso do comando `build` é a presença do framework **Webpack** instalado em seu computador. + +--- + +#### Publicando + +O passo final na criação de uma edge application é a publicação da mesma na plataforma da Azion. O comando `publish` realiza essa tarefa automaticamente. + +##### Uso + +```bash + azioncli edge_applications publish +``` + +##### Flags + +##### Help + +A única flag disponível para o comando `publish` é `--help`, que mostra uma breve tela de ajuda. + +**Nota**: a publicação de uma edge application via Real-Time Manager (RTM) ou CLI não é um processo instantâneo. É necessário um tempo para a propagação e configuração da aplicação nos pontos de edge da Azion. Pode ser necessário alguns minutos para que a URL seja ativada e a aplicação possa ser visualizada no navegador. + +--- + +#### Descrevendo + +O subcomando `describe` mostra informações sobre uma edge application específica, baseado no ID que é passado, apresentando seus atributos detalhados. + +##### Uso + +```bash + azioncli edge_applications describe --application-id 4312 + azioncli edge_applications describe --application-id 1337 --out "./tmp/test.json" --format json + azioncli edge_applications describe --application-id 1337 --format json +``` + +##### Flags + +##### Application ID + +O `--application-id` é o identificador único de sua edge application. + +##### Format + +A opção `--format` altera o formato do output, passando o valor `json` pela flag. + +##### Help + +A opção `--help` mostra mais informações sobre o subcomando. + +##### Out + +A opção `--out` exporta o output para o `` informado. + +--- + +#### Deletando + +O comando `delete` é usado para excluir uma edge application. + +##### Uso + +```bash + azioncli edge_applications delete --application-id 1234 +``` + +##### Flags + +##### Application ID + +A opção `--application-id` é o identificador único de uma edge application. + +##### Help + +A opção `--help` mostra mais informações sobre o subcomando. + +--- + +#### Listando + +O comando `list` é utilizado quando for preciso listar suas edge applications. + +##### Uso + +```bash + azioncli edge_applications list +``` + +##### Flags + +##### Details + +A opção `--details` mostra todos os campos relevantes de suas edge applications. + +##### Filter + +A opção `--filter` filtra as aplicações pelo nome. + +##### Help + +A opção `--help` mostra mais informações sobre o comando. + +##### Order by + +A opção `--order_by` ordena a saída baseando-se nos campos selecionados. + +##### Page + +A opção `--page` retorna uma página da lista respeitando o seu número. O valor padrão é `1`. + +##### Page size + +A opção `--page_size` define quantos itens devem ser retornados por página. O valor padrão é `10`. + +##### Sort + +A opção `--sort` define a ordem que as aplicações serão mostradas na lista. As opções são ``. + +--- + +### Edge functions + +#### Listando suas Edge Functions + +Lista as edge functions disponíveis em sua biblioteca. + +##### Uso + +```bash + azioncli edge_functions list +``` + +##### Flags + +##### Details + +A opção `--details` mostra todos os campos relevantes de suas edge functions. + +##### Filter + +A opção `--filter` filtra as aplicações pelo nome. + +##### Help + +A opção `--help` mostra mais informações sobre o comando. + +##### Order by + +A opção `--order_by` ordena a saída baseando-se nos campos selecionados. + +##### Page + +A opção `--page` retorna uma página da lista respeitando o seu número. O valor padrão é `1`. + +##### Page size + +A opção `--page_size` define quantos itens devem ser retornados por página. O valor padrão é `10`. + +##### Sort + +A opção `--sort` define a ordem que as aplicações serão mostradas na lista. As opções são ``. + +--- + +#### Criando uma edge function + +Cria uma edge function diretamente da **CLI**, sem ter necessidade de realizar o processo pelo **Real-Time Manager (RTM)**. + +Inicialmente, precisaremos de um arquivo **JavaScript** contendo o código da função. + +##### Uso + +```bash + azioncli edge_functions create --name my-new-ef --code ./my-func.js --active true +``` + +##### Flags + +##### Name + +A opção `--name` informa o nome de sua edge function. + +##### Active + +A opção `--active` informa se a sua função está ativa ou não. + +##### Args + +A opção `--args` informa o caminho para o arquivo JSON dos argumentos da edge function. + +##### Code + +A opção `--code` informa o caminho para o código fonte da edge function. + +##### Help + +A opção `--help` apresenta mais informações sobre o comando. + +--- + +#### Deletando uma edge function + +Remove uma edge function da sua lista de edge functions, baseando-se no ID informado. + +##### Uso + +```bash + azioncli edge_functions delete --function-id 1234 +``` + +##### Flags + +##### Function ID + +A opção `--function-id` especifica qual edge function será deletada. + +##### Help + +A opção `--help` apresenta mais informações sobre o comando. + +--- + +#### Descrevendo uma edge function + +Descreve uma edge function de sua lista de edge functions, baseando-se no ID informado. + +##### Uso + +```bash + azioncli edge_functions describe --function-id 4312 + azioncli edge_functions describe --function-id 1337 --with-code + azioncli edge_functions describe --function-id 1337 --out "./tmp/test.json" --format json + azioncli edge_functions describe --function-id 1337 --format json +``` + +##### Flags + +##### Function ID + +A opção `--function-id` especifica qual edge function será descrita. + +##### Help + +A opção `--help` apresenta mais informações sobre o comando. + +##### Format + +A opção `--format` altera o formato da saída passando o valor JSON para a flag. + +##### Out + +A opção `--out` exporta a saída para o caminho informado: `` + +##### With Code + +A opção `--with-code` mostra o código da edge function. Vem desabilitado por padrão. + +--- + +#### Atualizando uma edge function + +Atualiza uma edge function de sua lista de edge functions, baseando-se no ID informado. + +##### Uso + +```bash + azioncli edge_functions update --function-id 1234 --name 'Hello' + azioncli edge_functions update -f 4185 --code ./mycode/function.js --args ./mycode/myargs.json + azioncli edge_functions update -f 9123 --active true + azioncli edge_functions update -f 9123 --active false + azioncli edge_functions update --in "update.json" +``` + +##### Flags + +##### Function ID + +A opção `--function-id` especifica qual edge function será atualizada. + +##### Name + +A opção `--name` informa o nome de sua edge function. + +##### Active + +A opção `--active` informa se a sua função está ativa ou não. + +##### Args + +A opção `--args` informa o caminho para o arquivo JSON dos argumentos da edge function. + +##### Code + +A opção `--code` informa o caminho para o código-fonte da edge function. + +##### Help + +A opção `--help` apresenta mais informações sobre o comando. + + + +### Edge functions instances + +#### Uso + +```bash + azioncli edge_functions_instances list --application-id 1234123423 +``` + +#### Flags obrigatórias + +##### application-id + +A flag `--application-id` fornece o ID de uma edge application e, com base nisso, as functions instances relacionadas à ela são listadas. + +#### Flags opcionais + +##### details + +A opção `--details` exibe todos os campos relevantes ao listar. + +##### filter + +A opção `--filter` filtra os itens por nome. + +##### order_by + +A opção `--order_by` classifica a saída com base no campo informado. + +##### page + +A opção `--page` retorna uma página da lista com base no campo selecionado. + +##### page_size + +A opção `--page_size` define quantos itens devem ser listados por página. Por padrão, são `10`. + +##### sort + +A opção `--sort` define a ordem dos itens na lista. O valor deve ser `asc` ou `desc`. + +##### help + +A opção `--help` exibe mais informações sobre o subcomando `list`. + +--- + +#### Criar uma edge functions instance + +Crie uma nova edge functions instance com base em determinados atributos a serem usados em edge applications. + +#### Uso + +```bash + azioncli edge_functions_instances create --application-id 1673635839 --function-id 12314 --name "name" +``` + +#### Flags obrigatórias + +##### application-id + +A flag `--application-id` fornece o ID da edge application relacionada à edge functions instance sendo criada. + +##### function-id + +A flag `--function-id` fornece o ID da edge function relacionada à edge functions instance sendo criada. + +##### name + +A flag `--name` especifica o nome da edge functions instance. + +#### Flags opcionais + +##### in + +A flag `--in` informa o caminho para o arquivo que contém todos os atributos da edge functions instance sendo criada. Você pode usar `-` para ler a partir de stdin. + +##### args + +A opção `--args` informa os JSON args da instance atual. + +##### help + +A opção `--help` exibe mais informações sobre o subcomando `create`. + +--- + +#### Atualizar uma edge functions instance + +Atualize uma edge functions instance com base em determinados atributos. + +#### Uso + +```bash + azioncli edge_functions_instances update --application-id 10000 --instance-id 1000 --function-id 1000 +``` + +#### Flags obrigatórias + +##### instance-id + +A flag `--instance-id` fornece o ID da instance sendo atualizada. + +##### application-id + +A flag `--application-id` fornece o ID da edge application relacionada à edge functions instance sendo atualizada. + +##### function-id + +A flag `--function-id` fornece o ID da edge function relacionada à edge functions instance sendo atualizada. + +#### Flags opcionais + +##### in + +A flag `--in` informa o caminho para o arquivo que contém todos os atributos da edge functions instance sendo criada. Você pode usar `-` para ler a partir de stdin. + +##### args + +A opção `--args` informa os JSON args da instance atual. + +##### help + +A opção `--help` exibe mais informações sobre o subcomando `list`. + +--- + +#### Descrever uma edge functions instance + +Retorne detalhes sobre uma edge functions instance específica com base em um determinado ID. + +#### Uso + +```bash + azioncli edge_functions_instances describe --application-id 123444 --instance-id 3121223 +``` + +#### Flags obrigatórias + +##### instance-id + +A flag `--instance-id` fornece o ID da instance sendo descrita. + +##### application-id + +A flag `--application-id` fornece o ID da edge application relacionada à instance sendo descrita. + +#### Flags opcionais + +##### out + +A opção `--out` exporta a saída do comando `describe` para um determinado caminho de arquivo. + +##### format + +A opção `--format`, seguida pelo valor `json`, altera o formato de saída para JSON. + +##### help + +A opção `--help` exibe mais informações sobre o subcomando `describe`. + +--- + +#### Excluir uma edge functions instance + +Exclua uma edge functions instance vinculada a uma edge application. + +#### Uso + +```bash + azioncli edge_functions_instances delete --application-id 1673635839 --instance-id 12312 +``` + +#### Flags obrigatórias + +##### instance-id + +A flag `--instance-id` fornece o ID da edge functions instance sendo excluída. + +##### application-id + +A flag `--application-id` informa o ID da edge application relacionada à instance sendo excluída. + +#### Flags opcionais + +##### help + +A opção `--help` exibe mais informações sobre o subcomando `delete`. + +--- + +### Cache settings + +#### Listando suas configurações de cache + +Lista as configurações de cache configuradas em uma edge application. + +#### Uso + +```bash + azioncli cache-settings --application-id 123455555 +``` + +#### Flags obrigatórias + +##### application-id + +A `flag` --application-id fornece o ID da edge application e, com base nisso, as configurações de cache relacionadas à ela são listadas. + +##### Flags opcionais + +##### details + +A opção `--details` exibe todos os campos relevantes ao listar. + +##### filter + +A opção `--filter` filtra os itens por nome. + +##### order_by + +A opção `--order_by` ordena a saída com base no campo informado. + +##### page + +A opção `--page` retorna uma página da lista com base no campo selecionado. + +##### page_size + +A opção `--page_size` define quantos itens devem ser listados por página. Por padrão, são `10`. + +##### sort + +A opção `--sort` define a ordem dos itens na lista. O valor deve ser `asc` ou `desc`. + +##### help + +A opção `--help` exibe mais informações sobre o subcomando `list`. + +--- + +#### Criando configurações de cache + +Cria uma configuração de cache, com base em atributos informados, que será usada com edge applications. + +##### Uso + +```bash + azioncli cache_settings create --name cachesettingsname --application-id 00000000001 +``` + +##### Flags obrigatórias + +##### name + +A flag `--name` fornece o nome da configuração de cache. + +##### application-id + +A flag `--application-id` fornece o ID para a edge application relacionada a essa configuração de cache. + +##### Flags opcionais + +##### help + +A opção `--help` exibe mais informações sobre o subcomando `create`. + +##### adaptive-delivery-action + +A opção `--adaptive-delivery-action` informa a ação de adaptive delivery da configuração de cache. Por padrão, é definido como `ignore`. + +##### browser-cache-settings + +A opção `--browser-cache-settings` configura a quantidade de tempo que o conteúdo é armazenado em cache no navegador. + +##### browser-cache-settings-maximum-ttl + +A opção `--browser-cache-settings-maximum-ttl` informa o TTL máximo da configuração de cache do navegador. + +##### cache-by-cookies + +A opção `--cache-by-cookies` define se o cache por cookies está ativo ou não. Por padrão, é definido como `ignore`. + +##### cache-by-query-string + +A opção `--cache-by-query-string` define como você deseja que o conteúdo seja armazenado em cache de acordo com as variações da Query String em suas URLs. Por padrão, é definido como `ignore`. + +##### cdn-cache-settings + +A opção `--cdn-cache-settings` configura a quantidade de tempo que as edge applications levam para armazenar em cache o conteúdo. Podendo ser tanto `Honor Origin Cache Headers` quanto `Override Cache Settings`. Por padrão, é `honor`. + +##### cdn-cache-settings-maximum-ttl + +A opção `--browser-cache-settings-maximum-ttl` informa o TTL máximo da configuração de cache do navegador. Por padrão, é `60`. + +##### cookie-names + +A opção `--cookie-names` distingue objetos no cache da Azion por nome/valor de cookies. + +##### enable-caching-for-options + +A opção `--enable-caching-for-options` informa se o caching for options está ativo ou não. Por padrão, é `false`. + +##### enable-caching-for-post + +A opção `--enable-caching-for-options` informa se o caching for options está ativo ou não. + +##### enable-caching-string-sort + +A opção `--enable-caching-string-sort` informa se o caching string sort está ativo ou não. + +##### in + +A opção `--in` informa o caminho para um arquivo JSON contendo todos os atributos da configuração de cache que será criada. + +> **Observação**: se as flags `--in` e `--application-id` forem fornecidas, todas as informações serão acessadas pelo caminho do arquivo que foi passado pela flag, portanto, as outras flags não serão necessárias. + +##### l2-caching-enabled + +A opção `--l2-caching-enabled` informa se o cache L2 está ativo ou não. + +##### query-string-fields + +A opção `--query-string-fields` fornece uma lista de query strings parameters a serem considerados na configuração Cache Settings que irá segregar o cache para a mesma URL. + +##### slice-configuration-enabled + +A opção `--slice-configuration-enabled` informa se a configuração de slice está ativa ou não. + +##### slice-configuration-range + +A opção `--slice-configuration-range` fornece o range da configuração do slice. + +##### slice-l2-caching-enabled + +A opção `--slice-configuration-enabled` informa se a configuração de slice está ativa ou não. + +--- + +#### Atualizando as configurações de cache + +Atualiza uma configuração de cache com base no ID informado e nos atributos fornecidos. + +##### Uso + +```bash + azioncli cache_settings update --application-id 1673635839 --cache-settings-id 115247 --name "cachesettingstest" +``` + +##### Flags obrigatórias + +##### application-id + +A flag `--application-id` informa o ID da edge application relacionada à configuração de cache. + +##### cache-settings-id + +A flag `--cache-settings-id` informa o identificador único de uma configuração de cache. + +##### Flags opcionais + +##### help + +A opção `--help` exibe mais informações sobre o subcomando `update`. + +##### name + +A flag `--name` fornece o nome da configuração de cache. + +##### adaptive-delivery-action + +A opção `--adaptive-delivery-action` informa a ação de adaptive delivery da configuração de cache. Por padrão, é definido como `ignore`. + +##### browser-cache-settings + +A opção `--browser-cache-settings` configura a quantidade de tempo que o conteúdo é armazenado em cache no navegador. + +##### browser-cache-settings-maximum-ttl + +A opção `--browser-cache-settings-maximum-ttl` informa o TTL máximo da configuração de cache do navegador. + +##### cache-by-cookies + +A opção `--cache-by-cookies` define se o cache por cookies está ativo ou não. Por padrão, é definido como `ignore`. + +##### cache-by-query-string + +A opção `--cache-by-query-string` define como você deseja que o conteúdo seja armazenado em cache de acordo com as variações da Query String em suas URLs. Por padrão, é definido como `ignore`. + +##### cdn-cache-settings + +A opção `--cdn-cache-settings` configura a quantidade de tempo que as edge applications levam para armazenar em cache o conteúdo. Podendo ser tanto `Honor Origin Cache Headers` quanto `Override Cache Settings`. Por padrão, é `honor`. + +##### cdn-cache-settings-maximum-ttl + +A opção `--cdn-cache-settings-maximum-ttl` informa o TTL máximo da configuração de cache do navegador. Por padrão, é `60`. + +##### cookie-names + +A opção `--cookie-names` distingue objetos no cache da Azion por nome/valor de cookies. + +##### enable-caching-for-options + +A opção `--enable-caching-for-options` informa se o caching for options está ativo ou não. Por padrão, é `false`. + +##### enable-caching-for-post + +A opção `--enable-caching-for-post` informa se o caching for post está ativo ou não. + +##### enable-caching-string-sort + +A opção `--enable-caching-string-sort` informa se o caching string sort está ativo ou não. + +##### in + +A opção `--in` informa o caminho para um arquivo JSON contendo todos os atributos da configuração de cache que será alterada. + +> **Observação**: se as flags `--in` e `--application-id` forem fornecidas, todas as informações serão acessadas pelo caminho do arquivo que foi passado pela flag `--in`, portanto, as outras flags não serão necessárias. + +##### l2-caching-enabled + +A opção `--l2-caching-enabled` informa se o cache L2 está ativo ou não. + +##### query-string-fields + +A opção `--query-string-fields` fornece uma lista de query strings parameters a serem considerados na configuração de cache que irá segregar o cache para a mesma URL. + +##### slice-configuration-enabled + +A opção `--slice-configuration-enabled` informa se a configuração de slice está ativa ou não. + +##### slice-configuration-range + +A opção `--slice-configuration-range` fornece o range da configuração do slice. + +##### slice-l2-caching-enabled + +A opção `--slice-l2-caching-enabled` informa se a configuração de slice está ativa ou não. + +--- + +#### Descrevendo uma configuração de cache + +Retorna detalhes sobre uma configuração de cache específica, com base em um determinado ID. + +##### Uso + +```bash + azioncli cache_settings describe --application-id 1673635839 --cache-settings-id 107313 +``` + +##### Flags obrigatórias + +##### application-id + +A flag `--application-id` informa o ID da edge application relacionada à configuração de cache. + +##### cache-settings-id + +A flag `--cache-settings-id` informa o identificador único de uma configuração de cache. + +##### Flags opcionais + +##### out + +A opção `--out` exporta a saída do comando `describe` para um determinado caminho de arquivo. + +##### format + +A opção `--format` , seguida pelo valor `json`, altera o formato de saída para JSON. + +##### help + +A opção `--help` exibe mais informações sobre o subcomando `describe`. + +--- + +#### Excluindo uma configuração de cache + +Exclui uma configuração de cache na plataforma da Azion. + +##### Uso + +```bash + azioncli cache_settings delete --application-id 0000092 --cache-settings-id 0029 +``` + +##### Flags obrigatórias + +##### application-id + +A flag `--application-id` informa o ID da edge application relacionada à configuração de cache. + +##### cache-settings-id + +A flag `--cache-settings-id` informa o identificador único de uma configuração de cache. + +##### Flags opcionais + +##### help + +A opção `--help` exibe mais informações sobre o subcomando `delete`. + + +--- +### Domains + +#### Listando seus domínios + +Lista os domínios disponíveis em sua conta. + +##### Uso + +```bash +azioncli domains list +``` + +##### Flags opcionais + +##### details + +A opção `--details` exibe todos os campos relevantes ao listar. + +##### help + +A opção `--help` exibe mais informações sobre o subcomando `list`. + +--- + +#### Criando um domínio + +Cria um domínio na plataforma da Azion. + +##### Uso + +```bash +azioncli domains create --name domain --application-id 1234 +``` + +##### Flags obrigatórias + +##### name + +A flag `--name` fornece o nome do domínio. + +##### application-id + +A flag `--application-id` fornece o ID da edge application relacionada a este domínio. + +##### Flags opcionais + +##### help + +A opção `--help` exibe mais informações sobre o subcomando `create`. + +##### cnames + +A opção `--cnames` fornece uma lista de *aliases* para um domain name. + +##### cname-access-only + +A opção `--cname-access-only` informa se o domínio será acessado somente através dos CNAMES ou não. + +##### digital-certificate-id + +A opção `--digital-certificate-id` informa o ID do certificado digital relacionado ao domínio que está sendo criado. + +##### active + +A opção `--active` informa se o domínio está ativo ou não. + +##### in + +A opção `--in` informa um *filepath* para um arquivo JSON contendo todos os atributos do domínio que está sendo criado. + +> **Observação**: se a flag `--in` for passada, todas as informações serão acessadas pelo *filepath* informado, portanto as outras flags não são necessárias. + +--- + +#### Atualizando um domínio + +Atualiza um domínio existente na plataforma da Azion. + +##### Uso + +```bash +azioncli domains update --domain-id 1234 --name 'Hello' +``` + +##### Flags obrigatórias + +##### domain-id + +A flag `--domain-id` informa o ID do domínio que está sendo atualizado. + +##### Flags opcionais + +##### help + +A opção `--help` exibe mais informações sobre o subcomando `update`. + +##### application-id + +A opção `--application-id` informa o ID da edge application relacionada ao domínio que está sendo atualizado. + +##### digital-certificate-id + +A opção `--digital-certificate-id` informa o ID do certificado digital relacionado ao domínio que está sendo atualizado. + +##### name + +A opção `--name` informa o novo valor para o campo nome, que será atualizado. + +##### cnames + +A opção `--cnames` fornece uma lista de *aliases* para um domain name. + +##### cname-access-only + +A opção `--cname-access-only` informa se o domínio será acessado somente através dos CNAMES ou não. + +##### active + +A opção `--active` informa se o domínio está ativo ou não. + +##### in + +A opção `--in` informa um *filepath* para um arquivo JSON contendo todos os atributos do domínio que será atualizado. + +> **Observação**: se a flag `--in` for passada, todas as informações serão acessadas pelo *filepath* informado, portanto as outras flags não são necessárias. + +--- + +#### Descrevendo um domínio + +Retorna detalhes de um domínio existente na plataforma da Azion. + +##### Uso + +```bash +azioncli domains describe --domain-id 1234 +``` + +##### Flags obrigatórias + +##### domain-id + +A flag `--domain-id` informa o ID do domínio que será descrito. + +##### Flags opcionais + +##### out + +A opção `--out` exporta a saída do subcomando `describe` para um determinado *filepath*. + +##### format + +A opção `--format`, seguida pelo valor `json`, altera o formato de saída para JSON. + +##### help + +A opção `--help` exibe mais informações sobre o subcomando `describe`. + +--- + +#### Excluindo um domínio + +Exclui um domínio na plataforma da Azion. + +##### Uso + +```bash +azioncli domains delete --domain-id 1234 +``` + +##### Flags obrigatórias + +##### domain-id + +A flag `--domain-id` informa o ID do domínio que será deletado. + +##### Flags opcionais + +##### help + +A opção `--help` exibe mais informações sobre o subcomando `delete`. + +--- + +### Origins + +#### Listando suas origins + +Lista as origins disponíveis em sua conta. + +##### Uso + +```bash + azioncli origins --application-id 12738 +``` + +##### Flags obrigatórias + +##### application-id + +A flag `--application-id` fornece o ID da edge application e, baseado nisso, as origins relacionadas com a edge application são listadas. + +##### Flags opcionais + +##### details + +A opção `--details` exibe todos os campos relevantes ao listar. + +##### help + +A opção `--help` exibe mais informações sobre o subcomando `list`. + +--- + +#### Criando uma origin + +Cria uma origin, baseando-se nos atributos informados, para ser utilizada com edge applications. + +##### Uso + +```bash + azioncli origins create --application-id 1673635839 --name "name" --addresses "xxxxxx.me" --host-header "host" +``` + +##### Flags obrigatórias + +##### name + +A flag `--name` fornece o nome da origin. + +##### application-id + +A flag `--application-id` fornece o ID da edge application vinculada a essa origin. + +##### addresses + +A flag `--addresses` informa uma lista de endereços vinculados à origin que está sendo criada. + +##### host-header + +A flag `--host-header` especifica o hostname do servidor sendo acessado. + +##### Flags opcionais + +##### help + +A opção `--help` exibe mais informações sobre o subcomando `create`. + +##### hmac-authentication + +A opção `--hmac-authentication` informa se a origin utiliza Hmac Authentication ou não. + +Valores esperados: + +- `true` +- `false` + +##### hmac-access-key + +A opção `--hmac-access-key` informa a chave de acesso de Hmac, caso o valor informado através da flag `--hmac-authentication` seja `true`. + +##### hmac-region-name + +A opção `--hmac-region-name` informa o Hmac region name, caso o valor informado através da flag `--hmac-authentication` seja `true`. + +##### hmac-secret-key + +A opção `--hmac-secret-key` informa a Hmac Secret Key, caso o valor informado através da flag `--hmac-authentication` seja `true`. + +##### host-header + +A opção `--host-header` especifica o hostname do servidor sendo acessado. + +##### origin-path + +A opção `--origin-path` fornece o caminho a ser adicionado a URI ao encaminhar a requisição à origin. Deixe em branco para utilizar apenas a URI. + +##### origin-protocol-policy + +A opção `--origin-protocol-policy` informa o protocolo utilizado na origin. + +##### origin-type + +A opção `--origin-type` identifica a fonte de um registro. + +Valores esperados: + +- `single_origin` +- `load_balancer` + +##### in + +A opção `--in` informa o filepath para um arquivo JSON, o qual contém todos atributos da origin que será criada. + +> **Observação**: se a flag `--in` for passada, todas as informações serão acessadas pelo *filepath* informado, portanto as outras flags não são necessárias. + +--- + +#### Atualizando uma origin + +Atualiza uma origin, baseando-se nos identificadores informados e atributos fornecidos. + +##### Uso + +```bash + azioncli origins update --application-id 1673635839 --origin-key "58755fef-e830-4ea4-b9e0-6481f1ef496d" --name "newname" --addresses "xxxxxx.me" --host-header "host" +``` + +##### Flags obrigatórias + +##### application-id + +A flag `--application-id` fornece o ID da edge application vinculada a essa origin. + +##### origin-key + +A flag `--origin-key` fornece a origin key vinculada à origin. + +##### Flags opcionais + +##### help + +A opção `--help` exibe mais informações sobre o subcomando `update`. + +##### name + +A flag `--name` fornece o nome da origin. + +##### addresses + +A flag `--addresses` informa uma lista de endereços vinculados à origin que está sendo atualizada. + +##### host-header + +A flag `--host-header` especifica o hostname do servidor sendo acessado. + +##### hmac-authentication + +A opção `--hmac-authentication` informa se a origin utiliza Hmac Authentication ou não. + +Valores esperados: + +- `true` +- `false` + +##### hmac-access-key + +A opção `--hmac-access-key` informa a chave de acesso de Hmac, caso o valor informado através da flag `--hmac-authentication` seja `true`. + +##### hmac-region-name + +A opção `--hmac-region-name` informa o Hmac region name, caso o valor informado através da flag `--hmac-authentication` seja `true`. + +##### hmac-secret-key + +A opção `--hmac-secret-key` informa a Hmac Secret Key, caso o valor informado através da flag `--hmac-authentication` seja `true`. + +##### host-header + +A opção `--host-header` especifica o hostname do servidor sendo acessado. + +##### origin-path + +A opção `--origin-path` fornece o caminho a ser adicionado a URI ao encaminhar a requisição à origin. Deixe em branco para utilizar apenas a URI. + +##### origin-protocol-policy + +A opção `--origin-protocol-policy` informa o protocolo utilizado na origin. + +##### origin-type + +A opção `--origin-type` identifica a fonte de um registro. + +Valores esperados: + +- `single_origin` +- `load_balancer` + +##### in + +A opção `--in` informa o filepath para um arquivo JSON, o qual contém todos atributos da origin que será atualizada. + +> **Observação**: se a flag `--in` for passada, todas as informações serão acessadas pelo *filepath* informado, portanto as outras flags não são necessárias. + +--- + +#### Descrevendo uma origin + +Retorna detalhes sobre uma origin específica, baseando-se nos identificadores fornecidos. + +##### Uso + +```bash + azioncli origins describe --application-id 4312 --origin-id 31223 +``` + +##### Flags obrigatórias + +##### application-id + +A flag `--application-id` informa o ID da edge application vinculada à origin a ser descrita. + +##### origin-id + +A flag `--origin-id` informa o ID da origin a ser descrita. + +##### Flags opcionais + +##### out + +A opção `--out` exporta a saída do subcomando `describe` para um filepath informado. + +##### format + +A opção `--format`, seguida pelo valor `json`, altera o formato do output para JSON. + +##### help + +A opção `--help` exibe mais informações sobre o subcomando `describe` . + +--- + +#### Deletando uma origin + +Deleta uma origin na plataforma da Azion. + +##### Uso + +```bash + azioncli origins delete --application-id 1234 --origin-key 03a6e7bf-8e26-49c7-a66e-ab8eaa425086 +``` + +##### Flags obrigatórias + +##### application-id + +A flag `--application-id` informa o ID da edge application vinculada à origin que será deletada. + +##### origin-key + +A flag `--origin-key` informa o identificador único origin key. + +##### Flags opcionais + +##### help + +A opção `--help` exibe mais informações sobre o subcomando `describe` . + +--- + +### Rules engine + +#### Listar as regras de uma edge application no Rules Engine + +Liste as regras relacionadas a uma edge application específica. + +##### Uso + +```bash + azioncli rules_engine list --application-id 1000 --phase request +``` + +##### Flags obrigatórias + +##### application-id + +A flag `--application-id` fornece o ID da edge application e, com base nisso, as regras relacionadas à ela são listadas. + +##### phase + +A flag `--phase` informa se você deseja listar as regras de `request` ou as regras de `response`. + +##### Flags opcionais + +##### details + +A opção `--details` exibe todos os campos relevantes ao listar. + +##### filter + +A opção `--filter` filtra os itens por nome. + +##### order_by + +A opção `--order_by` classifica a saída com base no campo informado. + +##### page + +A opção `--page` retorna uma página da lista com base no campo selecionado. + +##### page_size + +A opção `--page_size` define quantos itens devem ser listados por página. Por padrão, são `10`. + +##### sort + +A opção `--sort` define a ordem dos itens na lista. O valor deve ser `asc` ou `desc`. + +##### help + +A opção `--help` exibe mais informações sobre o subcomando `list`. + +--- + +#### Gerar um template para os subcomandos rules_engine create e update + +Gere um template de Rules Engine a ser usado com os subcomandos Create e Update. + +##### Uso + +```bash + azioncli rules_engine template +``` + +O template será criado, por padrão, dentro do diretório em que você está executando a Azion CLI. + +Template gerado: + +```json + { + "behaviors": [ + { + "name": "run_function", + "target": 0 + } + ], + "criteria": [ + [ + { + "conditional": "if", + "input_value": "/", + "operator": "starts_with", + "variable": "${uri}" + } + ] + ], + "name": "NewRulesEngine" + } +``` + +##### Flags opcionais + +##### help + +A opção `--help` exibe mais informações sobre o subcomando `template`. + +##### out + +A opção `--out` exporta o template para um determinado caminho de arquivo que deve ser informado. + +--- + +#### Criar uma regra no Rules Engine + +Crie uma nova regra no Rules Engine, com base em atributos informados, para ser utilizada em uma edge application. + +##### Uso + +```bash + azioncli rules_engine create -application-id 100 --phase "response" --in ./file.json +``` + +##### Flags obrigatórias + +##### application-id + +A flag `--application-id` fornece o ID da edge application relacionada à regra sendo criada. + +##### phase + +A flag `--phase` informa se você deseja criar uma regra de `request` ou uma regra de `response`. + +##### in + +A flag `--in` informa o caminho do arquivo para o [template](#rules-engine-template), que deve conter todos os atributos da regra que está sendo criada. + +##### Flags opcionais + +##### help + +A opção `--help` exibe mais informações sobre o subcomando `create`. + +--- + +#### Atualizar uma regra no Rules Engine + +Atualize uma regra no Rules Engine com base em atributos fornecidos. + +##### Uso + +```bash + azioncli rules_engine update --application-id 1673635839 --phase request --in rule.json --rule-id +``` + +##### Flags obrigatórias + +##### rule-id + +A flag `--rule-id` fornece o ID da regra que está sendo atualizada. + +##### application-id + +A flag `--application-id` fornece o ID da edge application relacionada à regra sendo atualizada. + +##### phase + +A flag `--phase` informa a fase da regra, `request` ou `response`. + +##### in + +A flag `--in` informa o caminho do arquivo para o [template](#rules-engine-template), que deve conter todos os atributos da regra que está sendo atualizada. + +##### Flags opcionais + +##### help + +A opção `--help` exibe mais informações sobre o subcomando `update`. + +--- + +#### Descrever uma regra no rules engine + +Retorne detalhes sobre uma regra específica no Rules Engine, com base em um determinado ID. + +##### Uso + +```bash + azioncli rules_engine describe --application-id 123456 --rule-id 1234 --phase request +``` + +##### Flags obrigatórias + +##### rule-id + +A flag `--rule-id` fornece o ID da regra que está sendo descrita. + +##### application-id + +A flag `--application-id` fornece o ID da edge application relacionada à regra sendo descrita. + +##### fase + +A flag `--phase` informa a fase da regra, `request` ou `response`. + +##### Flags opcionais + +##### out + +A opção `--out` exporta a saída do comando `describe` para um determinado caminho de arquivo. + +##### format + +A opção `--format` , seguida pelo valor `json`, altera o formato de saída para JSON. + +##### help + +A opção `--help` exibe mais informações sobre o subcomando `describe`. + +--- + +#### Excluir uma regra no Rules Engine +Exclua uma regra no Rules Engine na plataforma da Azion. + +##### Uso + +```bash + azioncli rules_engine delete --application-id 1673123635839 --rule-id 1231122 +``` + +##### Flags obrigatórias + +##### application-id + +A flag `--application-id` informa o ID da edge application relacionada à regra que está sendo excluída. + +##### rule-id + +A flag `--rule-id` fornece o ID da regra que está sendo excluída. + +##### Flags opcionais + +##### help + +A opção `--help` exibe mais informações sobre o subcomando `delete`. + +--- + +### Environment variables + +#### Listar suas variáveis de ambiente +Liste as variáveis de ambiente definidas em sua conta. + +##### Uso + +```bash + azioncli variables list +``` + +##### Flags opcionais + +##### details + +A opção `--details` exibe todos os campos relevantes ao listar. + +##### help + +A opção `--help` exibe mais informações sobre o subcomando `list`. + +--- + +#### Criar uma variável de ambiente + +Crie uma nova variável de ambiente ou segredo para ser usado dentro de suas edge functions. + +##### Uso + +```bash + azioncli variables create --key "Content-Type" --value "string" --secret false +``` + +##### Flags obrigatórias caso a flag --in não seja informada + +##### key + +A flag `--key` fornece a chave da variável. + +##### value + +A flag `--value` fornece o valor da variável. + +##### secret + +A flag `--secret` indica se o valor deve ser confidencial. O valor padrão é `true`. + +##### Flags opcionais + +##### in + +A opção `--in` informa o caminho do arquivo que contém todos os atributos da variável que está sendo criada. Você pode usar `-` para ler a partir de stdin. + +##### help + +A opção `--help` exibe mais informações sobre o subcomando `create`. + +--- + +#### Atualizar uma variável de ambiente + +Atualizar uma variável de ambiente com base em determinados atributos. + +##### Uso + +```bash + azioncli variables update --variable-id 7a187044-4a00-4a4a-93ed-d2309004019201909321f3 --key 'Content-Type' --value 'json' --secret false +``` + +##### Flags obrigatórias caso a flag --in não seja informada + +##### variable-id + +A flag `--variable-id` fornece o UUID da variável que está sendo atualizada. + +##### key + +A flag `--key` fornece a chave da variável. + +##### value + +A flag `--value` fornece o valor da variável. + +##### secret + +A flag `--secret` indica se o valor deve ser confidencial. O valor padrão é `true`. + +##### Flags opcionais + +##### in + +A opção `--in` informa o caminho do arquivo que contém todos os atributos da variável que está sendo atualizada. Você pode usar `-` para ler a partir de stdin. + +##### help + +A opção `--help` exibe mais informações sobre o subcomando `update`. + +--- + +#### Descrever uma variável de ambiente + +Retorne detalhes sobre uma variável de ambiente específica com base em um determinado UUID. + +##### Uso + +```bash + azioncli variables describe --variable-id 1673635839 +``` + +##### Flags obrigatórias + +##### variable-id + +A flag `--variable-id` fornece o UUID da variável que está sendo descrita. + +##### Flags opcionais + +##### out + +A opção `--out` exporta a saída do comando `describe` para um determinado caminho de arquivo. + +##### format + +A opção `--format` , seguida pelo valor `json`, altera o formato de saída para JSON. + +##### help + +A opção `--help` exibe mais informações sobre o subcomando `describe`. + +--- + +#### Excluir uma variável de ambiente + +Exclua uma variável de ambiente na plataforma Azion. + +#### Uso + +```bash + azioncli variables delete --variable-id 7a187044-4a00-4a4a-93ed-d230900423221f3 +``` + +#### Flags obrigatórias + +##### variable-id + +A flag `--variable-id` fornece o UUID da variável de ambiente que está sendo excluída. + +##### Flags opcionais + +##### help + +A opção `--help` exibe mais informações sobre o subcomando `delete`. diff --git a/src/content/docs/pt-br/pages/guias/cli-static/index.mdx b/src/content/docs/pt-br/pages/guias/cli-static/index.mdx deleted file mode 100644 index ab61dfab27..0000000000 --- a/src/content/docs/pt-br/pages/guias/cli-static/index.mdx +++ /dev/null @@ -1,338 +0,0 @@ ---- - -title: Como fazer o deploy de uma aplicação estática com a Azion CLI -description: Uma aplicação estática construída com HTML, CSS e JavaScript oferece alguns benefícios, como permitir que os desenvolvedores criem e mantenham facilmente sites ou páginas com conteúdo fixo. -meta_tags: cli -namespace: documentation_how_to_cli_static_application -menu_namespace: cliMenu -permalink: /documentacao/produtos/guias/cli-static-application/ ---- - -import Badge from '~/components/Badge.astro'; - - - para versões da Azion CLI anteriores à 1.x.y - - -Uma aplicação estática construída com **HTML**, **CSS** e **JavaScript** oferece alguns benefícios, como permitir que os desenvolvedores criem e mantenham facilmente sites ou páginas com conteúdo fixo. - -O uso do HTML fornece um layout estruturado e organizado para a aplicação, enquanto o CSS permite um estilo consistente, aprimorando o apelo visual em geral. O JavaScript adiciona interatividade e funcionalidade básica, melhorando a experiência do usuário. - -Características das aplicações estáticas: - -- São fáceis de serem desenvolvidas. -- Requerem processamento mínimo no lado do servidor. -- Possuem carregamento mais rápido. -- Têm eficiência no desempenho. - -Além disso, elas são adequadas para projetos com complexidade limitada e fornecem uma solução viável para exibição de conteúdo estático. - ---- - -## Pré-requisitos - -Para implementar uma aplicação estática através da Azion CLI, é necessário: - -- Ter a versão mais recente da [Azion CLI instalada](/pt-br/documentacao/produtos/cli/primeiros-passos/). -- Possuir conhecimento básico em HTML, CSS e JavaScript. - ---- - -## Configurar o projeto - -1. Abra o terminal e crie uma nova pasta para o seu projeto: - -```bash - mkdir static-application-azion -``` - - - -2. Acesse a pasta do projeto: - -```bash - cd static-application-azion -``` - - - -3. Dentro da pasta do projeto, crie um arquivo `index.html`: - -```bash - touch index.html -``` - - - -4. Abra o diretório do projeto em seu editor de código preferido, como VS Code: - -```bash - code . -``` - ---- - -### Inicialização e publicação de uma aplicação estática na Plataforma de Edge da Azion - -1. Copie o seguinte conteúdo para dentro do arquivo `index.html`: - -```html - - - - - Static HTML Template - - - - - -
- -
- -
-

Welcome to My Website

-

This is the home page of the static HTML template.

- -
- - - - - - - -``` - - - -2. No terminal, dentro do diretório raiz do seu projeto, inicialize a edge application: - -```bash - azioncli edge_applications init -``` - -**Saída:** - -```bash - Project name: -``` - - - -3. Informe o nome do sua aplicação: - -**Saída:** - -```bash - Select Type: - nextjs - ▸ static - cdn -``` - - - -4. Selecione o tipo `static`. -5. Execute o seguinte comando: - -```bash - azioncli edge_applications publish --path . -``` - -**Saída:** - -```bash - Uploading static files - [##########] 100.00% index.html Upload completed successfully! - Created Edge Function static-test-10 with ID 0 - Created Edge Application static-test-10 with ID 0 - Created Domain static-test-10 with ID 0 - Created Cache Settings for web application - Created Rules Engine for web application - Your Edge Application was published successfully - - To visualize your application access the domain: https://eeaasdasdqwqdq3rxskj57ri.map.azionedge.net -``` - -Você receberá um *domínio* para acessar seu projeto estático na Plataforma da Azion. - -Aguarde alguns minutos para que a *propagação* ocorra e, em seguida, acesse sua aplicação usando o domínio fornecido, que deve se parecer com: `https://xxxxxxxxxxx.map.azionedge.net` - - diff --git a/src/content/docs/pt-br/pages/guias/guides.mdx b/src/content/docs/pt-br/pages/guias/guides.mdx index 7b27b4bf1f..397f99cdab 100644 --- a/src/content/docs/pt-br/pages/guias/guides.mdx +++ b/src/content/docs/pt-br/pages/guias/guides.mdx @@ -127,8 +127,6 @@ permalink: /documentacao/produtos/guias/ - [Configurando a saída do comando edge_applications da CLI](/pt-br/documentacao/produtos/guias/cli-configuracao-saida/) - [Como criar uma edge application usando a Azion CLI](/pt-br/documentacao/produtos/guias/cli-criando-edge-application/) - [Gerenciando suas edge functions utilizando a Azion CLI](/pt-br/documentacao/produtos/guias/cli-gerenciando-edge-functions/) -- [Como criar e publicar um projeto Next.js com SSR na plataforma da Azion](/pt-br/documentacao/produtos/guias/nextjs-ssr-na-plataforma-azion/) -- [Como fazer o deploy de uma aplicação estática com a Azion CLI](/pt-br/documentacao/produtos/guias/cli-static-application/) --- diff --git a/src/content/docs/pt-br/pages/guias/nextjs/index.mdx b/src/content/docs/pt-br/pages/guias/nextjs/index.mdx deleted file mode 100644 index 45bc5faf7a..0000000000 --- a/src/content/docs/pt-br/pages/guias/nextjs/index.mdx +++ /dev/null @@ -1,109 +0,0 @@ ---- - -title: Como criar e publicar um projeto Next.js com SSR na plataforma da Azion. -description: Next.js, um framework flexível baseado em React, fornece ferramentas poderosas para criar aplicações rápidas. O SSR gera o HTML para cada requisição, oferecendo vários benefícios. -meta_tags: javascript, edge computing, Next.js -namespace: docs_use_case_nextJS -permalink: /documentacao/produtos/guias/nextjs-ssr-na-plataforma-azion/ ---- - -import Badge from '~/components/Badge.astro'; - - - para versões da Azion CLI anteriores à 1.x.y - - -**Next.js**, um framework flexível baseado na biblioteca **React**, fornece ferramentas poderosas para criar aplicações rápidas. - -O **SSR** gera o HTML para cada requisição, oferecendo vários benefícios, como: - -- Melhor desempenho de carregamento inicial. -- SEO (Search Engine Optimization). -- Compartilhamento nas redes sociais. -- Experiência de usuário aprimorada. -- Acessibilidade e compatibilidade. -- Compartilhamento de código e otimizações de desempenho. - ---- - -## Projeto Next.js com SSR na Plataforma Azion - -### Pré-requisitos - -Antes de iniciar a implementação, certifique-se de ter: - -- Uma conta da plataforma Azion com o módulo de Edge Functions ativado. -- O Node.js na versão 18.x instalado em seu ambiente de desenvolvimento. -- A versão mais recente da Azion CLI instalada. -- Next.js instalado. - -Para instalar a Azion CLI, visite a página [Instalando o Azion CLI manualmente](/pt-br/documentacao/produtos/guias/cli-instalando-manualmente/). - -### Configurando o Projeto - -1. Crie uma nova pasta para o seu projeto: - -```bash - mkdir next-js-azion -``` - -2. Acesse a pasta do projeto: - -```bash - cd next-js-azion -``` - -3. Dentro da pasta do projeto, use o seguinte comando para criar um projeto Next.js: - -```bash - npx create-next-app azion-next-ssr && cd azion-next-ssr && npm i next -``` - -4. Abra o diretório do projeto em seu editor de código preferido, como VSCode: - -```bash - code . -``` - -### Configurando Next.js para Azion - -1. Abra o arquivo `src/pages/api/hello.js` no diretório raiz do seu projeto. -2. Copie e cole a seguinte configuração: - -```js - // Next.js API route support: https://nextjs.org/docs/api-routes/introduction - - export const runtime = 'edge' // 'nodejs' (default) | 'edge' - - export default function handler(req, res) { - res.status(200).json({ name: 'John Doe' }) - } -``` - -### Publicando a aplicação na Plataforma da Azion - -1. No terminal, no diretório raiz do seu projeto, inicialize a edge application: - -```bash - azioncli edge_applications init --type nextjs -``` - -2. Execute o comando `build`: - -```bash - azioncli edge_applications build -``` - -3. Publique a aplicação: - -```bash - azioncli edge_applications publish -``` - -Depois de executar o comando `publish`, você receberá um domínio para acessar seu projeto Next.js com SSR na Plataforma da Azion. - -Aguarde alguns minutos para que a *propagação* ocorra e, em seguida, acesse sua edge application usando o domínio fornecido, que deve ser semelhante a: - -`https://ala5yasjasdsa0pnm.map.azionedge.net` - -