diff --git a/docs/about.md b/docs/about.md index 6ef9844..077d914 100644 --- a/docs/about.md +++ b/docs/about.md @@ -5,29 +5,34 @@ Drop is an open-source, self-hosted game distribution platform. It's designed of Don't know what any of that means? Keep reading. ## Open source -Open source means you are free to view and re-use the source code of Drop (in accordance with it's license). -Drop is also open-contribution, and we encourage technical users to contribute back to the Drop source code, especially if there are features they want that are missing or are planned for later. +Open source means you are free to view and re-use the source code of Drop (in accordance with it's license). + +Drop is also open-contribution, and we encourage technical users to contribute back to the Drop source code, especially if there are features they want that are missing or are planned for later. If you want to start contributing, check out our GitHub: [Drop OSS organization](https://github.com/Drop-OSS). -We also recommend join our Discord: [Drop-OSS invite](https://discord.gg/NHx46XKJWA). However, there is a lot of drama around open-source projects using Discord, so we also encourage using GitHub issues or discussions to ask for support or talk about new features. +We also recommend join our Discord: [Drop-OSS invite](https://discord.gg/NHx46XKJWA). However, there is a lot of drama around open-source projects using Discord, so we also encourage using GitHub issues or discussions to ask for support or talk about new features. ## 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](./guides/client). +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](./guides/getting-started). ## 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. -Instead however, instead of a massive centralized website, each admin runs their own copy, and adds *their own games* to their own copy of Drop. Also, there's no payment processing, nothing has a price. +Instead however, instead of a massive centralized website, each admin runs their own copy, and adds _their own games_ to their own copy of Drop. Also, there's no payment processing, nothing has a price. ## Platform + Drop does a lot more than just game distribution. As of `v0.2.0-beta`, a lot hasn't been implemented. But, in future, Drop will be able to handle things such as: - Dedicated servers - Matchmaking & P2P games - Achievements & items - Cloud saves -- Modding \ No newline at end of file +- Modding + diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 55d85eb..fbfd334 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -86,8 +86,8 @@ const config: Config = { to: "/docs/guides/quickstart", }, { - label: "Client Getting Started", - to: "/docs/guides/client", + label: "Getting Started", + to: "/docs/guides/getting-started", }, ], }, diff --git a/sidebars.ts b/sidebars.ts index c04f903..e5b4a05 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -27,7 +27,7 @@ const sidebars: SidebarsConfig = { { type: "category", label: "User Guides", - items: ["guides/client", "guides/client-troubleshooting"], + items: ["guides/getting-started", "guides/client-troubleshooting"], }, { type: "category", diff --git a/versioned_docs/version-0.3.0/about.md b/versioned_docs/version-0.3.0/about.md index 6ef9844..077d914 100644 --- a/versioned_docs/version-0.3.0/about.md +++ b/versioned_docs/version-0.3.0/about.md @@ -5,29 +5,34 @@ Drop is an open-source, self-hosted game distribution platform. It's designed of Don't know what any of that means? Keep reading. ## Open source -Open source means you are free to view and re-use the source code of Drop (in accordance with it's license). -Drop is also open-contribution, and we encourage technical users to contribute back to the Drop source code, especially if there are features they want that are missing or are planned for later. +Open source means you are free to view and re-use the source code of Drop (in accordance with it's license). + +Drop is also open-contribution, and we encourage technical users to contribute back to the Drop source code, especially if there are features they want that are missing or are planned for later. If you want to start contributing, check out our GitHub: [Drop OSS organization](https://github.com/Drop-OSS). -We also recommend join our Discord: [Drop-OSS invite](https://discord.gg/NHx46XKJWA). However, there is a lot of drama around open-source projects using Discord, so we also encourage using GitHub issues or discussions to ask for support or talk about new features. +We also recommend join our Discord: [Drop-OSS invite](https://discord.gg/NHx46XKJWA). However, there is a lot of drama around open-source projects using Discord, so we also encourage using GitHub issues or discussions to ask for support or talk about new features. ## 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](./guides/client). +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](./guides/getting-started). ## 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. -Instead however, instead of a massive centralized website, each admin runs their own copy, and adds *their own games* to their own copy of Drop. Also, there's no payment processing, nothing has a price. +Instead however, instead of a massive centralized website, each admin runs their own copy, and adds _their own games_ to their own copy of Drop. Also, there's no payment processing, nothing has a price. ## Platform + Drop does a lot more than just game distribution. As of `v0.2.0-beta`, a lot hasn't been implemented. But, in future, Drop will be able to handle things such as: - Dedicated servers - Matchmaking & P2P games - Achievements & items - Cloud saves -- Modding \ No newline at end of file +- Modding + diff --git a/versioned_docs/version-0.3.0/guides/getting-started.md b/versioned_docs/version-0.3.0/guides/getting-started.md index cda0967..3e87f02 100644 --- a/versioned_docs/version-0.3.0/guides/getting-started.md +++ b/versioned_docs/version-0.3.0/guides/getting-started.md @@ -206,11 +206,14 @@ For clients to connect, your Drop instance needs to be accessible: - **Find your server's IP address** - **Update `EXTERNAL_URL`** in your `compose.yaml`: + ```yaml environment: - EXTERNAL_URL=http://[your-drop-server-ip]:3000 ``` + - **Restart the container:** + ```bash docker-compose down && docker-compose up -d ``` @@ -230,7 +233,7 @@ For advanced exposure options, see [Exposing Your Instance](exposing.md). ### User Management - **Create additional users** in the admin interface -- **Set up authentication** - see [Authentication](../authentication/) for OIDC options +- **Set up authentication** - see [Authentication](../authentication/cli) for OIDC options - **Manage permissions** for different user roles ### Library Management diff --git a/versioned_sidebars/version-0.3.0-sidebars.json b/versioned_sidebars/version-0.3.0-sidebars.json index 1157c85..52e03ff 100644 --- a/versioned_sidebars/version-0.3.0-sidebars.json +++ b/versioned_sidebars/version-0.3.0-sidebars.json @@ -12,27 +12,17 @@ { "type": "category", "label": "User Guides", - "items": [ - "guides/client", - "guides/client-troubleshooting" - ] + "items": ["guides/getting-started", "guides/client-troubleshooting"] }, { "type": "category", "label": "Metadata", - "items": [ - "metadata/giantbomb", - "metadata/igdb", - "metadata/pcgamingwiki" - ] + "items": ["metadata/giantbomb", "metadata/igdb", "metadata/pcgamingwiki"] }, { "type": "category", "label": "Authentication", - "items": [ - "authentication/simple", - "authentication/oidc" - ] + "items": ["authentication/simple", "authentication/oidc"] }, { "type": "category", @@ -46,9 +36,7 @@ { "type": "category", "label": "Documentation", - "items": [ - "library" - ] + "items": ["library"] } ] }