mirror of
https://github.com/Drop-OSS/drop-docs.git
synced 2026-01-30 20:55:17 +01:00
fix: convert all links to relative for versions
This commit is contained in:
@@ -16,7 +16,7 @@ We also recommend join our Discord: [Drop-OSS invite](https://discord.gg/NHx46XK
|
||||
## Self hosted
|
||||
Self hosted means there **is no central server.** Unlike many of the services which dominate the Internet today, Drop isn't a website you go to, it's software you download and run yourself. That means every person that uses Drop **has their own, independent copy**, which has it's own **own, independent URL or way to access it.**
|
||||
|
||||
Or, if you're lucky, one of your friends or family has already set up an instance, and provided you with a URL, in which case you can just head over to [Getting started with Drop](/docs/guides/client).
|
||||
Or, if you're lucky, one of your friends or family has already set up an instance, and provided you with a URL, in which case you can just head over to [Getting started with Drop](./guides/client).
|
||||
|
||||
## Game distribution
|
||||
A game distribution service is one that... distributes games. Think of Steam, GOG or Epic Games. You can view, buy and download games from these sites. That's what Drop is.
|
||||
|
||||
@@ -2,5 +2,5 @@
|
||||
|
||||
There are two options for authentication:
|
||||
|
||||
- [Simple](/docs/authentication/simple.md)
|
||||
- [OpenID Connect](/docs/authentication/oidc.md)
|
||||
- [Simple](./simple.md)
|
||||
- [OpenID Connect](./oidc.md)
|
||||
|
||||
@@ -19,4 +19,4 @@ Settings and press "Reset Default Apps". This will, however, result in resetting
|
||||
## I'm using the AppImage on GNOME/Wayland, but I can not interact with the window
|
||||
|
||||
If your Drop window behaves strangely, i.e clicking in it makes the previously interacted window pop up on top of drop, then you might want to build the AppImage yourself.
|
||||
See the [Building Drop OSS](/docs/advanced/building.md#building-drop-app-desktop-companion-app) page.
|
||||
See the [Building Drop OSS](../advanced/building.md#building-drop-app-desktop-companion-app) page.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Getting started with Drop
|
||||
Drop clients are available for download from the [our website](https://droposs.org/download). Download the correct version for your platform, and open it up.
|
||||
|
||||
The client will walk you through the setup and sign-in process to get started. You'll need a Drop instance you can connect to, and an account on the server. If you don't have one, you can follow the [Quickstart guide](/docs/guides/quickstart) to setup your own.
|
||||
The client will walk you through the setup and sign-in process to get started. You'll need a Drop instance you can connect to, and an account on the server. If you don't have one, you can follow the [Quickstart guide](./quickstart) to setup your own.
|
||||
@@ -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](/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:
|
||||
The `compose.yaml` provided in the [Quickstart guide](./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
|
||||
```
|
||||
|
||||
@@ -40,14 +40,14 @@ services:
|
||||
|
||||
**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.
|
||||
1. `./library` is where you will put your games to be imported into Drop. See '[Structuring your library](../library.md#structuring-your-library)' once you're set up.
|
||||
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](/docs/metadata/giantbomb.md)
|
||||
- [IGDB](/docs/metadata/igdb.md)
|
||||
- [PCGamingWiki](/docs/metadata/pcgamingwiki.md)
|
||||
- [GiantBomb](../metadata/giantbomb.md)
|
||||
- [IGDB](../metadata/igdb.md)
|
||||
- [PCGamingWiki](../metadata/pcgamingwiki.md)
|
||||
|
||||
:::tip
|
||||
If you want to, you can generate a more secure PostgreSQL username & password.
|
||||
@@ -61,7 +61,7 @@ Once your instance is running, it will log a URL that takes you to the setup wiz
|
||||
|
||||
## Setting up a client
|
||||
|
||||
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.
|
||||
To set up a client, your Drop instance will have to be accessible from it. See [Exposing your instance](./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.
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ We also recommend join our Discord: [Drop-OSS invite](https://discord.gg/NHx46XK
|
||||
## Self hosted
|
||||
Self hosted means there **is no central server.** Unlike many of the services which dominate the Internet today, Drop isn't a website you go to, it's software you download and run yourself. That means every person that uses Drop **has their own, independent copy**, which has it's own **own, independent URL or way to access it.**
|
||||
|
||||
Or, if you're lucky, one of your friends or family has already set up an instance, and provided you with a URL, in which case you can just head over to [Getting started with Drop](/docs/guides/client).
|
||||
Or, if you're lucky, one of your friends or family has already set up an instance, and provided you with a URL, in which case you can just head over to [Getting started with Drop](./guides/client).
|
||||
|
||||
## Game distribution
|
||||
A game distribution service is one that... distributes games. Think of Steam, GOG or Epic Games. You can view, buy and download games from these sites. That's what Drop is.
|
||||
|
||||
@@ -19,4 +19,4 @@ Settings and press "Reset Default Apps". This will, however, result in resetting
|
||||
## I'm using the AppImage on GNOME/Wayland, but I can not interact with the window
|
||||
|
||||
If your Drop window behaves strangely, i.e clicking in it makes the previously interacted window pop up on top of drop, then you might want to build the AppImage yourself.
|
||||
See the [Building Drop OSS](/docs/advanced/building.md#building-drop-app-desktop-companion-app) page.
|
||||
See the [Building Drop OSS](../advanced/building.md#building-drop-app-desktop-companion-app) page.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Getting started with Drop
|
||||
Drop clients are available for download from the [our website](https://droposs.org/download). Download the correct version for your platform, and open it up.
|
||||
|
||||
The client will walk you through the setup and sign-in process to get started. You'll need a Drop instance you can connect to, and an account on the server. If you don't have one, you can follow the [Quickstart guide](/docs/guides/quickstart) to setup your own.
|
||||
The client will walk you through the setup and sign-in process to get started. You'll need a Drop instance you can connect to, and an account on the server. If you don't have one, you can follow the [Quickstart guide](./quickstart) to setup your own.
|
||||
@@ -6,4 +6,4 @@ 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](/docs/guides/exposing)
|
||||
Once used, the invitation will be deleted. If you are unsure how to access your Drop instance, read through [Exposing your instance](./exposing)
|
||||
@@ -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](/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:
|
||||
The `compose.yaml` provided in the [Quickstart guide](./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
|
||||
```
|
||||
|
||||
@@ -45,13 +45,13 @@ services:
|
||||
|
||||
**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.
|
||||
1. `./library` is where you will put your games to be imported into Drop. See '[Structuring your library](../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](/docs/metadata/giantbomb.md) (only one supported as of v0.2.0-beta)
|
||||
- [GiantBomb](../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](/docs/guides/create-admin-account.md).
|
||||
Once your instance is running, [create your admin account](./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](/docs/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](./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.
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ We also recommend join our Discord: [Drop-OSS invite](https://discord.gg/NHx46XK
|
||||
## Self hosted
|
||||
Self hosted means there **is no central server.** Unlike many of the services which dominate the Internet today, Drop isn't a website you go to, it's software you download and run yourself. That means every person that uses Drop **has their own, independent copy**, which has it's own **own, independent URL or way to access it.**
|
||||
|
||||
Or, if you're lucky, one of your friends or family has already set up an instance, and provided you with a URL, in which case you can just head over to [Getting started with Drop](/docs/guides/client).
|
||||
Or, if you're lucky, one of your friends or family has already set up an instance, and provided you with a URL, in which case you can just head over to [Getting started with Drop](./guides/client).
|
||||
|
||||
## Game distribution
|
||||
A game distribution service is one that... distributes games. Think of Steam, GOG or Epic Games. You can view, buy and download games from these sites. That's what Drop is.
|
||||
|
||||
@@ -2,5 +2,5 @@
|
||||
|
||||
There are two options for authentication:
|
||||
|
||||
- [Simple](/docs/authentication/simple.md)
|
||||
- [OpenID Connect](/docs/authentication/oidc.md)
|
||||
- [Simple](./simple.md)
|
||||
- [OpenID Connect](./oidc.md)
|
||||
|
||||
@@ -19,4 +19,4 @@ Settings and press "Reset Default Apps". This will, however, result in resetting
|
||||
## I'm using the AppImage on GNOME/Wayland, but I can not interact with the window
|
||||
|
||||
If your Drop window behaves strangely, i.e clicking in it makes the previously interacted window pop up on top of drop, then you might want to build the AppImage yourself.
|
||||
See the [Building Drop OSS](/docs/advanced/building.md#building-drop-app-desktop-companion-app) page.
|
||||
See the [Building Drop OSS](../advanced/building.md#building-drop-app-desktop-companion-app) page.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Getting started with Drop
|
||||
Drop clients are available for download from the [our website](https://droposs.org/download). Download the correct version for your platform, and open it up.
|
||||
|
||||
The client will walk you through the setup and sign-in process to get started. You'll need a Drop instance you can connect to, and an account on the server. If you don't have one, you can follow the [Quickstart guide](/docs/guides/quickstart) to setup your own.
|
||||
The client will walk you through the setup and sign-in process to get started. You'll need a Drop instance you can connect to, and an account on the server. If you don't have one, you can follow the [Quickstart guide](./quickstart) to setup your own.
|
||||
@@ -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](/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:
|
||||
The `compose.yaml` provided in the [Quickstart guide](./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
|
||||
```
|
||||
|
||||
@@ -40,14 +40,14 @@ services:
|
||||
|
||||
**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.
|
||||
1. `./library` is where you will put your games to be imported into Drop. See '[Structuring your library](../library.md#structuring-your-library)' once you're set up.
|
||||
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](/docs/metadata/giantbomb.md)
|
||||
- [IGDB](/docs/metadata/igdb.md)
|
||||
- [PCGamingWiki](/docs/metadata/pcgamingwiki.md)
|
||||
- [GiantBomb](../metadata/giantbomb.md)
|
||||
- [IGDB](../metadata/igdb.md)
|
||||
- [PCGamingWiki](../metadata/pcgamingwiki.md)
|
||||
|
||||
:::tip
|
||||
If you want to, you can generate a more secure PostgreSQL username & password.
|
||||
|
||||
Reference in New Issue
Block a user