Skip to content

Commit ef1b122

Browse files
author
Aleksandr Tihomirov
committed
Add the damn readme already
1 parent d5400fb commit ef1b122

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# 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)
2+
3+
## Why?
4+
5+
Because we want content locked to discord guild memberships.
6+
7+
## How?
8+
9+
You make a file named `config.yaml` with contents similar to what you can find in `config.example.yaml` in this repository.
10+
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.
11+
Once logged in, each request the user makes will be proxied to your defined backend, with attached named header, in example thats `XWhitelistedGuilds`.
12+
From there on its your job to handle that.
13+
14+
Session is valid for one week.

0 commit comments

Comments
 (0)