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

A lack of setup documentation #27

Open
wesleykirkland opened this issue Dec 5, 2024 · 4 comments
Open

A lack of setup documentation #27

wesleykirkland opened this issue Dec 5, 2024 · 4 comments

Comments

@wesleykirkland
Copy link

I've read the README through and through and I'm not understanding how people are setting up Lazy Warden. I've dug through the issues as well and there seems to be a pattern of documentation lacking for setup. I'm unable to find concrete documentation on the purpose of Bitwarden Secrets over storing the information in a .env file/docker secrets and I believe this is important as I can't enable Bitwarden Secrets on my account as I have 3 users in my Family plan. I'm struggling to see if there is a way to add tokens for authentication rather than providing my master password/user in the env file as well as how to map the TOTP token as there are zero references to it.

My last issue I'm struggling with on the documentation is adding the .env as environment variables and then mapping it on the file system, are these the same files and is this necessary? I'd be happy to PR all of these into proper documentation once I figure it out.

@BJReplay
Copy link

BJReplay commented Dec 5, 2024

I believe this is important as I can't enable Bitwarden Secrets on my account as I have 3 users in my Family plan.

Set up a new, free Bitwarden account to set up the Bitwarden Secrets. Job done.

The developer has chosen Bitwarden Secrets, and it's a good idea. Yes, it's a hoop you need to jump through, but as a platform for storing critical secrets, it's a pretty decent choice.

There are lots of issues that discuss how to provide the TOTP token - you might have to search closed issues, but it's there.

Yes, the documentation isn't brilliant, but you get what you pay for :)

@querylab
Copy link
Owner

querylab commented Dec 6, 2024

Hi @wesleykirkland

Thanks for your detailed feedback. I will work on improving the documentation on configuring Bitwarden Secrets, TOTP and environment variables. Also, you can contribute directly to the project to help implement authentication options with tokens instead of the master password. I invite you to contribute to the GitHub repositories, especially https://github.com/querylab/lazywarden_website to enrich the documentation.

@wesleykirkland
Copy link
Author

@querylab I'm not a developer by trade so I'm unable to contribute to the project, I'm happy to document it but I still haven't been provided any references to existing issues or tidbits on how I can proceed. I heard back from Bitwarden and family plans aren't eligible for Secrets Manager.

All of my issues still stand, I'd love to set it up but everything seems lackluster to get it setup and there isn't a starting ground from a mid step.

@BJReplay
Copy link

@wesleykirkland you need to try to help yourself. I've tried to give you a couple of suggestions (and I'm just another user):

Set up a new, free Bitwarden account to set up the Bitwarden Secrets.

You don't have to add Bitwarden Secrets to your existing Family Account, it can be a brand new account.

There are lots of issues that discuss how to provide the TOTP token - you might have to search closed issues, but it's there.

https://github.com/querylab/lazywarden/issues?q=TOTP searches for all issues with TOTP

That lists, for example, this issue #8 which gives you an example of how to set up your Bitwarden Secret Manager, showing how to set up TOTP:

# Bitwarden credentials
BW_URL=https://vault.bitwarden.com
BW_USERNAME=<values>
BW_PASSWORD=<values>
BW_TOTP_SECRET=0x000jkjkjkj000f-04300-dfs3-0000-000dsfsfsd000

@querylab has written a great, free tool, and has acknowledged that the documentation could be improved. But if you're unwilling to help yourself, you'll be unlikely to be able to get this going.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants