Skip to content

Commit

Permalink
Update documentation for cookie_secret (#1433)
Browse files Browse the repository at this point in the history
  • Loading branch information
krassowski authored Jul 10, 2024
1 parent f2d40f6 commit 5be0a9a
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions jupyter_server/serverapp.py
Original file line number Diff line number Diff line change
Expand Up @@ -1139,8 +1139,9 @@ def _default_cookie_secret_file(self) -> str:
b"",
config=True,
help="""The random bytes used to secure cookies.
By default this is a new random number every time you start the server.
Set it to a value in a config file to enable logins to persist across server sessions.
By default this is generated on first start of the server and persisted across server
sessions by writing the cookie secret into the `cookie_secret_file` file.
When using an executable config file you can override this to be random at each server restart.
Note: Cookie secrets should be kept private, do not share config files with
cookie_secret stored in plaintext (you can read the value from a file).
Expand Down

0 comments on commit 5be0a9a

Please sign in to comment.