umami icon indicating copy to clipboard operation
umami copied to clipboard

Docs: HASH_SALT in fly.io example is not documented in list of environment variables

Open gridsystem opened this issue 2 years ago • 7 comments

Describe the Bug

The fly.io example in the documentation instructs the user to set an environment variable, HASH_SALT.

fly secrets set HASH_SALT="", using whatever string you want to salt the hash.

This environment variable isn't in the documentation's list of environment variables. There is a similar variable in that list, APP_SECRET.

APP_SECRET = A random string used to generate unique values.

Is the fly.io example using a deprecated variable which needs changing to APP_SECRET? Does HASH_SALT need to be added to the list of environment variables?

Database

PostgreSQL

Relevant log output

No response

Which browser are you using? (if relevant)

No response

How are you deploying your application? (if relevant)

No response

gridsystem avatar Nov 29 '23 10:11 gridsystem

+1

SmartPhoneLover avatar Dec 05 '23 18:12 SmartPhoneLover

HASH_SALT was used in v1. You should be using APP_SECRET now.

mikecao avatar Dec 06 '23 19:12 mikecao

Thanks for the info mikecao. So, I would suggest to include the old variable in the documentation page, but telling the used that it's now deprecated for v2.

SmartPhoneLover avatar Dec 06 '23 19:12 SmartPhoneLover

HASH_SALT was used in v1. You should be using APP_SECRET now.

Is anything else in the fly.io guide outdated?

gridsystem avatar Dec 07 '23 14:12 gridsystem

@mikecao I created the documentation page for running on fly. I wasn't aware that with v2, we should be using APP_SECRET. For already running instances of Umami v2, can APP_SECRET be safely added and HASH_SALT removed, without disrupting anything?

paulrudy avatar Jan 31 '24 01:01 paulrudy

@paulrudy Yes

mikecao avatar Jan 31 '24 02:01 mikecao

Ok, I created a PR to reflect the change, along with a couple of other PRs for that doc—a typo, and removing HOSTNAME env variable as it's no longer needed since Umami version 2.7.0.

paulrudy avatar Jan 31 '24 03:01 paulrudy

PR merged.

mikecao avatar Feb 28 '24 05:02 mikecao