Skip to content

Commit

Permalink
docs: README updates
Browse files Browse the repository at this point in the history
  • Loading branch information
VeryStrongFingers committed Jan 26, 2024
1 parent 2631921 commit 5081310
Showing 1 changed file with 5 additions and 10 deletions.
15 changes: 5 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
<img src="./assets/logo.png" width="40%" height="40%" align="right">

# Caddy - Discord
Caddy - Discord [![Discord](https://img.shields.io/discord/1063070457047289907.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/k9tVAwws8U)
====

tl;dr: Authenticate caddy routes based on a Discord User Identity.
_<br />e.g. Accessing `/really-cool-people` requires user to have `{Role}` within `{Guild}`_

This package contains a module allowing authorization in Caddy based on a Discord Identity, by using Discords OAuth2 flow (authorization code grant).

---

`caddy-discord` is licensed under [_GNU Affero General Public License v3.0_](https://github.com/enum-gg/caddy-discord/blob/main/LICENSE.md)
<br><i>Logo created by [@AutonomousCat](https://github.com/AutonomousCat/)</i>
Licensed under [_GNU Affero General Public License v3.0_](https://github.com/enum-gg/caddy-discord/blob/main/LICENSE.md)
<br><i>Logo by [@AutonomousCat](https://github.com/AutonomousCat/)</i>

---

Expand Down Expand Up @@ -38,13 +40,6 @@ docker run -p 8080:8080 \

Loosely inspired from [caddy-security's Discord OAuth2 module](https://authp.github.io/docs/authenticate/oauth/backend-oauth2-0013-discord), with a much stronger focus on coupling Discord and Caddy for authentication purposes.

<div align="center">
<br />
<p>
<a href="https://discord.gg/k9tVAwws8U"><img src="https://img.shields.io/discord/1063070457047289907?color=5865F2&logo=discord&logoColor=white" alt="Discord server" /></a>
</p>
</div>

# Install

[**Download Latest Version**](https://github.com/enum-gg/caddy-discord/releases)
Expand Down

0 comments on commit 5081310

Please sign in to comment.