• Guides
• Hexo Boilerplate

Hexo Boilerplate facilitates you to build and run a Hexo Single-Page Application (SPA) directly on the edge by automating several steps, from repository management to edge deployment.

This template uses Hexo version 6.3.0.

To use this template, you must activate:

You need to activate this module via Azion Console. To do so:

1. Access Console > Account menu
2. Select the Billing & Subscriptions option.
3. Select the Subscriptions tab.
4. Activate the switch for the module.

To use the Hexo Boilerplate, access Azion Console and select the Start with a template option on the homepage.

This will open a new page where you can select the Hexo Boilerplate card.

Once you’re in the template’s page, click the Settings tab to open the configuration form and provide the information to configure your edge application.

Fields identified with an asterisk are mandatory.

• Application Name *: the name of your edge application. It’s used to identify and manage your application within Azion’s platform.
  • Use a unique and easy-to-remember name. If the name has already been used, the platform returns an error message.
• GitHub Personal Token *: your GitHub personal token.

After completing all the information, click the Next button, located in the bottom-right corner. This will start the deployment process.

You’ll be able to follow the deployment process through a window showing off the logs. When it’s complete, the deployment page appears, confirming the edge application has been successfully created.

This page shows you the following sections:

• Access your Edge Application section includes the link to visit and explore your edge application.
• Build Summary contains the application’s name and function.
• The Deployment details tab can be opened to access the logs related to the deployment.
• What do you want to do next? provides recommendations regarding advanced options to enhance your edge application: Customize Domain, Manage Edge Application, View Edge Application Metrics, View Edge Application Logs, and the Back to Home button.

By deploying this template, through automation, the script creates an edge application along with an edge function and a GitHub repository for your project to manage the source code.

Your project carries out multiple configurations, including setting up the edge application and its domain to host your project and an edge function for custom logic.

The script also commits deployment details to the repository to maintain a transparent and trackable deployment history, including information related to the version deployed and the timestamp of the deployment. Besides that, the repository also includes all required dependencies and a GitHub Action that, by being activated, guarantees a continuous deployment workflow.

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 Console.

To manage and edit your edge application’s settings, follow these steps:

1. Access Console.
2. On the upper-left corner, select Products menu > 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 the Hexo Boilerplate 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.

Once the template is deployed, you can also edit and update your args and code, as well as implement a continuous deployment workflow. However, you’ll need first to declare secrets on your project’s GitHub repository to complete the second build with the changes. When the second build is completed, you’ll be able to manage your project with a continuous deployment workflow and edit the args as desired.

To do so, open your new Hexo Boilerplate repository on GitHub. Then, go to Settings > Secrets and variables > Action to add your variables, following these instructions:

1. Add the Azion personal token to the secrets:

• Read how to generate an Azion personal token in the documentation.

    AZION_PERSONAL_TOKEN=<value>

2. Add the environments for use in the action workflow in the main.yml file, included in the .github/workflows folder of your repository:

  - name: edge-...
    id: azion_edge
    ...
    with:
        ....
        azionPersonalToken: ${{ secrets.AZION_PERSONAL_TOKEN }}
        ....

3. Open a pull request to merge the changes to the main branch and start the automatic deployment.

Now your project is ready to work with a continuous deployment workflow, updating instantly any changes in the application or the repository.

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.

Contributors