Skip to content

Commit

Permalink
Merge branch 'refs/heads/develop' into feat/fido-connect-extension
Browse files Browse the repository at this point in the history
# Conflicts:
#	README.md
  • Loading branch information
PhearZero committed Apr 29, 2024
2 parents 868192e + 5e17d3c commit 52783fa
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 8 deletions.
22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ A user must prove ownership of a private key to associate PublicKeyCredentials
## Getting started

### Prerequisites
- Node.js 20
- Node.js 18+
- Docker

#### Clone the project
Expand All @@ -25,9 +25,25 @@ git clone [email protected]:algorandfoundation/liquid-auth.git && cd liquid-auth

### NGROK

WebAuthn requires a secure context (HTTPS) to work and this will not allow you to test the FIDO2 feature in your local machine.
**note on VPNs**: Ngrok will not work with VPNs, so to run locally the project, `disable` it or `configure` your VPN's split tunneling to allow ngrok traffic.

Sign up for a free account at [ngrok](https://ngrok.com/) and configure a static domain for your account.
Sign up for a free account at [ngrok](https://ngrok.com/) and follow the instructions to get your <NGROK_AUTH_TOKEN> and <NGROK_STATIC_DOMAIN>.

#### With Docker
Don't run the ngrok commands directly as expressed in the ngrok guide as it will create run-time port conflicts.

#### Without Docker
nrokg will ask you to add your auth token to your configuration file.

``` bash
ngrok config add-authtoken <NGROK_AUTH_TOKEN>
```

Will then ask you to deploy your static domain, make sure to change the port to **5137** like this:

``` bash
ngrok http --domain=<NGROK_STATIC_DOMAIN> 5137
```

#### Configure NGROK

Expand Down
9 changes: 5 additions & 4 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ version: '3.4'
services:
liquid-auth:
build: .
restart: always
restart: no
env_file:
- .env.docker
ports:
Expand All @@ -13,12 +13,12 @@ services:
- mongo
- ngrok
liquid-demo:
restart: no
build:
context: .
dockerfile: Vite.Dockerfile
ports:
- "5173:5173"
restart: always
environment:
- PROXY_URL=http://liquid-auth:3000
- WSS_PROXY_SERVER=ws://liquid-auth:3000
Expand All @@ -27,7 +27,7 @@ services:
- ngrok
ngrok:
image: ngrok/ngrok:latest
restart: unless-stopped
restart: no
command:
- "start"
- "--all"
Expand All @@ -44,7 +44,7 @@ services:
- "6379:6379"
mongo:
image: mongo:7.0
restart: always
restart: no
environment:
- MONGO_INITDB_DATABASE=${DB_NAME:-fido}
- MONGO_INITDB_ROOT_USERNAME=${DB_USERNAME:-algorand}
Expand All @@ -55,6 +55,7 @@ services:
- mongo:/data/db
turn:
image: coturn/coturn
restart: no
deploy:
replicas: 0
depends_on:
Expand Down
2 changes: 1 addition & 1 deletion services/liquid-auth-api-js/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@
"typescript": "^5.3.3"
},
"engines": {
"node": ">=18.0.0 <21.0.0"
"node": ">=18.0.0"
},
"jest": {
"testTimeout": 10000,
Expand Down

0 comments on commit 52783fa

Please sign in to comment.