-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Edu-5536] Static Cache + Videoteca Player template (#1387)
* feat: add videoteca template guide * feat: add link on guides home * feat: add links to template overview * Apply suggestions from code review Co-authored-by: Mariana Bellorín Aguilera <[email protected]> * feat: add link to origins doc * Apply suggestions from code review --------- Co-authored-by: Mariana Bellorín Aguilera <[email protected]>
- Loading branch information
1 parent
eb942a6
commit 6b053dd
Showing
6 changed files
with
223 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
98 changes: 98 additions & 0 deletions
98
src/content/docs/en/pages/guides/marketplace/templates/videoteca-static-cache.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| --- | ||
| title: How to deploy the Static Cache + Videoteca Player template | ||
| description: Deploy an application with static cache settings using the Videoteca Player. | ||
| meta_tags: templates, guides, Azion Marketplace, web | ||
| namespace: docs_guides_static_cache_videoteca_player | ||
| permalink: /documentation/products/guides/static-cache-videoteca-template/ | ||
| --- | ||
|
|
||
| import Tag from 'primevue/tag'; | ||
|
|
||
| <Tag severity="info" client:only="vue"> | ||
| Preview | ||
| </Tag> | ||
|
|
||
| The **Static Cache + Videoteca Player** template enhances the delivery and performance of static and dynamic content based on file extensions. It implements the Azion **Videoteca Player** integration for easy hosting of your Videofront's Videoteca player via iframe embedding. | ||
|
|
||
| The deployment of this template creates a GitHub repository containing your project, an edge application with several Cache Settings and a preconfigured route to launch the Videoteca Player edge function, as well as a domain to facilitate your access and management through Azion Edge Platform. | ||
|
|
||
|
|
||
| --- | ||
|
|
||
| ## Requirements | ||
|
|
||
| - A [GitHub account](https://github.com/signup) to connect with Azion and create your new repository. | ||
| - Every push will be deployed automatically to this repository to keep your project updated. | ||
| - The [Videoteca Player integration](/en/products/guides/videoteca-player/) installed and configured in your Azion account. | ||
| - This template uses [Application Accelerator](/en/documentation/products/build/edge-application/application-accelerator/), [Edge Functions](/en/documentation/products/build/edge-application/edge-functions/), [Image Processor](/en/documentation/products/build/edge-application/image-processor/), and [Edge Cache](/en/documentation/products/build/edge-application/edge-cache/), and it could generate usage-related costs. Check the [pricing page](https://www.azion.com/en/pricing/) for more information. | ||
|
|
||
| --- | ||
|
|
||
| ## Deploying the template | ||
|
|
||
| You can obtain and configure your template through the Azion Console. To easily deploy it at the edge, click the button below. | ||
|
|
||
| <LinkButton | ||
| label="Deploy" | ||
| link="https://console.azion.com/create/videofront/static-cache-videoteca-player" | ||
| icon="ai ai-azion" | ||
| icon-pos="left" | ||
| /> | ||
|
|
||
| --- | ||
|
|
||
| ## Setting up the template | ||
|
|
||
| In the configuration form, you must provide the information to configure your application. Fill in the presented fields. | ||
|
|
||
| Fields identified with an asterisk are mandatory. | ||
|
|
||
| 1. Define a name for your edge application. | ||
| - The bucket for storage and the edge function will use the same name. | ||
| - Use a unique and easy-to-remember name. If the name has already been used, the platform returns an error message. | ||
| 2. Fill the additional fields with the information needed for configuring the **Videoteca Player integration**. | ||
| - `Origin Address`: the domain name or IP address for your origin. | ||
| - `Custom Host Header`: customized value for the `host` header. Leave it blank to use the same address from the previous field. Read more about the host header and how to customize it on the [Origins](/en/documentation/products/build/edge-application/origins/#host-header) documentation. | ||
| - `Videoteca Player Path`: the path for the Videoteca player. Example: `/player`. | ||
| - `Videoteca Username`: the username for the Videoteca account. | ||
| - `Videoteca API Token`: the token for the Videoteca API. | ||
|
|
||
| :::note | ||
| You must retrieve your credentials from your **Videoteca Account**. You can get your token at `https://<YOUR-USER>.videotecaead.com.br/Apidoc` by replacing `<YOUR-USER>` with your `username`. | ||
| ::: | ||
|
|
||
| 3. Click the **Deploy** button to start the deployment process. | ||
|
|
||
| During the deployment, you'll be able to follow the process through a window showing off the logs. When it's complete, the page shows information about the application and some options to continue your journey. | ||
|
|
||
| :::note | ||
| The link to the edge application allows you to see it on the browser. However, it takes a certain 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 for the application page to be effectively displayed in the browser. | ||
| ::: | ||
|
|
||
| --- | ||
|
|
||
| ## Managing the template | ||
|
|
||
| Considering that this initial setup may not be optimal for your specific edge application, all settings can be customized any time you need by using Azion's platform. | ||
|
|
||
| To manage and edit your edge application's settings, follow these steps: | ||
|
|
||
| 1. [Access Azion Console](https://console.azion.com). | ||
| 2. On the upper-left corner, select **Products menu**, the icon with three horizontal lines, > **Edge Application**. | ||
| - You'll be redirected to the **Edge Application** page. It lists all the edge applications you've created. | ||
| 3. Find the edge application related to your template and select it. | ||
| - The list is organized alphabetically. You can also use the **search bar** located in the upper-left corner of the list; currently, it filters only by **Application Name**. | ||
|
|
||
| After selecting the edge application you'll work on, you'll be directed to a page containing all the settings you can configure. | ||
|
|
||
| :::tip | ||
| Read the documentation about [managing edge applications](/en/documentation/products/build/edge-application/first-steps/) for more details. | ||
| ::: | ||
|
|
||
| ### Adding a custom domain | ||
|
|
||
| The edge application created during the deployment has an assigned Azion domain to make it accessible through the browser. The domain has the following format: `xxxxxxxxxx.map.azionedge.net/`. However, you can add a custom domain for users to access your edge application through it. | ||
|
|
||
| import LinkButton from 'azion-webkit/linkbutton'; | ||
|
|
||
| <LinkButton link="/en/documentation/products/guides/configure-a-domain/" label="go to configuring a domain guide" severity="secondary" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
97 changes: 97 additions & 0 deletions
97
...content/docs/pt-br/pages/guias/marketplace/templates/videoteca-static-cache.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| --- | ||
| title: Como implantar o template Static Cache + Videoteca Player | ||
| description: Implemente uma aplicação com configurações de cache estático usando o Videoteca Player. | ||
| meta_tags: templates, guides, Azion Marketplace, web | ||
| namespace: docs_guides_static_cache_videoteca_player | ||
| permalink: /documentacao/produtos/guias/static-cache-videoteca-template/ | ||
| --- | ||
|
|
||
| import Tag from 'primevue/tag'; | ||
|
|
||
| <Tag severity="info" client:only="vue"> | ||
| Preview | ||
| </Tag> | ||
|
|
||
| O template **Static Cache + Videoteca Player** melhora a entrega e o desempenho de conteúdo estático e dinâmico com base nas extensões de arquivo. Ele implementa a integração **Videoteca Player** da Azion para facilitar a hospedagem do seu player Videoteca do Videofront via incorporação de iframe. | ||
|
|
||
| A implantação deste template cria um repositório no GitHub contendo seu projeto, bem como uma edge application com várias configurações de cache e uma rota pré-configurada para lançar a edge function do Videoteca Player, além de um domínio para facilitar seu acesso e gerenciamento através da Plataforma Edge da Azion. | ||
|
|
||
| --- | ||
|
|
||
| ## Requisitos | ||
|
|
||
| - Uma [conta no GitHub](https://github.com/signup) para conectar-se à Azion e criar seu novo repositório. | ||
| - Cada push será implantado automaticamente neste repositório para manter seu projeto atualizado. | ||
| - A [integração do Videoteca Player](/pt-br/produtos/guias/videoteca-player/) instalada e configurada em sua conta Azion. | ||
| - Este template utiliza [Application Accelerator](/pt-br/documentacao/produtos/build/edge-application/application-accelerator/), [Edge Functions](/pt-br/documentacao/produtos/build/edge-application/edge-functions/), [Image Processor](/pt-br/documentacao/produtos/build/edge-application/image-processor/) e [Edge Cache](/pt-br/documentacao/produtos/build/edge-application/edge-cache/), e pode gerar custos relacionados ao uso. Consulte a [página de preços](https://www.azion.com/pt-br/precos/) para mais informações. | ||
|
|
||
| --- | ||
|
|
||
| ## Implante o template | ||
|
|
||
| Você pode obter e configurar seu template através do Azion Console. Para implantá-lo facilmente no edge, clique no botão abaixo. | ||
|
|
||
| <LinkButton | ||
| label="Deploy" | ||
| link="https://console.azion.com/create/videofront/static-cache-videoteca-player" | ||
| icon="ai ai-azion" | ||
| icon-pos="left" | ||
| /> | ||
|
|
||
| --- | ||
|
|
||
| ## Configure o template | ||
|
|
||
| No formulário de configuração, você deve fornecer as informações para configurar sua aplicação. Preencha os campos apresentados. | ||
|
|
||
| Os campos identificados com um asterisco são obrigatórios. | ||
|
|
||
| 1. Defina um nome para sua edge application. | ||
| - O bucket para armazenamento e a edge function usarão o mesmo nome. | ||
| - Use um nome único e fácil de lembrar. Se o nome já tiver sido usado, a plataforma retornará uma mensagem de erro. | ||
| 2. Preencha os campos adicionais com as informações necessárias para configurar a **integração Videoteca Player**. | ||
| - `Origin Address`: o nome do domínio ou endereço IP da sua origem. | ||
| - `Custom Host Header`: valor personalizado para o cabeçalho `host`. Deixe em branco para usar o mesmo endereço do campo anterior. Leia mais sobre o cabeçalho host e como personalizá-lo na documentação sobre [origens](/pt-br/documentacao/produtos/build/edge-application/origins/#host-header). | ||
| - `Videoteca Player Path`: o caminho para o player Videoteca. Exemplo: `/player`. | ||
| - `Videoteca Username`: o nome de usuário da conta Videoteca. | ||
| - `Videoteca API Token`: o token da API Videoteca. | ||
|
|
||
| :::note | ||
| Você precisa recuperar suas credenciais da sua **Conta Videoteca**. Você pode obter seu token em `https://<SEU-USUÁRIO>.videotecaead.com.br/Apidoc` substituindo `<SEU-USUÁRIO>` pelo seu `nome de usuário`. | ||
| ::: | ||
|
|
||
| 3. Clique no botão **Deploy** para iniciar o processo de implantação. | ||
|
|
||
| Durante a implantação, você poderá acompanhar o processo através de uma janela que mostra os logs. Quando estiver completo, a página mostra informações sobre a aplicação e algumas opções para continuar sua jornada. | ||
|
|
||
| :::note | ||
| O link para a edge application permite que você a veja no navegador. No entanto, leva um certo tempo para propagar e configurar a aplicação nas edge locations da Azion. Pode ser necessário esperar alguns minutos para que a URL seja ativada e para que a página da aplicação seja efetivamente exibida no navegador. | ||
| ::: | ||
|
|
||
| --- | ||
|
|
||
| ## Gerencie o template | ||
|
|
||
| Considerando que essa configuração inicial pode não ser ótima para sua edge application específica, todas as configurações podem ser personalizadas a qualquer momento que você precise, usando a plataforma da Azion. | ||
|
|
||
| Para gerenciar e editar as configurações da sua aplicação edge, siga esses passos: | ||
|
|
||
| 1. [Acesse o Azion Console](https://console.azion.com). | ||
| 2. No canto superior esquerdo, selecione **Products Menu**, o ícone de três linhas horizontais, > **Edge Application**. | ||
| - Você será redirecionado para a página **Edge Application**. Ela lista todas as edge application que você criou. | ||
| 3. Encontre a edge application relacionada ao seu template e selecione-a. | ||
| - A lista está organizada alfabeticamente. Você também pode usar a **barra de busca** localizada no canto superior esquerdo da lista; atualmente, ela filtra apenas pelo campo **Application Name**. | ||
|
|
||
| Depois de selecionar a aplicação edge que você trabalhará, você será direcionado para uma página contendo todas as configurações que você pode configurar. | ||
|
|
||
| :::tip | ||
| Leia a documentação sobre [gerenciamento de edge application](/pt-br/documentacao/produtos/build/edge-application/primeiros-passos/) para mais detalhes. | ||
| ::: | ||
|
|
||
| ### Adicione um domínio personalizado | ||
|
|
||
| A edge application criada durante a implantação tem um domínio Azion atribuído para torná-la acessível através do navegador. O domínio tem o seguinte formato: `xxxxxxxxxx.map.azionedge.net/`. No entanto, você pode adicionar um domínio personalizado para que os usuários acessem sua edge application através dele. | ||
|
|
||
| import LinkButton from 'azion-webkit/linkbutton'; | ||
|
|
||
| <LinkButton link="/pt-br/documentacao/produtos/guias/configurar-dominio/" label="ir para o guia de configuração de domínio" severity="secondary" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters