htenv v0.2.2

htenv

Use basic auth from environments variables for express.

Install

$ npm install --save htenv

Usage

Simple express server :

// index.js
const app = require('express')()
const htenv = require('htenv')

app.use(
  htenv({
    /* options */
  })
)

app.get('/', (req, res, next) => {
  res.send('Hello.')
})

app.listen(8080, () => console.log('Server started'))

For nextjs server :

const { createServer } = require('http')
const { parse } = require('url')
const next = require('next')
const htenv = require('htenv')

const dev = process.env.NODE_ENV !== 'production'
const PORT = process.env.PORT || 8080
const app = next({ dev })
const handle = app.getRequestHandler()

app.prepare().then(() => {
  createServer(async (req, res) => {
    const allowed = await htenv()(req, res)
    if (allowed) {
      const parsedUrl = parse(req.url, true)
      handle(req, res, parsedUrl)
    }
  }).listen(PORT, (err) => {
    if (err) throw err
    console.log('> Ready on http://localhost:' + PORT)
  })
})

And run with env vars :

$ HTPASSWD=john:\$apr1\$5lF5WhAG\$SfmLYeIAMTTqSnFrwd1tt0 node index.js # pass is 42

You can use many with append random chars :

$ HTPASSWD=john:\$apr1\$5lF5WhAG\$SfmLYeIAMTTqSnFrwd1tt0 \
  HTPASSWD_1=john2:\$apr1\$5lF5WhAG\$SfmLYeIAMTTqSnFrwd1tt0 \
  HTPASSWD_X=john3:\$apr1\$5lF5WhAG\$SfmLYeIAMTTqSnFrwd1tt0 \
  node index.js

Be carfull with \$ chars : Add backslash in bash, double it on docker-compose.yml :

services:
  app:
    image: node
    command: cd /app && npm run start
    volumes:
      - '.:/app'
    environment:
      HTPASSWD: "john:$$apr1$$5lF5WhAG$$SfmLYeIAMTTqSnFrwd1tt0"
      HTPASSWD_1: "john2:$$apr1$$5lF5WhAG$$SfmLYeIAMTTqSnFrwd1tt0"
      HTPASSWD_X: "john3:$$apr1$$5lF5WhAG$$SfmLYeIAMTTqSnFrwd1tt0"

Options

• key (default 'HTPASSWD') : Start of environment variables name
• realm (default 'Restricted area') : Message on the popup

app.use(
  htenv({
    key: 'MY_CUSTOM_ACCESS',
    realm: 'Who are you ?',
  })
)