Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Default Config Bug OR Docs Missing Step #5075

Open
akeslo opened this issue Jul 10, 2024 · 1 comment
Open

Default Config Bug OR Docs Missing Step #5075

akeslo opened this issue Jul 10, 2024 · 1 comment
Labels
bug Something isn't working

Comments

@akeslo
Copy link

akeslo commented Jul 10, 2024

Bug Description

Unable to start webserver:

╰─$ fides webserver

Loaded config from: .fides/fides.toml

There are missing required configuration variables. Please add the following config variables to either the fides.toml file or your environment variables to start Fides:

  • security.app_encryption_key
  • security.oauth_root_client_id
  • security.oauth_root_client_secret

Visit the Fides deployment documentation for more information: https://docs.ethyca.com/fides/deployment
*Side note, above documentation link yields 404. Will open separate issue.

Steps to Reproduce

fides init
fides webserver

╰─$ fides init

Loaded config from: .fides/fides.toml

███████╗██╗██████╗ ███████╗███████╗
██╔════╝██║██╔══██╗██╔════╝██╔════╝
█████╗ ██║██║ ██║█████╗ ███████╗
██╔══╝ ██║██║ ██║██╔══╝ ╚════██║
██║ ██║██████╔╝███████╗███████║
╚═╝ ╚═╝╚═════╝ ╚══════╝╚══════╝

Initializing fides...

Ethyca exists to make privacy a default feature of any tech stack, and we need your consent to use some of your data to achieve this mission:

- Usage statistics, including a unique identifier, for product improvement
- Your email address and organization name, for our sales team (we will never share this data)

You can learn more, and manage your privacy settings any time by visiting:
https://fid.es/privacy

Opt-in to anonymous usage analytics? [y/N]: n
Directory './.fides' already exists.
Configuration file already exists: ./.fides/fides.toml
To learn more about configuring fides, see:
https://ethyca.github.io/fides/config/

╰─$ fides webserver

Loaded config from: .fides/fides.toml

There are missing required configuration variables. Please add the following config variables to either the fides.toml file or your environment variables to start Fides:

  • security.app_encryption_key
  • security.oauth_root_client_id
  • security.oauth_root_client_secret

Visit the Fides deployment documentation for more information: https://docs.ethyca.com/fides/deployment

Expected behavior

Webserver should launch per quick start instructions

image image

Environment

  • Version: 2.40.0
  • OS: Mac OSx
  • Python Version: 3.9
  • Docker Version: 20.0

Additional context

@akeslo akeslo added the bug Something isn't working label Jul 10, 2024
@marcusolsson
Copy link

I'd guess this is intentional. These are required fields, so you must configure them. But if they had default values, that would give attackers a hint about what to test for. Another option would be to generate random values when running fides init, but IMO it's better to make a conscious choice.

That being said, to improve the onboarding experience, I'd consider prompting the user for the values during fides init, so that the first call to fides webserver would be successful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants