Skip to content

Latest commit

 

History

History
33 lines (20 loc) · 1.41 KB

README.md

File metadata and controls

33 lines (20 loc) · 1.41 KB
Raw

Identity

This is a simple Flask app that provides an OpenID server for a single user.

Configuration

You'll want to edit identity/config.yml to reflect the information about yourself.

For passphrase_digest, you can generate a bcrypted passphrase digest by running scripts/generate_bcrypt_passphrase.py.

If you want to receive emails about unexpected errors, define an error_emails association with an SMTP host, sender address, and list of recipient addresses. If your SMTP host requires authentication, your credentials should be in environment variables, as described below.

Running the server

In production, it's best to launch the server using Gunicorn:

gunicorn identity.app:app -b 0.0.0.0:$PORT -w 3

In production, it's probably more convenient to leave gunicorn out and invoke app.py directly:

python identity/app.py

Either way, the server relies on several environment variables:

  • PORT - The network port on which the server should listen
  • SESSION_KEY - A key to be used for encrypting and decrypting session data. Keep it secret. Keep it safe.
  • SERVER_NAME - The protocol and host on which the server is running, with a trailing slash (e.g. https://identity.yourname.info/)

Additionally, if you've configured error emails using an SMTP host that requires authentication, put your credentials in the EMAIL_USERNAME and EMAIL_PASSWORD environment variables.