Back to Hugo

os.Getenv

docs/content/en/functions/os/Getenv.md

0.161.1887 B
Original Source

Security

By default, when using the os.Getenv function Hugo allows access to:

  • The CI environment variable
  • Any environment variable beginning with HUGO_

To access other environment variables, adjust your project configuration. For example, to allow access to the HOME and USER environment variables:

{{< code-toggle file=hugo >}} [security.funcs] getenv = ['^HUGO_', '^CI$', '^USER$', '^HOME$'] {{< /code-toggle >}}

For more information see configure security.

Examples

go-html-template
{{ getenv "HOME" }} → /home/victor
{{ getenv "USER" }} → victor

You can pass values when building your project:

sh
MY_VAR1=foo MY_VAR2=bar hugo

OR

export MY_VAR1=foo
export MY_VAR2=bar
hugo

And then retrieve the values within a template:

go-html-template
{{ getenv "MY_VAR1" }} → foo
{{ getenv "MY_VAR2" }} → bar