How to deploy the Jekyll Boilerplate

This template deploys a repository with a project based on Jekyll, a framework written in Ruby, that enables you to create static sites using Markdown and HTML files.

View as Markdown

Preview

The Jekyll Boilerplate accelerates the deployment of a basic Jekyll project, directly on the edge of the network.

This template deploys a repository with a project based on Jekyll, a framework written in Ruby, that enables you to create static sites using Markdown and HTML files. The repository also includes a GitHub Action to ensure a continuous deployment workflow, keeping your project up to date.

Additionally, the template deploys an application and a domain to facilitate your access and management through Azion Web Platform.

This template uses Jekyll version 4.3.3.

Requirements

  • A GitHub account to connect with Azion and create your new repository.
    • Every push will be deployed automatically to the main branch in this repository to keep your project updated.
  • Install Ruby version 2.5.0 or higher.
    • Without a Ruby runtime environment, you won’t be able to install the Jekyll gem or execute the Ruby code that powers Jekyll.

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.

Deploy

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. Connect Azion with your GitHub account.
  • A pop-up window will open to confirm the installation of the Azion GitHub App, a tool that connects your GitHub account with Azion’s platform.
  • Define your permissions and repository access as desired.
  1. Select the Git Scope to work with.
  2. Define a name for your application.
  • The bucket for storage 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.
  1. Click the Deploy button to start the deployment process.

During the deployment, you’ll be able to follow the process through a window showing the logs. When it’s complete, the page shows information about the application and some options to continue your journey.

The link to the 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 application, all settings can be customized any time you need by using Azion’s platform.

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

  1. Access Azion Console.
  2. On the upper-left corner, select Products menu > Applications.
  • You’ll be redirected to the Applications page. It lists all the applications you’ve created.
  1. Find the 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 application you’ll work on, you’ll be directed to a page containing all the settings you can configure.

Read the documentation about managing applications for more details.

Adding a custom domain

The application created during the deployment has an assigned Azion Workload 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 application through it.

go to configuring a domain guide