utterances-oauth

install

npm install

configuring for debugging

1. Create a file named .env at the root. File should have the following values:

   • PORT: the port the http server will listen on
   • BOT_TOKEN: a personal access token that will be used when creating GitHub issues.
   • CLIENT_ID: The client id to be used in the GitHub OAuth web application flow
   • CLIENT_SECRET: The client secret for the OAuth web application flow
   • STATE_PASSWORD: 32 character password for encrypting state in request headers/cookies. Generate here.
   • SCOPES: The OAuth scopes the service is permitted to grant. "public_repo"
   • ORIGINS: comma delimited list of permitted origins. For CORS.
   • APP_ROOT: The root url of the deployed application. eg https://utterances-oauth.azurewebsites.net
   • USER_AGENT: The GitHub API requires a User-Agent header.

   Example:

   PORT=5000
   BOT_TOKEN=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
   CLIENT_ID=aaaaaaaaaaaaaaaaaaaa
   CLIENT_SECRET=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
   STATE_PASSWORD=01234567890123456789012345678901
   SCOPES=public_repo
   ORIGINS=https://utteranc.es,http://localhost:9000
   APP_ROOT=http://localhost:5000
   USER_AGENT=utterances
   

2. Execute npm run develop to watch the TypeScript files and automatically build them.

3. Execute npm run start-env to set the environment variables using your .env and execute index.js.

Docker

A docker image now exists and can be run as

HOST=utterances-oauth.your-website.com
ORIGIN=utterances.your-website.com
docker container run -d --name utterances_oauth \
    -e PORT=5000 \
    -e BOT_TOKEN=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa \
    -e CLIENT_ID=aaaaaaaaaaaaaaaaaaaa \
    -e CLIENT_SECRET=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa \
    -e STATE_PASSWORD=01234567890123456789012345678901 \
    -e SCOPES=public_repo \
    -e ORIGINS=https://${ORIGIN},http://localhost:9000 \
    -e APP_ROOT=https://${HOST} \
    -e USER_AGENT=utterances \
    jtreminio/utterances-oauth

If you use Traefik you would run the following:

HOST=utterances-oauth.your-website.com
ORIGIN=utterances.your-website.com
docker container run -d --name utterances_oauth \
    --label traefik.backend=utterances_oath \
    --label traefik.docker.network=traefik_webgateway \
    --label traefik.frontend.rule=Host:${HOST} \
    --label traefik.port=5000 \
    --network traefik_webgateway \
    --restart always \
    -e PORT=5000 \
    -e BOT_TOKEN=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa \
    -e CLIENT_ID=aaaaaaaaaaaaaaaaaaaa \
    -e CLIENT_SECRET=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa \
    -e STATE_PASSWORD=01234567890123456789012345678901 \
    -e SCOPES=public_repo \
    -e ORIGINS=https://${ORIGIN},http://localhost:9000 \
    -e APP_ROOT=https://${HOST} \
    -e USER_AGENT=utterances \
    jtreminio/utterances-oauth