diff --git a/.env.example b/.env.example index 12546d769..7fbb581d4 100644 --- a/.env.example +++ b/.env.example @@ -1,16 +1,16 @@ # Since .env is gitignored, you can use .env.example to build a new `.env` file when you clone the repo. -# Keep this file up-to-date when you add new variables to \`.env\`. +# Keep this file up-to-date when you add new variables to `.env`. # This file will be committed to version control, so make sure not to have any secrets in it. # If you are cloning this repo, create a copy of this file named `.env` and populate it with your secrets. -# The below secret is not used anywhere but required for Auth.js (Would encrypt JWTs and Mail hashes, both not used) -AUTH_SECRET="supersecret" +# Generate two different 64-character hex values with `openssl rand -hex 32` before starting Homarr. +# Never reuse these values or commit the populated `.env` file. +AUTH_SECRET= # The below secret is used to encrypt integration secrets in the database. -# It should be a 32-byte string, generated by running `openssl rand -hex 32` on Unix -# or starting the project without any (which will show a randomly generated one). -SECRET_ENCRYPTION_KEY=0000000000000000000000000000000000000000000000000000000000000000 +# Homarr will reject an empty or invalid value and print a randomly generated candidate. +SECRET_ENCRYPTION_KEY= LOG_LEVEL='info' diff --git a/apps/docs/docs/getting-started/installation/source.mdx b/apps/docs/docs/getting-started/installation/source.mdx index 3016f23eb..3544fb1be 100644 --- a/apps/docs/docs/getting-started/installation/source.mdx +++ b/apps/docs/docs/getting-started/installation/source.mdx @@ -43,9 +43,9 @@ This method is only useful, when you want to develop on Homarr or extend it with `DB_URL='/home/username/homarr/db.sqlite'` if you want to store the database elsewhere.
  • - Replace `AUTH_SECRET` and `SECRET_ENCRYPTION_KEY` both with a secure random string by using `openssl rand -hex 32` + Run `openssl rand -hex 32` twice and set `AUTH_SECRET` and `SECRET_ENCRYPTION_KEY` to the two different generated + values. Keep both values secret and preserve `SECRET_ENCRYPTION_KEY` with your backups.
  • -
  • Replace `CRON_JOB_API_KEY` with a secure random string by using `openssl rand -base64 32`
  • Run `pnpm run db:migration:sqlite:run` and wait that it completes
  • Build the source using `pnpm build`