Docker: 在 docker-compose.yml 使用環境變數

此文件屬於使用 GitHub Actions 部署指南的一部分。請在此處查看完整指南:學習如何利用 GitHub Actions 部署您的 Docker 容器

歡迎瀏覽 Stackhero 文件

Stackhero 提供即用型 Docker cloud CaaS (Containers as a Service) 平台,專為快速及可靠的 container 部署而設:

  • 只需一條 docker-compose up 指令即可部署到生產環境。無需額外設定:直接啟動您的 containers。
  • 可自訂您的網域名稱,並自動以 HTTPS 保護(例如:https://api.your-company.comhttps://www.your-company.comhttps://backoffice.your-company.com)。
  • 享有高效能及強大安全性的專屬私有基礎設施。
  • 一鍵套用更新,簡化維護工作,減少管理負擔。

您的 containers 約五分鐘內即可投入生產運作。Stackhero 會為您管理基礎設施、更新及安全,讓您專注於應用程式開發。了解更多 Docker CaaS cloud hosting 的詳情。

您可以在 GitHub 專案中定義環境變數,這些變數會在 docker-compose.yml 內部可用。這對於需要部署到不同網域(例如 staging.my-company.com 用於 staging,my-company.com 用於 production)特別有用。

  1. 在 GitHub,前往 Settings > Environments,建立名為 WEBSITE_DOMAIN 的環境變數。
  2. 對於 staging 環境,將 WEBSITE_DOMAIN 設為「staging.my-company.com」。
  3. 對於 production 環境,將 WEBSITE_DOMAIN 設為「my-company.com」。

接著,更新 .github/workflows/deploy-to-stackhero.yml,將 WEBSITE_DOMAIN 變數傳遞給 Stackhero GitHub Action:

name: Deploy to Stackhero
description: Deploy branch "${{ github.ref_name }}" to Stackhero

on:
  push:
    branches: [ "production", "staging" ]

jobs:
  Deploy:
    environment: ${{ github.ref_name }}
    runs-on: ubuntu-latest
    steps:
    - uses: stackhero-io/github-actions-deploy-docker-containers-to-stackhero@v1
      with:
        certificates_password: ${{ secrets.STACKHERO_CERTIFICATES_PASSWORD }}
        endpoint: ${{ vars.STACKHERO_ENDPOINT }}
        deployment_command: ${{ vars.STACKHERO_DEPLOY_COMMAND }}
      env:
        WEBSITE_DOMAIN: ${{ vars.WEBSITE_DOMAIN }}

然後,更新您的 docker-compose.yml,將硬編碼的網域名稱改為使用 WEBSITE_DOMAIN 變數:

services:
  test:
    image: nginx
    labels:
      - "traefik.enable=true"
      - "traefik.http.routers.test.rule=Host(`${WEBSITE_DOMAIN}`)" # 使用 WEBSITE_DOMAIN 環境變數作為網域名稱。
      - "traefik.http.routers.test.tls.certresolver=letsencrypt"