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.

Sign up for GitHub

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

Jump to bottom

Improvements to auth Readme #1

Merged
merged 2 commits into from
Feb 23, 2022
Merged

Improvements to auth Readme #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e15b74
Clarify the location of the local.env.sh files
sauntimo Feb 23, 2022
b8f5b72
Improve hosting middleware instructions
sauntimo Feb 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions auth/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ hash_config {
#### Set your Hash Parameters
Now that you have your 4 hash parameters, you can set them up in your environment(s):
##### For a local development server (or hosting your own `NodeJS` server):
* copy the file `local.env.sh.sample` to `local.env.sh`
* copy the file `local.env.sh.sample` to `local.env.sh` (in the middleware/verify-firebase-pw folder)
* edit the `MEMCOST`, `ROUNDS`, `SALTSEPARATOR`, and `SIGNERKEY` environment variables you obtained in the previous step

Sample `local.env.sh` file:
Expand Down Expand Up @@ -98,7 +98,8 @@ Sample `[env]` section for the `fly.toml` file:
#### Hosting the Middleware
##### Local hosting for testing (or for running your own server using `NodeJS`):
* make sure you've set up `local.env.sh` as described above
* run `node local.sh`
* run `npm i` in `auth/middleware/verify-firebase-pw/` to install dependencies
* run `./local.sh`
The `local.sh` file does two things:
```sh
source ./local.env.sh # sets environment variables stored in ./local.env.sh
Expand Down