【halo】博客系统从部署到访问

部署

本文采用 docker-compose的方式进行部署,可以有效避免一些莫名其妙的问题

halo 支持多种数据库方式进行部署,这里采用的是PSQL方式进行部署,其他数据库部署方式可以参考文档

docker-compose.yaml

  • halo
    • ports: 端口映射。修改第一个端口值为期望访问的端口
    • image: 镜像名。每次更新版本可以通过修改该参数的值执行重新构建即可无痕升级
    • command
      • spring.r2dbc.password: 数据库密码。需要与下面的halodb中的数据库密码保持一致
      • halo.external-url: 外部访问地址。根据实际域名填写,也可以填写127.0.0.1地址
  • halodb
    • environment
      • POSTGRES_PASSWORD: 数据库密码。可以修改为自定义密码。
version: "3"

services:
  halo:
    image: halohub/halo:2.10.0
    container_name: halo
    restart: on-failure:3
    depends_on:
      halodb:
        condition: service_healthy
    networks:
      halo_network:
    volumes:
      - ./:/root/.halo2
    ports:
      - "8090:8090"
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:8090/actuator/health/readiness"]
      interval: 30s
      timeout: 5s
      retries: 5
      start_period: 30s          
    command:
      - --spring.r2dbc.url=r2dbc:pool:postgresql://halodb/halo
      - --spring.r2dbc.username=halo
      # PostgreSQL 的密码,请保证与下方 POSTGRES_PASSWORD 的变量值一致。
      - --spring.r2dbc.password=password
      - --spring.sql.init.platform=postgresql
      # 外部访问地址,请根据实际需要修改
      - --halo.external-url=https://blog.cnkj.site
      # 初始化的超级管理员用户名
      - --halo.security.initializer.superadminusername=admin
      # 初始化的超级管理员密码
      - --halo.security.initializer.superadminpassword=P@88w0rd
      # 启用缓存
      - --halo.cache.page.disabled=false
  halodb:
    image: postgres:latest
    container_name: halodb
    restart: on-failure:3
    networks:
      halo_network:
    volumes:
      - ./db:/var/lib/postgresql/data
    ports:
      - "15432:5432"
    healthcheck:
      test: [ "CMD", "pg_isready" ]
      interval: 10s
      timeout: 5s
      retries: 5
    environment:
      - POSTGRES_PASSWORD=password
      - POSTGRES_USER=halo
      - POSTGRES_DB=halo
      - PGUSER=halo

networks:
  halo_network:
    external: false

部署完成后就可以通过 http://127.0.0.1:8090 进行站点访问了

外部访问

这里主要讲解如果通过域名进行公网访问站点

首先你需要一个自己的域名

其次需要打电话给宽带运营商申请动态IP(专线固定IP不用申请)

解析动态IP到域名上

这里采用python脚本方式解析动态IP到域名上,以便于后续其他各个服务可以使用该域名作为基础域名跳转,而不需要每次都修改相关IP地址

详细部署流程可参考自动获取动态IPV4并解析到阿里云域名

  1. SSH登录服务器后台或相关可执行计划任务的服务
  2. 添加脚本到服务器上并设置周期执行时间
  3. 修改脚本中__execute方法块中域名相关变量

参考脚本内容

#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
    @Time    : 2023/08/23
    @Author  : LXW
    @Site    : 
    @File    : ipv4.py
    @Software: PyCharm
    @Description:
        - 版本
        -- python==3.8
        -- alibabacloud_alidns20150109==3.0.7
        -- aliyun-python-sdk-domain==3.14.9
        - 依赖安装
        -- pip3 install alibabacloud_alidns20150109==3.0.7
        -- pip3 install aliyun-python-sdk-domain==3.14.9
"""

import json

import requests
from alibabacloud_alidns20150109 import models as alidns_20150109_models
from alibabacloud_alidns20150109.client import Client as Alidns20150109Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient


class RemoteIp:
    def __init__(self, url, username, passwd):
        self.url = url
        self.username = username
        self.passwd = passwd

    def __get_token(self):
        _url = self.url + "/emby/Users/authenticatebyname?X-Emby-Client=Emby%20Web&X-Emby-Device-Name=Chrome%20macOS&X-Emby-Device-Id=fa6b7733-23fc-4cb7-bae3-d7f0536b485e&X-Emby-Client-Version=4.7.13.0&X-Emby-Language=zh-cn"
        content = requests.post(_url, False, {"Username": self.username, "Pw": self.passwd}).text
        return json.loads(content)["AccessToken"]

    def get_remote_addr(self):
        token = self.__get_token()
        full_url = self.url + "/emby/System/Info?X-Emby-Token=" + token
        content = requests.get(full_url, False).text
        addr = list(json.loads(content)["RemoteAddresses"])
        remote_add = str(addr[0]).split(":")[1].replace("/", "")
        return remote_add

def request_params(request, value):
    request.value = value

class AliyunOperation:
    def __init__(self, access_key_id, access_secret):
        """
        初始化
        :param access_key_id: 阿里云AccessKey的ID
        :param access_secret: 阿里云AccessKey的密码
        """
        config = open_api_models.Config(
            # 必填,您的 AccessKey ID,
            access_key_id=access_key_id,
            # 必填,您的 AccessKey Secret,
            access_key_secret=access_secret
        )
        # Endpoint 请参考 https://api.aliyun.com/product/Alidns
        config.endpoint = f'alidns.cn-hangzhou.aliyuncs.com'
        self.client = Alidns20150109Client(config)

    def describe_subdomain_records(self, subdomain, domain_name):
        """
        子域名解析记录查询 https://api.aliyun.com/api/Alidns/2015-01-09/DescribeSubDomainRecords
        这个函数会返回一大堆东西,但是目前我们需要使用的就两个,一个是解析记录的数量,一个就是RecordId,RecordId修改域名解析时需要用到
        :param domain_name:
        :param subdomain:
        :return:
        """
        describe_sub_domain_records_request = alidns_20150109_models.DescribeSubDomainRecordsRequest(
            sub_domain=subdomain,
            domain_name=domain_name
        )
        runtime = util_models.RuntimeOptions()
        try:
            response = self.client.describe_sub_domain_records_with_options(describe_sub_domain_records_request,
                                                                            runtime)
            if 200 == response.status_code:
                return response.body
        except Exception as error:
            # 如有需要,请打印 error
            UtilClient.assert_as_string(error.message)

    def add_record(self, domain_name, rr, domain_type, value):
        """
        新增域名解析记录 https://api.aliyun.com/api/Alidns/2015-01-09/AddDomainRecord
        如果域名解析记录不存在时,就需要新增域名解析记录,新增域名解析记录比较简单,直接填写参数即可
        :param domain_name: 域名名称 baidu.com
        :param rr: 主机记录。如果要解析@.exmaple.com,主机记录要填写”@”,而不是空。
        :param domain_type: 解析记录类型。https://help.aliyun.com/document_detail/29805.html?spm=api-workbench.api_explorer.0.0.6b1a134bcODqcI
        :param value: 记录值。String
        :return:
        """
        add_domain_record_request = alidns_20150109_models.AddDomainRecordRequest(
            domain_name=domain_name,
            rr=rr,
            type=domain_type,
            value=value
        )
        runtime = util_models.RuntimeOptions()
        try:
            response = self.client.add_domain_record_with_options(add_domain_record_request, runtime)
            if 200 == response.status_code:
                return response.body
        except Exception as error:
            # 如有需要,请打印 error
            UtilClient.assert_as_string(error.message)

    def update_record(self, domain_type, value, rr, record_id):
        """
        更新域名解析记录
        如果域名解析记录已存在,则不能使用新增,而是更新域名解析记录。更新的时候需要用到RecordId,这个一般查询的时候就会有返回,直接使用即可
        :param domain_type: 解析记录类型。https://help.aliyun.com/document_detail/29805.html?spm=api-workbench.api_explorer.0.0.6b1a134bcODqcI
        :param value: 记录值。String
        :param rr: 主机记录。如果要解析@.exmaple.com,主机记录要填写”@”,而不是空。
        :param record_id: 解析记录的ID
        :return:
        """
        update_domain_record_request = alidns_20150109_models.UpdateDomainRecordRequest(
            record_id=record_id,
            rr=rr,
            type=domain_type,
            value=value
        )
        runtime = util_models.RuntimeOptions()
        try:
            # 复制代码运行请自行打印 API 的返回值
            self.client.update_domain_record_with_options(update_domain_record_request, runtime)
        except Exception as error:
            # 如有需要,请打印 error
            UtilClient.assert_as_string(error.message)

def __execute():
    # 获取动态 IPV4 地址(如果是IPV6也可以用相同方式获取)
    __remote_addr = __get_from_urls()
    if "None" == __remote_addr:
        __remote_addr = RemoteIp(url=__url, username=__username, passwd=__passwd).get_remote_addr()
    print("current ipv4: " + __remote_addr)
    __aliyun_client = AliyunOperation(access_key_id=__accessKeyId, access_secret=__accessSecret)
    # 查询 example.com 主机下 test.example.com 域名的解析列表
    content = __aliyun_client.describe_subdomain_records("redirect.your.domain", "your.domain")
    print("current desc domain content: " + str(content))
    if 0 == content.total_count:
        # 新增一条 test.example.com 的IPV4域名解析记录(如果是IPV6地址,修改参数 domain_type 为 AAAA)
        __aliyun_client.add_record("your.domain", "redirect", "A", __remote_addr)
    elif 1 == content.total_count:
        # 如果 test.example.com 域名解析已经存在,则进行更新操作
        source = content.domain_records.record[0]
        record_id = source.record_id
        if __remote_addr != source.value:
            __aliyun_client.update_record("A", __remote_addr, "redirect", record_id)
    # else:
    #     # 不推荐使用该方式进行域名解析更新,容易错误更新
    #     sources = content.domain_records.record
    #     for source in sources:
    #         # 因为是更新IP,所以只考虑 A 或者 AAAA
    #         domain_type = source.type
    #         if "A" == domain_type or "AAAA" == domain_type:
    #             record_id = source.record_id
    #             rr = source.rr
    #             __aliyun_client.update_record(domain_type, __remote_addr, rr, record_id)

def __get_from_urls():
    """
    通过url获取本地IP地址
        "https://myip4.ipip.net",
        "https://ddns.oray.com/checkip",
        "https://ip.3322.net",
        "https://4.ipw.cn"
    :return: ip
    """
    ipw = "https://4.ipw.cn"
    response = requests.get(ipw)
    if 200 == response.status_code:
        content = response.text
        return content.strip()
    ip = "https://ip.3322.net"
    response = requests.get(ip)
    if 200 == response.status_code:
        content = response.text
        return content.strip()
    myip4 = "https://myip4.ipip.net"
    response = requests.get(myip4)
    if 200 == response.status_code:
        content = response.text.split(":")[1]
        content = content.replace("来自于", "")
        return content.strip()
    ddns = "https://ddns.oray.com/checkip"
    response = requests.get(ddns)
    if 200 == response.status_code:
        content = response.text.split(":")[1]
        return content.strip()
    return "None"

if __name__ == '__main__':
    # emby相关参数,可以不填
    __url = "http://127.0.0.1:8096"
    __username = "emby_user"
    __passwd = "emby_passwd"
    # 域名解析权限,必填
    __accessKeyId = "__accessKeyId"
    __accessSecret = "__accessSecret"
    __execute()

设置公网访问

这里以阿里云CDN方式进行公网访问举例,利用了CDN的缓存、去除端口访问的限制、https证书访问配置等优点

假设在上文中解析的动态IP地址到的域名为 redirect.your.domain,那么站点的访问地址应该为 http://redirect.your.domain:8090

  1. 登录并通过官网购买CDN流量包
  2. 进入CDN控制台
  3. 在下面的域名管理添加域名
  4. 填写你要访问的域名,例如访问 http://blog.your.domain ,并根据出现的验证提示选择其中方式进行验证
    添加域名1
  5. 在下面的源站信息中点击新增源站信息
  6. 新增源站信息页面选择源站信息方式为源站域名
  7. 填写相关源站信息,其中域名为上文中我们通过动态IP解析到的域名(redirect.your.domain),端口为我们的站点HTTP访问端口(8090)
    yuanzhanxinxi
  8. 确认完成后等待完成验证。在左侧域名管理中就可以看到新增的域名已经完成状态了
    yumingguanli
  9. 点击域名右侧操作中的管理对域名进行配置,大部分配置使用默认参数即可,以下仅说明几个重要配置

CDN配置管理

  • IPv6开关: 控制客户端是IPV6地址可以正常访问站点
    ipv6

  • 回源配置: 控制站点实际回源信息。因为我们采用的域名回源,所以需要设置最下方的301/302限制,否则实际站点返回可能出现端口
    huiyuan

  • 缓存配置: 用于配置各个节点的缓存和有效期,通过该配置可以有效提高高频访问数据的访问效率
    huancunpeizhi

  • HTTPS配置: 该配置可以使我们的站点访问始终请求https证书地址
    https
    https2
    https3

  • 性能优化: 性能优化设置
    xinnengyouhua

  • 流量限制: 限制峰值流量大小,非常重要。合理的设置可以有效避免你的CDN流量被恶意消耗导致产生高额费用
    liuliang