Deployment guide · Guide

Put your contest entry online

Web entries for contests, game jams and hackathons are easy to forget once judging ends. Put yours on a HRUM hosting free plan and anyone can open it at appname.ridm.ai, without buying a domain. These are the steps we followed for Jodalwang, a web game entered in a Public Procurement Service contest in Korea.

Who this is for

Who
Anyone who entered a web project made with HTML and JavaScript in a contest, game jam or hackathon. If a build gives you an index.html, it works.
Why
Keep an entry you are proud of open at your own address. Share it in a portfolio or application with a single link, and let people play it after judging ends.
What you need
Your project folder (the build output), a Google account and a terminal. No GitHub account needed.

A real entry: Jodalwang

Title screen of the web game Jodalwang: an island map with a factory, a warehouse and a port, and a start button in the middle
Jodalwang title screen

A web game entered in a Public Procurement Service contest in Korea. We put it on a HRUM hosting free plan and opened it on a free subdomain, without buying a domain.

jodalwang.ridm.ai

The steps below are the order we used for this game. It first served static files with a small web server, then moved to a small Node server to send its live visitor count to Metamoa.

Open Jodalwang

Step by step

Replace appname with the address name you chose when you applied.

  1. Apply for hosting (free plan)

    In My apps in the HRUM console, apply for hosting and pick the free plan. The address you choose becomes appname.ridm.ai and cannot be changed later, so use your project name.

  2. Start gitHrum on the app page

    On the app page, choose 「Start without GitHub」. HRUM gives each app its own code store (a git repository).

  3. Install the program and sign in this device

    Install the gitHrum program (the hrum command) and sign in from the folder you will publish.

    Paste into a terminal
    # Install the gitHrum program (macOS, Linux)
    curl -fsSL https://console.hrum.ai/git/install.sh | sh
    # Windows PowerShell: irm https://console.hrum.ai/git/install.ps1 | iex
    
    # Open a new terminal and sign in from the folder you will publish
    hrum login <appname>

    When the console approval page opens in your browser, type the code shown in the terminal yourself, and choose 「Allow」 if it is the command you just ran. A token for that app is stored on this computer and never shown on screen or in logs.

  4. Add a Dockerfile to the project folder

    Put your built web files (the contents of the folder with index.html) in public/ in this folder. For static files a small web server is all you need. Put the Dockerfile below at the top of the folder, or let hrum init in the next step add the same file if there is none.

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

    Port and run-as user requirements are in Dockerfile requirements. If your entry needs a server, write the Dockerfile to match them.

  5. Publish with git push

    hrum init connects this folder to the repository git.hrum.ai/appname.git. Push to main and the deploy starts.

    In the same folder
    # Connect this folder to the app repository
    hrum init <appname>
    
    # Save and push to main
    git add .
    git commit -m "Web release"
    git push origin main

    Jodalwang was published with git push. hrum save "note" and hrum push do the same; they refuse to save anything that looks like a secret and show deploy progress.

  6. Open it at your address

    After a push HRUM builds the app, runs a start check and applies it automatically. Then it opens at https://appname.ridm.ai. If it fails, read the build history and logs on the app page, fix it and push again. Every later push goes live the same way.

Keep the submitted copy and the public copy apart

Leave the copy you submitted exactly as the rules required. For Jodalwang the submitted ZIP, which makes no outside requests, stayed untouched; a separate branch for the web release took every change.

In your original project repository
# Keep the submitted copy (main) as it is and make a branch for the web release
git switch -c web-public

# Make public-only changes here and save
git commit -am "Polish the web release"

# Copy only the build output into public/ of the folder you publish

The folder you publish only needs the build output. You do not have to upload the whole original repository, and the submitted copy stays untouched.

Good to know

Free plan apps rest and wake up. After a while with no visits the app rests, and the next visit starts it again, so the first visit after a rest can open a little slower.

List it as a space on Metamoa. To show your entry to more people, register it as a space on Metamoa (metamoa.com). Jodalwang is listed as a space and sends its live visitor count to Metamoa.

Next

Ready to open your finished entry again at your own address?

Sign up with Google