Drop-OSS/drop-docs
1
0
Fork 0
mirror of https://github.com/Drop-OSS/drop-docs.git synced 2026-07-01 10:40:12 -04:00
Code Issues 9 Packages Projects Releases Wiki Activity

feat: add auth docs

Browse Source
This commit is contained in:
DecDuck
2025-05-25 18:29:46 +10:00
parent a4bdbffc0d
commit 1532b2ace4
9 changed files with 72 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+2 -40
View File
@@ -1,41 +1,3 @@
# Website
# drop-docs
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
### Installation
```
$ yarn
```
### Local Development
```
$ yarn start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
### Build
```
$ yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
Using SSH:
```
$ USE_SSH=true yarn deploy
```
Not using SSH:
```
$ GIT_USER=<Your GitHub username> yarn deploy
```
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
The documentation. Check it out: https://docs.droposs.org/
docs/authentication/index.md
+6
View File
@@ -0,0 +1,6 @@
# Authentication
There are two options for authentication:
- [Simple](/docs/authentication/simple.md)
- [OpenID Connect](/docs/authentication/oidc.md)
docs/authentication/oidc.md
+29
View File
@@ -0,0 +1,29 @@
# OpenID Connect
OpenID Connect is a OAuth2 extension support by most identity providers.
## Configure OpenID Connect
To configure OIDC, you must set the following environment variables:
| Variable | Usage |
| -------------------------------- | ------------------------------------------------------------------------------------------------- |
| `OIDC_CLIENT_ID` | Client ID from your identity provider. |
| `OIDC_CLIENT_SECRET` | Client secret from your identity provider. |
| `OIDC_ADMIN_GROUP` | Grant admin to users with this group configured in your identity provider. Tested with Authentik. |
| `DISABLE_SIMPLE_AUTH` (optional) | Disable simple auth |
And then, you must configure **either**:
#### `OIDC_WELLKNOWN`: A unprotected endpoint that returns a OIDC well-known JSON. Fetched on startup.
---
#### Individual endpoints:
| Variable | Usage |
| -------------------- | ------------------------------------------------------------------------- |
| `OIDC_AUTHORIZATION` | Authorization endpoint. Usually ends with `authorize`. |
| `OIDC_TOKEN` | Token endpoint. Usually ends with `token`. |
| `OIDC_USERINFO` | Userinfo endpoint. Usually ends with `userinfo`. |
| `OIDC_SCOPES` | Comma separated list of scopes. Requires, at least, `openid` and `email`. |
docs/authentication/simple.md
+15
View File
@@ -0,0 +1,15 @@
# Simple
Simple authentication (or simple auth) is a basic username and password combination. It's the default for Drop, and is the fallback authentication mechanism if Drop is unable to initialise any others.
Simple authentication works on a system of invites.
## Creating an invite
Head to your Drop Admin dashboard, and click on the 'Users' tab. Then, head to the authentication panel by clicking the 'Authentication &rarr;' button.
Then, on the "Simple" auth, click the three-dot menu, and configure. Then, create an invite with the button and modal.
## Disabling simple auth
If you've configured another authentication mechanism, you can disable simple by setting the environment variable `DISABLE_SIMPLE_AUTH` to "true".
docs/guides/exposing.md
+2 -2
View File
@@ -2,7 +2,7 @@
Exposing your instance allows it to be accessible from other computers than the one you're hosting it on.
## LAN
The `compose.yaml` provided in the [Quickstart guide](/guides/quickstart.md) already exposes the Drop instance on port 3000. If you're on the same LAN as your Drop instance, you can find it's IP and then use:
The `compose.yaml` provided in the [Quickstart guide](/docs/guides/quickstart.md) already exposes the Drop instance on port 3000. If you're on the same LAN as your Drop instance, you can find it's IP and then use:
```
http://[instance IP]:3000
```
@@ -12,7 +12,7 @@ as the connection URL when setting up your Drop client.
## Reverse Proxy
If you are unsure how to set up a reverse proxy, or even what one is, this guide isn't for you. There are far better guides out there, so follow them to set up your reverse proxy.
As of `v0.2.0-beta` there is no special configuration required to run Drop behind a reverse proxy.
There is no special configuration required to run Drop behind a reverse proxy.
## VPN
If you are unsure how to setup a VPN for remote access, please find and follow a far better guide than this one.
docs/guides/quickstart.md
+9 -11
View File
@@ -25,7 +25,7 @@ services:
- POSTGRES_USER=drop
- POSTGRES_DB=drop
drop:
image: decduck/drop-oss:v0.2.0-beta
image: ghcr.io/drop-oss/drop:nightly
depends_on:
postgres:
condition: service_healthy
@@ -33,25 +33,23 @@ services:
- 3000:3000
volumes:
- ./library:/library
- ./certs:/certs
- ./objects:/objects
- ./data:/data
environment:
- DATABASE_URL=postgres://drop:drop@postgres:5432/drop
- FS_BACKEND_PATH=/objects
- CLIENT_CERTIFICATES=/certs
- DATA=/data
- LIBRARY=/library
- GIANT_BOMB_API_KEY=REPLACE_WITH_YOUR_KEY
```
**The main things in this `compose.yaml` is the volumes attached to the `drop` service:**
1. `./library` is where you will put your games to be imported into Drop. See '[Structuring your library](/docs/library.md#structuring-your-library)' once you're set up.
2. `./certs` is where Drop will store cryptographic certificates relating to the function of Drop end clients and the connections between them. In order to make sure the traffic isn't being snooped on, keep this directory safe.
3. `./objects` is where Drop will store uploaded & downloaded files (from metadata providers)
2. `./data` is where Drop will store anything that's using the default file-system backed storage system. Typically, these are objects.
**In addition, configure your chosen metadata provider:**
- [GiantBomb](/metadata/giantbomb.md) (only one supported as of v0.2.0-beta)
- [GiantBomb](/docs/metadata/giantbomb.md)
- [IGDB](/docs/metadata/igdb.md)
- [PCGamingWiki](/docs/metadata/pcgamingwiki.md)
:::tip
If you want to, you can generate a more secure PostgreSQL username & password.
@@ -61,11 +59,11 @@ If you want to, you can generate a more secure PostgreSQL username & password.
For security reasons, the Drop server and client's times need to be within 30 seconds of each other, otherwise authorization will fail.
:::
Once your instance is running, [create your admin account](/guides/create-admin-account.md).
Once your instance is running, [create your admin account](/docs/guides/create-admin-account.md).
## Setting up a client
To set up a client, your Drop instance will have to be accessible from it. See [Exposing your instance](/guides/exposing.md) for information on how to do that.
To set up a client, your Drop instance will have to be accessible from it. See [Exposing your instance](/docs/guides/exposing.md) for information on how to do that.
First, download the latest client for your platform from [the GitHub releases page](https://github.com/Drop-OSS/drop-app/releases). Then, install it for your platform. If we don't have a binary available for your platform, please create an issue on [the Drop app repository](https://github.com/Drop-OSS/drop-app) and we'll investigate it.
sidebars.ts
+5
View File
@@ -35,6 +35,11 @@ const sidebars: SidebarsConfig = {
label: "Metadata",
items: ["metadata/giantbomb", "metadata/igdb", "metadata/pcgamingwiki"],
},
{
type: "category",
label: "Authentication",
items: ["authentication/simple", "authentication/oidc"],
},
{
type: "category",
label: "Advanced",
versioned_docs/version-0.2.0/guides/exposing.md
+1 -1
View File
@@ -2,7 +2,7 @@
Exposing your instance allows it to be accessible from other computers than the one you're hosting it on.
## LAN
The `compose.yaml` provided in the [Quickstart guide](/guides/quickstart.md) already exposes the Drop instance on port 3000. If you're on the same LAN as your Drop instance, you can find it's IP and then use:
The `compose.yaml` provided in the [Quickstart guide](/docs/guides/quickstart.md) already exposes the Drop instance on port 3000. If you're on the same LAN as your Drop instance, you can find it's IP and then use:
```
http://[instance IP]:3000
```
versioned_docs/version-0.2.0/guides/quickstart.md
+3 -3
View File
@@ -51,7 +51,7 @@ services:
**In addition, configure your chosen metadata provider:**
- [GiantBomb](/metadata/giantbomb.md) (only one supported as of v0.2.0-beta)
- [GiantBomb](/docs/metadata/giantbomb.md) (only one supported as of v0.2.0-beta)
:::tip
If you want to, you can generate a more secure PostgreSQL username & password.
@@ -61,11 +61,11 @@ If you want to, you can generate a more secure PostgreSQL username & password.
For security reasons, the Drop server and client's times need to be within 30 seconds of each other, otherwise authorization will fail.
:::
Once your instance is running, [create your admin account](/guides/create-admin-account.md).
Once your instance is running, [create your admin account](/docs/guides/create-admin-account.md).
## Setting up a client
To set up a client, your Drop instance will have to be accessible from it. See [Exposing your instance](/guides/exposing.md) for information on how to do that.
To set up a client, your Drop instance will have to be accessible from it. See [Exposing your instance](/docs/guides/exposing.md) for information on how to do that.
First, download the latest client for your platform from [the GitHub releases page](https://github.com/Drop-OSS/drop-app/releases). Then, install it for your platform. If we don't have a binary available for your platform, please create an issue on [the Drop app repository](https://github.com/Drop-OSS/drop-app) and we'll investigate it.