https://github.com/utterance/utterances-oauth
:lock: OAuth flow for utterances, utterance-bot APIs
https://github.com/utterance/utterances-oauth
Last synced: 9 months ago
JSON representation
:lock: OAuth flow for utterances, utterance-bot APIs
- Host: GitHub
- URL: https://github.com/utterance/utterances-oauth
- Owner: utterance
- License: mit
- Created: 2017-04-24T05:55:53.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-06-25T10:06:48.000Z (over 3 years ago)
- Last Synced: 2025-03-22T14:11:41.109Z (10 months ago)
- Language: TypeScript
- Homepage: https://utteranc.es
- Size: 132 KB
- Stars: 113
- Watchers: 9
- Forks: 49
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - utterances-oauth - bot APIs | utterance | 85 | (TypeScript)
README
# utterances-oauth
This repo contains the source for the [Cloudflare Worker](https://developers.cloudflare.com/workers/) that powers the GitHub OAuth flow and issue creation for Utterances.
## install
```
yarn install
```
## configuration
Create a file named `.env` at the root. File should have the following values:
- 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](https://developer.github.com/v3/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](https://lastpass.com/generatepassword.php).
- ORIGINS: comma delimited list of permitted origins. For CORS.
Example:
```
BOT_TOKEN=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
CLIENT_ID=aaaaaaaaaaaaaaaaaaaa
CLIENT_SECRET=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
STATE_PASSWORD=01234567890123456789012345678901
ORIGINS=https://utteranc.es,http://localhost:9000
```
## run locally
```
yarn run start
```
## build
```
yarn run build
```
## deploy
First add the necessary CLOUDFLARE\_\* entries to your .env file. See [@cfworker/dev README](https://www.npmjs.com/package/@cfworker/dev) for more information.
Then execute:
```
yarn run deploy
```