feat(wiki): v0.1.0-beta getting started

This commit is contained in:
DecDuck
2024-12-25 18:32:54 +11:00
commit 9c04de805d
15 changed files with 1503 additions and 0 deletions
+1
View File
@@ -0,0 +1 @@
# Getting started with Drop
+9
View File
@@ -0,0 +1,9 @@
# Create your admin account
A freshly set up Drop instance will have an 'admin invitation' created. This allows you to create your admin account without having to copy credentials from the command line, or similar.
To use the invitation, go to:
```
{Drop instance URL}/register?id=admin
```
Once used, the invitation will be deleted. If you are unsure how to access your Drop instance, read through [Exposing your instance](/guides/exposing)
+20
View File
@@ -0,0 +1,20 @@
# Exposing your instance
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:
```
http://[instance IP]:3000
```
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.1.0-beta` 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.
Accessing Drop over a VPN works very similarly to [accessing via LAN](#lan), so follow those steps.
+68
View File
@@ -0,0 +1,68 @@
# Quickstart
This guide quickly runs through how to get set up with Drop in about five minutes, depending on your experience.
## Setting up the instance
The easiest way to get Drop running is using our pre-built Docker container.
```yaml compose.yaml
services:
postgres:
image: postgres:14-alpine
ports:
- 5432:5432
healthcheck:
test: ["CMD-SHELL", "pg_isready", "-d", "postgres"]
interval: 30s
timeout: 60s
retries: 5
start_period: 10s
volumes:
- ./db:/var/lib/postgresql/data
environment:
- POSTGRES_PASSWORD=drop
- POSTGRES_USER=drop
- POSTGRES_DB=drop
drop:
image: registry.deepcore.dev/drop-oss/drop/main:latest
depends_on:
postgres:
condition: service_healthy
ports:
- 3000:3000
volumes:
- ./library:/library
- ./certs:/certs
- ./objects:/objects
environment:
- DATABASE_URL=postgres://drop:drop@postgres:5432/drop
- FS_BACKEND_PATH=/objects
- CLIENT_CERTIFICATES=/certs
- 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)
**In addition, configure your chosen metadata provider:**
- [GiantBomb](/metadata/giantbomb.md) (only one supported as of v0.1.0-beta)
::: tip
If you want to, you can generate a more secure PostgreSQL username & password.
:::
Once your instance is running, [create your admin account](/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.
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.
Once installed, open the Drop app for the first time. There is an automated wizard that'll walk you through the steps of signing into your Drop instance.