部署指南 · 指南

上線你的比賽作品

參加比賽、Game Jam、黑客松的網頁作品,評審一結束就容易被埋沒。放上 HRUM 主機免費方案,不用買網域,任何人都能用 appname.ridm.ai 打開。這裡照著韓國調達廳比賽作品、網頁遊戲「調達王」上線的順序寫下來。

適合誰

對象
在比賽、Game Jam、黑客松交出 HTML、JavaScript 網頁作品的人。只要建置後會產生 index.html 就可以。
為什麼
讓交件後就結束太可惜的作品,在自己的網址繼續開著。放進作品集或申請資料只要一個連結,評審結束後大家也還能玩。
準備
作品資料夾(建置結果)、Google 帳號、終端機。沒有 GitHub 帳號也可以。

實際上線的作品:調達王

網頁遊戲「調達王」的標題畫面。島嶼地圖上有工廠、倉庫和港口,中間有開始按鈕
調達王標題畫面

這是參加韓國調達廳比賽的網頁遊戲。放上 HRUM 主機免費方案,沒買網域,用免費子網域打開。

jodalwang.ridm.ai

下面的步驟就是這個作品上線的順序。一開始用小型網頁伺服器提供靜態檔案,後來為了把線上人數傳給 Metamoa,改成小型 Node 伺服器。

打開調達王

一步一步來

把 appname 換成申請時決定的網址名稱。

  1. 申請主機(免費方案)

    在 HRUM 主控台的我的應用申請主機,選擇免費方案。這時決定的網址會變成 appname.ridm.ai,之後不能改,請用作品名稱。

  2. 在應用畫面開始 gitHrum

    在應用畫面選「Start without GitHub」。HRUM 會替每個應用準備一個程式碼倉庫(git repository)。

  3. 安裝程式並登入這台裝置

    安裝 gitHrum 程式(指令 hrum),在要上線的資料夾登入。

    貼到終端機
    # 安裝 gitHrum 程式 (macOS、Linux)
    curl -fsSL https://console.hrum.ai/git/install.sh | sh
    # Windows PowerShell:irm https://console.hrum.ai/git/install.ps1 | iex
    
    # 開新的終端機,在要上線的資料夾登入
    hrum login <appname>

    瀏覽器打開主控台核准畫面後,自己輸入終端機上的代碼,確認是你剛剛執行的就按「Allow」。這台電腦會存下這個應用專用的權杖,權杖不會出現在畫面或紀錄裡。

  4. 在作品資料夾放 Dockerfile

    把建置好的網頁檔案(有 index.html 的資料夾內容)放進這個資料夾的 public/。靜態檔案只要一個小型網頁伺服器就夠了。在資料夾最上層放下面的 Dockerfile,或是沒有的話,下一步的 hrum init 會放進同樣的檔案。

    Dockerfile(靜態網站)
    FROM busybox:1.36
    COPY --chown=1000:1000 public /www
    USER 1000:1000
    EXPOSE 3000
    CMD ["httpd", "-f", "-p", "3000", "-h", "/www"]

    連接埠、執行使用者等條件寫在 Dockerfile 要求。需要伺服器的作品請照這些條件自己寫。

  5. 用 git push 上線

    hrum init 會把這個資料夾連到 git.hrum.ai/appname.git 倉庫。接著推到 main 就會開始部署。

    在同一個資料夾
    # 把這個資料夾連到應用倉庫
    hrum init <appname>
    
    # 儲存並推到 main
    git add .
    git commit -m "網頁公開版"
    git push origin main

    調達王是用 git push 上線的。hrum save "備註" 和 hrum push 也做一樣的事;看到像機密值的內容時不會儲存,還會顯示部署進度。

  6. 用自己的網址打開

    推上去後,HRUM 會建置、通過啟動檢查,再自動套用。完成後就能用 https://appname.ridm.ai 打開。失敗的話,看應用畫面的建置紀錄和日誌,修好再推一次。之後每次推送都會自動上線。

分開交件版和公開版

交給比賽的版本,最好照規定做好的樣子保留。調達王也是把沒有外部請求的交件用 ZIP 原封不動,另外開一個網頁公開用分支,只在那裡修改。

在原本的作品倉庫
# 交件版 (main) 保持原樣,開一個公開用分支
git switch -c web-public

# 只放進公開版的東西在這裡修改並儲存
git commit -am "整理網頁公開版"

# 只把建置結果複製到要上線資料夾的 public/

要上線的資料夾只放建置結果就好。不用把整個原始倉庫傳上去,交件版也會原封不動留著。

知道了會更方便

免費方案會休息再醒來。一陣子沒人造訪,應用會休息,下次有人造訪時再啟動。所以休息後的第一次造訪可能會開得慢一點。

在 Metamoa 登錄成空間。想讓更多人看到作品,可以到 Metamoa(metamoa.com)登錄成空間。調達王已登錄成空間,並把目前的線上人數傳給 Metamoa。

接下來

結束的作品,要不要用自己的網址再打開一次?

用 Google 註冊