summaryrefslogtreecommitdiffhomepage
path: root/example/README.md
blob: 4b53d81aca7541ecdd0d63eb86818de7452377c5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# SimpleWebAuthn Example

A fully-functional reference implementation of [@simplewebauthn/server](../packages/server) and [@simplewebauthn/browser](../packages/browser).

## Requirements

- Node v10.0.0+

### SSL Certificate

Websites that wish to leverage WebAuthn _must_ be served over HTTPS, **including during development!**

Here's one technique for setting up SSL for a local dev instance:

1. Create a `dev` A-record in `yourdomain.com`'s DNS settings that points to `127.0.0.1`
2. Use EFF's [certbot](https://certbot.eff.org/) locally to generate a .crt and .key for that `dev` subdomain
3. Update `key` and `cert` passed into `https.createServer()` to point to your custom certificates

## Instructions

1. Set up your SSL certificates as above
2. Install dependencies with `npm install`
3. Start the server with `npm start`
4. Navigate to `https://dev.yourdomain.com`