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

Update the wiki #129

Open
riverrun opened this issue Aug 5, 2018 · 5 comments
Open

Update the wiki #129

riverrun opened this issue Aug 5, 2018 · 5 comments

Comments

@riverrun
Copy link
Owner

riverrun commented Aug 5, 2018

Needed updates:

  • requirements, especially Windows
  • docker info
  • make it easier to find info and add links to related issues

Also update the READMEs of the dependency libraries, so that users of those libraries are directed to the Comeonin wiki.

@riverrun
Copy link
Owner Author

Mostly done - just the Requirements page still needs to be updated.

@mikepc
Copy link

mikepc commented Sep 9, 2020

Actually the documentation is rather cryptic.

Specifically:
hash_pwd_salt(password, opts)

What is opts ? No examples are given, and all of the online examples use a previous API which is incompatible.

hash_pwd_salt/1 is undefined, but the docs provide no specification on what opts even is. Still digging through the code to try to figure it out, as an elixir/phoenix newbie it hurts to have so few examples in the docs :(

@riverrun
Copy link
Owner Author

Thanks for the input. I'll look into this as soon as I can.

@riverrun
Copy link
Owner Author

@mikepc in response to your question about hash_pwd_salt, the opts depends on which hashing algorithm you are using - you will need to see the documentation for argon2_elixir, bcrypt_elixir or pbkdf2_elixir.

Some of the opts are options for the Base.hash_password function, so you will need to look at the docs for that as well.

This page can help you decide which hashing algorithm to use.

@belgoros
Copy link

The installation section needs to be updated as well.
Installing a recent version of Visual C++ Build Tools is not enough, you should still have Visual Studio installed too. Otherwise, it will fail just when you run iex -S mix with:

could not compile dependency :bcrypt_elixir, "mix compile" failed. Errors may have been logged above. You can recompile this dependency with "mix deps.compile bcrypt_elixir --force", update it with "mix deps.update bcrypt_elixir" or clean it with "mix deps.clean bcrypt_elixir"
** (Mix) "nmake" not found in the path. If you have set the MAKE environment variable, please make sure it is correct.

Moreover, you indicate it one line later saying:

After installing Visual C++ Build Tools, look in the Program Files (x86) folder and search for Microsoft Visual Studio. Note down the full path of the folder with the highest version number.

This folder will never even exist if you haven't Visual Studio installed.

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