Skip to content

Commit

Permalink
Add the damn readme already
Browse files Browse the repository at this point in the history
  • Loading branch information
Aleksandr Tihomirov committed Feb 25, 2017
1 parent d5400fb commit ef1b122
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# DisGuard - Discord OAuth Proxy [![GoDoc](https://godoc.org/go.zeta.pm/disguard?status.svg)](https://godoc.org/go.zeta.pm/disguard) [![Build Status](https://travis-ci.org/zet4/disguard.svg?branch=master)](https://travis-ci.org/zet4/disguard) [![Go Report Card](https://goreportcard.com/badge/go.zeta.pm/disguard.svg)](https://goreportcard.com/report/go.zeta.pm/disguard) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/zet4/disguard/blob/master/LICENSE)

## Why?

Because we want content locked to discord guild memberships.

## How?

You make a file named `config.yaml` with contents similar to what you can find in `config.example.yaml` in this repository.
Once done, launch the application and go to the website, if you configured it to require session, you will be sent to oauth login right away, if not, you will have to manually visit `/oauth/login` to get redirected.
Once logged in, each request the user makes will be proxied to your defined backend, with attached named header, in example thats `XWhitelistedGuilds`.
From there on its your job to handle that.

Session is valid for one week.

0 comments on commit ef1b122

Please sign in to comment.