hugo/content/en/hosting-and-deployment/hosting-on-firebase.md
Bjørn Erik Pedersen 87de22d746 Squashed 'docs/' changes from 85befbb4d..c43daf45f
c43daf45f Update build-options.md
3ebbfedd4 Build options: Improve readability
5091bf6a0 Improve safeHTMLAttr explanation
b64cbce2e Fix description of collections.Apply
6ea264b9c netlify: Hugo 0.115.4
b42e7c542 Revert "config: Remove disableLiveReload"
35ce2290e Remove excess spaces in configuration docs
2edf761de Update listed titleCaseStyle default value
887f6fb97 config: Remove disableLiveReload
c9f49fb26 Fix typo
37d8569ac Remove tools associated with Atom
871d11b72 Fix URL in postprocess docs
bbb17d29f Update GitLab workflow
bc53ea5ce Use sentence-style capitalization for headings
7ca578786 netlify: Hugo 0.115.3
c5e010bd0 Merge branch 'tempv0.115.3'
c885604bf Remove starter kits page
4c0fe269e Update mention of Netlify CMS to Decap CMS
05067175c Consistently use file name instead of filename
763dd6404 Improve multilingual config example and descriptions
e5aa61ec5 Use lowercase when referring to front matter (#2132)
7ba3d0c72 docs: Refresh docs.json
de8bddedf Update description of timeout configuration value
e1245d9f8 netify: Hugo 0.115.2
153a36bdf Merge branch 'tempv0.115.2'
707cec754 Fix typo in figure example in shortcodes.md
128cbe1e5 Improve taxonomy template examples
4e743ec36 Improve highlight function example
f96fa6805 transpile sass: Fixes typo
e4a8a21f7 Compile Sass to CSS, not SCSS
c1538bd00 docs: Regenerate CLI docs
bd4e33436 Add titleCaseStyle none and firstupper
6ff93d478 Update quick-start.md
5c6653cb1 Update build config examples and explanation
1458d9a43 Remove the `url` parameter
6a1e92044 netlify: Hugo 0.115.1
a9d5d6f2f Merge branch 'tempv0.115.1'
4c4882384 docs: Regen docs helper
d1aa1c1f5 Add link to PowerShell vs Windows PowerShell documentation
6e3b70c21 Fix link to Git installation instructions
4f8a9ca38 Clarify resources.Copy arguments
ee86dd121 Update theme
dc7c305cf Update theme
60c23920b Clarify caching for resources.FromString (#2120)
5bf2fef6d netlify: Hugo 0.115.0
46bde87c5 Merge branch 'tempv0.115.0'
42cc48c16 Specify target path caching for resources.ExecuteAsTemplate (#2027)
a54bf4cd0 Correct the sample code of mermaid (#2119)
8c49b06fc docs: Update permalinks documentation
a4818d99b Page bundles: link to info about single vs. list page templates (#2116)
3fc7744d7 snap: Document removable media access
dbd08f58a Update theme
df5b88633 netlify: Hugo 0.114.1
6b859834a Fix typo
9ec92cf68 Improve Dart Sass example for Netlify
2d294ece9 Add Dart Sass installation and usage documentation
4c6b77d6c Fix placement of curly braces
897812a50 Update template-debugging.md to include a jsonify example
22bca519b Update GitHub Pages hosting instructions (#2109)
a964d93ce Document math functions new in v0.114.0 (#2108)
9f4cb040e netlify: Hugo 0.114.0
55b4d9221 Merge branch 'tempv0.114.0'
93c4dcf93 docs: Regen docshelper
96f03c77f docs: Regen CLI docs
8e22a228a Clarify resource media type variables (#2106)
2652da8d4 Update transform.Unmarshal.md (#2105)
92657177a Update theme
4601c1d65 Update theme
a216f3145 Merge commit '3c1deaf201a35de08d23cc58f8f03682cace3349'
eed8794f5 cache: Set default cache path based on $USER

git-subtree-dir: docs
git-subtree-split: c43daf45fdc36c254f4274a0815ea62d4d8c37e0
2023-07-29 11:15:54 +02:00

3.3 KiB

title description categories keywords menu toc
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.
hosting and deployment
hosting
firebase
docs
parent
hosting-and-deployment
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/your-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