Deploy the Halo open source site builder

Updated at:

Halo is an open source site builder with a rich library of themes and plugins. You can use the Halo application image to quickly deploy the Halo site builder.

Note

For more information about Halo, see the official Halo website.

Procedure

Step 1: Deploy Halo

Important

If you have already purchased a Simple Application Server instance, you can deploy Halo by resetting the server. When you reset the server, select the Halo image from the application images. Resetting the server clears all data on the system disk. Back up your data as needed. For more information, see Reset a simple application server.

  1. Go to the Servers page in the Simple Application Server console.

  2. In the middle of the page, click Create Server.

  3. On the Simple Application Server page, follow the prompts to configure the resources. The following table describes the configuration items.

    Note

    The available images and plans may vary based on the region and instance type. The options on the purchase page in the console take precedence.

    Configuration Item

    Example

    Description

    Region

    Singapore

    Select a region close to your target users to reduce network latency. You cannot change the region after the instance is created.

    Important

    Instances in regions outside the Chinese mainland, such as China (Hong Kong) and Singapore, use international bandwidth, which may cause high latency from within the Chinese mainland. Select the region closest to your target users. Regions and network connectivity.

    Servers

    • Instance family: General-purpose

    • Plan: CNY 56/month

    • Select an instance family: Options include general-purpose, Multi-IP, International, and Large-capacity. Instance families.

    • Select a plan: Click image to view more plans. Each plan bundles vCPUs, memory, a system disk, and a data transfer plan. Instance specifications.

      Important

      To create a Windows instance, select a plan that provides a system disk larger than 40 GiB.

    Image

    • Application Images: Halo

    • Tag: Halo 2.20.14

    On the Application Images tab, click Expand Other Images, and select Halo.

    Purchase Settings

    • Quantity: 1

    • Duration: 1 Month

    • Quantity: the number of instances to purchase. Default: 1.

    • Duration: the subscription duration. Default: 1 month.

      Important

      Instances hosting web services in the Chinese mainland require an ICP filing with a subscription duration of 3 months or longer (including renewals). Domain name filing.

      • Monthly subscription: 1 month, 3 months, or 6 months.

      • Yearly subscription: 1 year, 2 years, or 3 years.

      Enable Auto-renewal is enabled by default to prevent disruptions from expired subscriptions. Auto-renewal.

      • For monthly subscriptions, the renewal period is one month.

      • For yearly subscriptions, the renewal period is one year.

  4. After you complete the configuration, click Buy Now and follow the on-screen instructions to complete the payment.

    When the server status changes from Pending to Running, the Halo server is created.

Step 2: Log on to the Halo admin console

  1. Obtain the Halo logon information.

    1. On the Servers page, click the ID of the target server to go to the Server Overview page.

    2. Click the Application Details tab to obtain the Halo home page URL and admin logon URL.

      Note

      On the Application Details tab, you can view the steps for using Halo and the installation paths of pre-installed applications.

      • Halo site home page URL: http://118.178.XX.XX.

      • Halo admin logon URL: http://118.178.XX.XX/console.

  2. Log on to the Halo admin console.

    1. In a browser, enter the Halo admin console URL: http://118.178.XX.XX/console.

    2. (Conditional) Initialize the system.

      When you log on to the Halo site for the first time, the System Initialization page appears. Configure parameters such as Site Title, Username, Email, and Password as prompted, and then click Initialize.

    3. On the Halo logon page, enter your username and password, and then click Log On.

    4. After you log on, the Halo admin console appears. You can install themes and plugins and customize configurations as needed. For more information, see the official Halo documentation.

      The Dashboard page displays site statistics cards (number of posts, users, comments, and page views) and quick-access entries (Profile, View Site, Create Post, Create Page, Upload Attachment, Theme Management, Plugin Management, Create User, and Refresh Search Engine). From the left-side navigation pane, you can access management modules such as Posts, Pages, Themes, Plugins, and Settings.

Step 3: Access the Halo home page

In a browser, enter the Halo home page URL http://118.178.XX.XX to access the Halo home page.

The page displays the Halo blog home page, including the site name and two default sample posts, which indicates that Halo has been deployed successfully.

FAQ

How do I upgrade Halo?

  1. Check for new Halo versions.

    1. Log on to the Halo admin console. In the dialog box that appears in the upper-right corner of the dashboard, click View Details.

      When a new version of Halo is available, a notification is pushed to the Halo admin console. In this example, the new version is 2.21.5.
    2. On the Update Log page, check the latest Docker image version for Halo deployment.

      In the Available Docker Images area, you can obtain the image address, such as registry.fit2cloud.com/halo/halo-pro:{version} or halohub/halo-pro:{version}.

  2. In the Halo admin console, back up your data.

    Download the backup data to your computer. This lets you promptly recover the data if the upgrade fails.
  3. Upgrade Halo.

    1. Remotely connect to the server where Halo is deployed.

    2. Run the following command to modify the Halo image version in the configuration file:

      sudo vi /opt/halo/docker-compose.yml

      Press the i key to enter edit mode. In this example, change the Halo image version from 2.20 to 2.21.5.

      services:
        halo:
          image: registry.fit2cloud.com/halo/halo-pro:2.20
          restart: always
          depends_on:
            halodb:
              condition: service_healthy
          networks:
            halo_network:
          volumes:
            - ./halo2:/root/.halo2
          ports:
            - "127.0.0.1:8090:8090"
          healthcheck:
            test: ["CMD", "curl", "-f", "http://localhost:8090/actuator/health/readiness"]
            interval: 30s
            timeout: 5s
            retries: 5
            start_period: 30s
          environment:
            # JVM options. The default is -Xmx256m -Xms256m. You can adjust the value as needed. Leave it empty to add no JVM options.
            - JVM_OPTS=-Xmx512m -Xms512m
          command:
            - --spring.r2dbc.url=r2dbc:pool:postgresql://halodb/halo

      Press the Esc key, enter :wq, and then press the Enter key to save the file and exit.

    3. Run the following commands to run the container:

      cd /opt/halo
      sudo docker compose up -d
  4. Verify the result.

    In the Halo admin console, click Overview. The version is updated.

    The Environment Information section displays the version as 2.21.5.

References

  • You can use a domain name to access your Halo site for improved security and convenience. For more information, see Register and parse a domain name.

  • If you have attached a domain name to the server, you can configure HTTPS encrypted access for the domain name. This lets you switch the data transmission protocol from HTTP to HTTPS at a low cost. This change enables identity verification and encrypted data transmission for your site, which prevents data tampering and information leaks during transmission. For more information, see Deploy an SSL certificate.

  • You can also use WordPress to build an open source site. WordPress provides common application templates for building websites. This helps you quickly build sites that meet your business needs, such as corporate websites, news sites, blogs, forums, and e-commerce platforms. For more information, see Use a WordPress application image to quickly build a website.