Skip to content

Commit

Permalink
Merge PR #69 - Various Updates on Joining StashDB and Other Stash-Boxes
Browse files Browse the repository at this point in the history
Adds guide to joining, expands section on gaining edit access, and updates outdated references throughout
  • Loading branch information
AdultSun authored Mar 10, 2024
2 parents 47fb0fb + 18856ce commit 6c35d3f
Show file tree
Hide file tree
Showing 26 changed files with 194 additions and 79 deletions.
1 change: 1 addition & 0 deletions _includes/invite-code.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
`21e01328-3605-485d-9091-18ed4f7954ee`
2 changes: 1 addition & 1 deletion docs/faq_getting-started/drafts.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ parent: FAQ / Getting Started
### [Submit from Stash](submit-from-stash)

{: .important }
**Can create/update scenes and performers, but be sure to look on StashDB first and to generate PHashes.** *[See more...](submit-from-stash)*
**Can create/update scenes and performers, but be sure to look on StashDB first and to generate pHashes.** *[See more...](submit-from-stash)*
4 changes: 2 additions & 2 deletions docs/faq_getting-started/drafts/submit-from-stash.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ grand_parent: FAQ / Getting Started
# How to Submit Drafts from Stash

{: .important }
**Can create/update scenes and performers, but be sure to look on StashDB first and to generate PHashes.**
**Can create/update scenes and performers, but be sure to look on StashDB first and to generate pHashes.**

---

You can submit drafts from within Stash to do a few different things: create a scene, create a performer, update a matched scene, and update a matched performer. They are called "drafts" because they are not final. You will still have to navigate to the draft in StashDB to double-check the edit, make any needed adjustments, and leave a [helpful comment]({{ site.baseurl }}/docs/faq_getting-started/edits/edit-comments/) before officially submitting it for [approval]({{ site.baseurl }}/docs/faq_getting-started/edits/voting/). Until you click that "Submit" button, the draft is only visible to you. It is also temporary, each draft will expire after 24 hours.

If you'd like to add a scene to StashDB, first make sure you have [PHashes]({{ site.baseurl }}/docs/faq_getting-started/stashdb/whats-a-phash/) generated. It isn't turned on by default so make sure you've taken care of this already. Then, use the [Scene Tagger or the StashDB scraper]({{ site.baseurl }}/docs/faq_getting-started/stashdb/using-stashdb/) to find any PHash matches. Be careful when selecting your match because your scene may be a [remaster, redistribution, or re-release]({{ site.baseurl }}/docs/scenes/create/re-releases/). If your particular release isn't already on StashDB, you can add it yourself with a draft submission after your account is granted [edit rights]({{ site.baseurl }}/docs/faq_getting-started/stashdb/contributing-to-stashdb/).
If you'd like to add a scene to StashDB, first make sure you have [pHashes]({{ site.baseurl }}/docs/faq_getting-started/stashdb/whats-a-phash/) generated. It isn't turned on by default so make sure you've taken care of this already. Then, use the [Scene Tagger or the StashDB scraper]({{ site.baseurl }}/docs/faq_getting-started/stashdb/using-stashdb/) to find any pHash matches. Be careful when selecting your match because your scene may be a [remaster, redistribution, or re-release]({{ site.baseurl }}/docs/scenes/create/re-releases/). If your particular release isn't already on StashDB, you can add it yourself with a draft submission after your account is granted [edit rights]({{ site.baseurl }}/docs/faq_getting-started/stashdb/contributing-to-stashdb/).

From within a scene's details page, click on the three vertical dots in the top right of the details pane and select the "Submit to Stash-Box" option. Clicking the "Submit" button in the resulting dialog box will save a draft to create that scene on StashDB using the information you have saved locally. From the [Drafts](https://stashdb.org/drafts){:target="_blank"} page, you can make any necessary changes, leave an [edit comment]({{ site.baseurl }}/docs/faq_getting-started/edits/edit-comments/), and finally submit your draft to be [approved]({{ site.baseurl }}/docs/faq_getting-started/edits/voting/) just like any other edit.

Expand Down
2 changes: 1 addition & 1 deletion docs/faq_getting-started/edits/asking-for-votes.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ grand_parent: FAQ / Getting Started

---

Typically, asking on Discord for votes to approve your own edit is seen as impolite. Many see it as similar to jumping to the front of the line instead of waiting your turn. There are exceptions to this though. Often edits act as "blockers" to other edits. Maybe someone has a scene they want to add to StashDB, but they need a performer or studio to be approved first before they can be attached to the scene submission. The performer/studio submission is considered a "blocker" to the scene submission, so it would be appropriate to ask in the **#stashdb-general** channel on [Discord]({{ site.baseurl }}/docs/faq_getting-started/stashdb/joining-our-discord/) to expedite its approval. In cases like these, longer approval times actually do inconvenience the contributor where waiting on typical edits would not.
Typically, asking on Discord for votes to approve your own edit is seen as impolite. Many see it as similar to jumping to the front of the line instead of waiting your turn. There are exceptions to this though. Often edits act as "blockers" to other edits. Maybe someone has a scene they want to add to StashDB, but they need a performer or studio to be approved first before they can be attached to the scene submission. The performer/studio submission is considered a "blocker" to the scene submission, so it would be appropriate to ask in the **#stashdb-general** channel on [Discord]({{ site.baseurl }}/docs/faq_getting-started/stashdb/joining-discord-and-matrix/) to expedite its approval. In cases like these, longer approval times actually do inconvenience the contributor where waiting on typical edits would not.
2 changes: 1 addition & 1 deletion docs/faq_getting-started/edits/updating-edits.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ grand_parent: FAQ / Getting Started

You can update your own pending edits once and only once. The button is kind of hidden. You first have to navigate to the page for that individual submission by clicking the heading in the top left of the edit card. It should say something like "Create Scene" or "Modify Performer". You should then see a blue "Update Edit" button at the bottom of the page. You'll then see the edit form in the same state as the current submission. Just remember to leave an additional [edit comment]({{ site.baseurl }}/docs/faq_getting-started/edits/edit-comments/) explaining your new adjustments before clicking "Submit Edit" again. Remember, you can only update each edit exactly once so try not to miss anything. It saves us all the extra time and effort of making additional corrections.

At this time, updating your edit does not reset previously cast votes. This means any "No" votes cast before the update will remain until a "No" voter comes back to change it. The edit's individual page (click the heading) will also show who's voted "Yes" and "No" already. Many users will check back on an edit after downvoting it to see if their requested changes have been made, but you may also contact them [on Discord]({{ site.baseurl }}/docs/faq_getting-started/stashdb/joining-our-discord/) yourself if you're worried about rejection or a long wait time. Their username in StashDB isn't always the same on Discord but a quick search in **#stashdb-invites** should find their request for edit access. Just be polite and respectful while asking them to flip their vote.
At this time, updating your edit does not reset previously cast votes. This means any "No" votes cast before the update will remain until a "No" voter comes back to change it. The edit's individual page (click the heading) will also show who's voted "Yes" and "No" already. Many users will check back on an edit after downvoting it to see if their requested changes have been made, but you may also contact them [on Discord]({{ site.baseurl }}/docs/faq_getting-started/stashdb/joining-discord-and-matrix/) yourself if you're worried about rejection or a long wait time. Their username in StashDB isn't always the same on Discord but a quick search in **#stashdb-invites** should find their request for edit access. Just be polite and respectful while asking them to flip their vote.

If you've already used your one update and still need to change something before your submission can be approved, unfortunately you'll need to [cancel]({{ site.baseurl }}/docs/faq_getting-started/edits/cancelling-edits/) and resubmit it. First click the red "Cancel Edit" button at the bottom of the edit's page. It'll be right next to the blue "Update Edit" button. There is no way to revive a cancelled edit so you'll need start from the beginning again to recreate it.

Expand Down
2 changes: 1 addition & 1 deletion docs/faq_getting-started/scenes.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ parent: FAQ / Getting Started
### [Duplicate Scenes](duplicate-scenes)

{: .important }
**Search using keywords, filters, and PHashes.** *[See more...](duplicate-scenes)*
**Search using keywords, filters, and pHashes.** *[See more...](duplicate-scenes)*


### [Check Performers](check-performers)
Expand Down
4 changes: 2 additions & 2 deletions docs/faq_getting-started/scenes/duplicate-scenes.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ grand_parent: FAQ / Getting Started
# Duplicate Scenes

{: .important }
**Search using keywords, filters, and PHashes.**
**Search using keywords, filters, and pHashes.**

---

Before submitting a scene to StashDB, always check for duplicates first. Duplicates will [likely be rejected or removed]({{ site.baseurl }}/docs/scenes/create/duplicate-scenes/). If you couldn't find a match through Stash's [Scene Tagger]({{ site.baseurl }}/docs/faq_getting-started/stashdb/using-stashdb/), the easiest way to check is to rely on [PHash]({{ site.baseurl }}/docs/faq_getting-started/stashdb/whats-a-phash/) detection when [submitting a draft]({{ site.baseurl }}/docs/faq_getting-started/stashdb/using-stashdb/) to StashDB. Your draft edit will have a warning sign (⚠) at the top if your PHash matches existing scenes in the database. These are not always duplicate scenes and may be due to someone [submitting incorrect fingerprints]({{ site.baseurl }}/docs/faq_getting-started/stashdb/backlog-spreadsheet/). Duplicates may also be found by searching for the title on StashDB or by filtering by studio on a performer's page. Also be aware that even if your scene isn't on StashDB yet, someone could have a pending edit to create the same scene. Best way to check for this is to click the favorite star (⭐) on the relevant studio or performer in your submission and [filter for favorites in pending scene creations](https://stashdb.org/edits?favorite=true&operation=create&status=pending&type=scene){:target="_blank"} on the Edits page.
Before submitting a scene to StashDB, always check for duplicates first. Duplicates will [likely be rejected or removed]({{ site.baseurl }}/docs/scenes/create/duplicate-scenes/). If you couldn't find a match through Stash's [Scene Tagger]({{ site.baseurl }}/docs/faq_getting-started/stashdb/using-stashdb/), the easiest way to check is to rely on [pHash]({{ site.baseurl }}/docs/faq_getting-started/stashdb/whats-a-phash/) detection when [submitting a draft]({{ site.baseurl }}/docs/faq_getting-started/stashdb/using-stashdb/) to StashDB. Your draft edit will have a warning sign (⚠) at the top if your pHash matches existing scenes in the database. These are not always duplicate scenes and may be due to someone [submitting incorrect fingerprints]({{ site.baseurl }}/docs/faq_getting-started/stashdb/backlog-spreadsheet/). Duplicates may also be found by searching for the title on StashDB or by filtering by studio on a performer's page. Also be aware that even if your scene isn't on StashDB yet, someone could have a pending edit to create the same scene. Best way to check for this is to click the favorite star (⭐) on the relevant studio or performer in your submission and [filter for favorites in pending scene creations](https://stashdb.org/edits?favorite=true&operation=create&status=pending&type=scene){:target="_blank"} on the Edits page.
38 changes: 22 additions & 16 deletions docs/faq_getting-started/stashdb.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,52 +29,58 @@ parent: FAQ / Getting Started

***

### [What is StashDB?](what-is-stashdb)
### [Accessing StashDB](accessing-stashdb)

{: .important }
**Our shared database of scene, performer, and studio metadata. Does not host video files or unofficial download links.** *[See more...](what-is-stashdb)*
**Details on joining StashDB and connecting it to Stash.** *[See more...](accessing-stashdb)*


### [What Makes StashDB Better?](what-makes-stashdb-better)
### [Accessing Stash-Boxes](accessing-stash-boxes)

{: .important }
**Full integration with Stash and improved scene matching using various fingerprints (PHashes).** *[See more...](what-makes-stashdb-better)*
**Details on connecting StashDB and others to Stash.** *[See more...](accessing-stash-boxes)*


### [Joining Our Discord](joining-our-discord)
### [Using StashDB](using-stashdb)

{: .important }
**Necessary for accessing StashDB, click link for details.** *[See more...](joining-our-discord)*
**Tagger Views are recommended for pulling info from StashDB, Identify task is faster but less accurate.** *[See more...](using-stashdb)*


### [Accessing Stash-Boxes](accessing-stash-boxes)
### [Contributing to StashDB](contributing-to-stashdb)

{: .important }
**Details on connecting StashDB and others to Stash.** *[See more...](accessing-stash-boxes)*
**Submitting fingerprints is possible with every account but adding/editing anything else requires new permissions, click link for details.** *[See more...](contributing-to-stashdb)*


### [Using StashDB](using-stashdb)
### [Joining Discord and Matrix](joining-discord-and-matrix)

{: .important }
**Tagger Views are recommended for pulling info from StashDB, Identify task is faster but less accurate.** *[See more...](using-stashdb)*
**Necessary for gaining edit access to StashDB, click link for details.** *[See more...](joining-discord-and-matrix)*


### [What is StashDB?](what-is-stashdb)

{: .important }
**Our shared database of scene, performer, and studio metadata. Does not host video files or unofficial download links.** *[See more...](what-is-stashdb)*

### [What's a PHash?](whats-a-phash)

### [What Makes StashDB Better?](what-makes-stashdb-better)

{: .important }
**Perceptual hashes are generated from what a video looks like, allowing for more reliable scene matching with StashDB.** *[See more...](whats-a-phash)*
**Full integration with Stash and improved scene matching using various fingerprints (pHashes).** *[See more...](what-makes-stashdb-better)*


### [What's a StashID?](whats-a-stashid)
### [What's a pHash?](whats-a-phash)

{: .important }
**Unique ID for entries in StashDB, found at the end of URLs and saved to Stash after a match.** *[See more...](whats-a-stashid)*
**Perceptual hashes are generated from what a video looks like, allowing for more reliable scene matching with StashDB.** *[See more...](whats-a-phash)*


### [Contributing to StashDB](contributing-to-stashdb)
### [What's a StashID?](whats-a-stashid)

{: .important }
**Submitting fingerprints is possible with every account but any other edit/submission requires new permissions, details found on Discord pinned to #stashdb-invites.** *[See more...](contributing-to-stashdb)*
**Unique ID for entries in StashDB, found at the end of URLs and saved to Stash after a match.** *[See more...](whats-a-stashid)*


### [Unconfirmed Guidelines](unconfirmed-guidelines)
Expand Down
19 changes: 12 additions & 7 deletions docs/faq_getting-started/stashdb/accessing-stash-boxes.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Accessing Stash-Boxes
nav_order: 4
nav_order: 2
has_toc: true
parent: 'StashDB'
grand_parent: FAQ / Getting Started
Expand All @@ -15,7 +15,9 @@ grand_parent: FAQ / Getting Started

---

Stash-Box is the name of the software developed alongside Stash that StashDB runs on. While StashDB's scope is somewhat limited out of necessity, there are a few other publicly availably Stash-Boxes run by others outside of the Stash team. These other Stash-Boxes are still compatible with Stash. Details for all known public Stash-Boxes (including StashDB) are listed here.
Stash-Box is the name of the software running underneath StashDB. It is developed alongside Stash and allows for more advanced and convenient ways to share data between local collections and these collaborative databases. While StashDB's scope is somewhat limited out of necessity, there are a few other publicly availably Stash-Boxes run by others outside of the Stash team. These other Stash-Boxes are still compatible with Stash. Details for all known public Stash-Boxes (including StashDB) are listed here.

If you need a more detailed walkthrough on how to register an account with one of these Stash-Boxes or how to connect that new account to your local Stash, please read the guide on [Accessing StashDB]({{ site.baseurl }}/docs/faq_getting-started/stashdb/accessing-stashdb/). Many details are specific to StashDB.org, but the process will be very similar for every Stash-Box. You'll just need to check the relevant table below to find your specific Stash-Box's homepage, invite code, and endpoint.

---

Expand Down Expand Up @@ -43,24 +45,27 @@ Stash-Box is the name of the software developed alongside Stash that StashDB run
### Accessing StashDB
{: .no_toc }

1. Grab an invite token from the **#stashdb-invites** channel of our [Discord server](https://discord.com/invite/2TsNFKt){:target="_blank"} <br> *(The pinned messages of this channel also contain detailed instructions.)*
1. Copy this entire invite code: {% include invite-code.txt %}
- This same invite code is also available in the [Accessing StashDB]({{ site.baseurl }}/docs/faq_getting-started/stashdb/accessing-stashdb/) guide along with more detailed instructions for registering an account and connecting it to your Stash.
- Two other codes are available in the [**#stashdb-invites** channel](https://discord.com/channels/559159668438728723/935614155107471442){:target="_blank"} on [Discord](https://discord.com/invite/2TsNFKt){:target="_blank"} and in the [**StashDB - Invites** room topic](https://matrix.to/#/#stashdb-invites:unredacted.org){:target="_blank"} on [Matrix](https://matrix.to/#/#stashapp:unredacted.org){:target="_blank"}
- Please contact **@AdultSun** on Discord or **@DogmaDragon** on Matrix if any of these codes have expired.
1. Register an account at [https://stashdb.org/register](https://stashdb.org/register){:target="_blank"}
1. While logged in, click on your username near the top-right corner and find your API key
1. Navigate in Stash to Settings -> Metadata Providers -> Stash-Box Endpoints, then enter your API token and the GraphQL Endpoint listed above

## ThePornDB

|-|-|
|Homepage|[https://metadataapi.net/](https://metadataapi.net/){:target="_blank"}|
|Endpoint|[https://metadataapi.net/graphql](https://metadataapi.net/graphql){:target="_blank"}|
|Homepage|[https://theporndb.net/](https://theporndb.net/){:target="_blank"}|
|Endpoint|[https://theporndb.net/graphql](https://theporndb.net/graphql){:target="_blank"}|
|Discord|[https://discord.com/invite/XpSGpaB](https://discord.com/invite/XpSGpaB){:target="_blank"}|
|Content|Digital scenes and movies, relying on automated scrapers.|

### Accessing TPDB's Stash-Box
{: .no_toc }

1. Register an account at [https://metadataapi.net/register](https://metadataapi.net/register){:target="_blank"}
1. Generate an API token at [https://metadataapi.net/user/api-tokens](https://metadataapi.net/user/api-tokens){:target="_blank"}
1. Register an account at [https://theporndb.net/register](https://theporndb.net/register){:target="_blank"}
1. Generate an API token at [https://theporndb.net/user/api-tokens](https://theporndb.net/user/api-tokens){:target="_blank"}
1. Navigate in Stash to Settings -> Metadata Providers -> Stash-Box Endpoints, then enter your API token and the GraphQL Endpoint listed above

## PMV Stash
Expand Down
Loading

0 comments on commit 6c35d3f

Please sign in to comment.