hugo/content/en/hosting-and-deployment/hosting-on-firebase.md
Bjørn Erik Pedersen 41bc6f702a Squashed 'docs/' changes from 2201ac0e5..2c0125b52
2c0125b52 Remove .Site.Author
2cf8841b3 Update partialCached.md (#1924)
385487191 Update data-templates.md (#1926)
ce207e141 Remove redundant markdown and fix a few typos (#1936)
3687c2953 Make heading id linkable, take 2
45c79bea7 Make heading id linkable
b22079344 Delete duplicates the lines 557-569 and 570-582. (#1934)
0a90dc122 Rework the taxonomy variables page (#1935)
7f8979c50 Update theme
26e682a3a Update multilingual.md
d40e7693f Update postcss.md
375d75c01 Update postcss npm instructions (#1931)
63020094a Emphasize Window shell selection (#1930)
56824be2c Update configuration.md
b7b8f16b3 Docu 'Theme components': minor fix (#1929)
09dc81a05 Remove Docker from BSD page (#1927)
205fea204 netlify: Hugo 0.108.0
6abe49c28 Merge commit 'da670c38ee63a7fef25e2b9f42519232055b60dc'
12b59a4c5 docs: Add basic doc for wrapStandAloneImageWithinParagraph etc.
ba07bd970 dartsass: Add sourceMapIncludeSources option

git-subtree-dir: docs
git-subtree-split: 2c0125b5290494d49334606c451446ebd9df3c21
2022-12-20 11:04:41 +01:00

3.5 KiB

title linktitle description date publishdate categories keywords authors menu weight sections_weight toc aliases
Host on Firebase Host on Firebase You can use Firebase's free tier to host your static website; this also gives you access to Firebase's NOSQL API. 2017-03-12 2017-03-12
hosting and deployment
hosting
firebase
Michel Racic
docs
parent weight
hosting-and-deployment 20
20 20 true

Assumptions

  1. You have an account with Firebase. (If you don't, you can sign up for free using your Google account.)
  2. You have completed the Quick Start or have a completed Hugo website ready for deployment.

Initial setup

Go to the Firebase console and create a new project (unless you already have a project). You will need to globally install firebase-tools (node.js):

npm install -g firebase-tools

Log in to Firebase (setup on your local machine) using firebase login, which opens a browser where you can select your account. Use firebase logout in case you are already logged in but to the wrong account.

firebase login

In the root of your Hugo project, initialize the Firebase project with the firebase init command:

firebase init

From here:

  1. Choose Hosting in the feature question
  2. Choose the project you just set up
  3. Accept the default for your database rules file
  4. Accept the default for the publish directory, which is public
  5. Choose "No" in the question if you are deploying a single-page app

Using Firebase & Github CI/CD

In new versions of Firebase, some other questions apply:

  1. Set up automatic builds and deploys with GitHub?

Here you will be redirected to login in your GitHub account to get permissions. Confirm.

  1. For which GitHub repository would you like to set up a GitHub workflow? (format: user/repository)

Include the repository you will use in the format above (Account/Repo) Firebase script with retrive credentials, create a service account you can later manage in your github settings.

  1. Set up the workflow to run a build script before every deploy?

Here is your opportunity to include some commands before you run the deploy.

  1. Set up automatic deployment to your site's live channel when a PR is merged?

You can let in the default option (main)

After that Firebase has been set in your project with CI/CD. After that run:

hugo && firebase deploy

With this you will have the app initialized manually. After that you can manage and fix your github workflow from: https://github.com/your-account/yout-repo/actions

Don't forget to update your static pages before push!

Manual Deploy

To deploy your Hugo site, execute the firebase deploy command, and your site will be up in no time:

hugo && firebase deploy

CI Setup (Other tools)

You can generate a deploy token using

firebase login:ci

You can also set up your CI and add the token to a private variable like $FIREBASE_DEPLOY_TOKEN.

{{% note %}} This is a private secret and it should not appear in a public repository. Make sure you understand your chosen CI and that it's not visible to others. {{% /note %}}

You can then add a step in your build to do the deployment using the token:

firebase deploy --token $FIREBASE_DEPLOY_TOKEN