## Traefik and Docker Options WISHLIST_URL=wishlist.example.com WISHLIST_VERSION=latest ## Core Settings # Where to store databases, can be a CouchDB compatible server or directory. DB_PREFIX=dbs/ # Location of DB log file (if needed for debugging). DB_LOG_FILE=/dev/null # Where to send someone if they need to log in DEFAULT_FAILURE_REDIRECT=/login # Port to listen on PORT=80 # Expose the internal PouchDB with CouchDB API and Fauxton browser. Mostly used for debugging. Leave empty to disable. DB_EXPOSE_PORT= # Proxy to send item data requests to. Leave empty to disable. PROXY_SERVER= # Secret string to store session cookies with. Automatically generated if not provided. SECRET= # How long a user is logged in (milliseconds). Defaults to one week. SESSION_MAX_AGE=604800000 # The name of the site in the and navigation bar SITE_TITLE=Christmas Community # Used when shared to home screen SHORT_TITLE=Christmas # The root URL for forms, CSS, and a small amount of JS. Useful when proxying or using SSO. # If not using SSO, this can be a relative path. ROOT_URL=/ # Where to trust the X-Forwarded-For header from. Defaults to "loopback". Useful for proxying to docker. TRUST_PROXY=loopback # Any theme from https://jenil.github.io/bulmaswatch BULMASWATCH=default # Set to false to disable update notices UPDATE_CHECK=true # Set to false to disable the profile pictures feature PFP=true # Language of the interface, options listed in `languages` directory LANGUAGE=en-US # Password to enter guest mode, # e.g. https://wishes.example.com?pw=ReplaceWithYourGuestPassword # GUEST_PASSWORD=ReplaceWithYourGuestPassword ## Wishlist Settings # Set to true to not allow users to have their own lists. You may want this for a birthday or wedding. SINGLE_LIST=false # Set to false to allow viewing wishlists without logging in LISTS_PUBLIC=false # Defaults to true. Set to false for legacy cards view. TABLE=true # Allow Markdown in item notes. Does not work with TABLE=false. Defaults to false. MARKDOWN=false ## Custom HTML Snippets # These are inserted into specific locations in the relevant page # HTML is not escaped. Don't put untrusted data here. # CUSTOM_HTML_LOGIN=<p style="margin-top: 1em;">Some custom text for the Login page</p> # CUSTOM_HTML_WISHLISTS= # Custom CSS stylesheet # If you wish to include a custom stylesheet you can add the filename in the variable here. # Remember to add the stylesheet to the filesystem at `static/css/custom.css`. In docker, mount `/usr/src/app/src/static/css/custom.css`. # CUSTOM_CSS=custom.css ## Google Client Details # You can configure single sign-on to your Christmas Community instance using Google accounts. Read this guide for details of what to configure on the Google side: https://developers.google.com/identity/openid-connect/openid-connect # Once you've created a client ID and secret in your Google project use the below environment variables to enable SSO # GOOGLE_CLIENT_ID= # GOOGLE_CLIENT_SECRET= ## OIDC Provider Details # You can configure single sign-on to your Christmas Community instance using any OIDC provider. # Once you've created a client ID and secret in your authentication provider use the below environment variables to enable single sign on. # OIDC_CLIENT_ID= # OIDC_CLIENT_SECRET= # OIDC_AUTHORIZATION_URL=https://accounts.google.com/o/oauth2/auth # OIDC_TOKEN_URL=https://oauth2.googleapis.com/token # OIDC_ISSUER=https://accounts.google.com # OIDC_PROVIDER_NAME=Google # Profile picture upload max size in MB UPLOAD_PFP_MAX_SIZE=5