From b27bf943b6b8713eccfe21824965894319ca0bf3 Mon Sep 17 00:00:00 2001 From: AdultSun <64123896+AdultSun@users.noreply.github.com> Date: Thu, 7 Mar 2024 14:51:49 -0700 Subject: [PATCH 01/11] Creates new guide for joining and connecting StashDB, including embedded invite code --- .../stashdb/accessing-stashdb.md | 72 +++++++++++++++++++ 1 file changed, 72 insertions(+) create mode 100644 docs/faq_getting-started/stashdb/accessing-stashdb.md diff --git a/docs/faq_getting-started/stashdb/accessing-stashdb.md b/docs/faq_getting-started/stashdb/accessing-stashdb.md new file mode 100644 index 0000000..45df379 --- /dev/null +++ b/docs/faq_getting-started/stashdb/accessing-stashdb.md @@ -0,0 +1,72 @@ +--- +layout: default +title: Accessing StashDB +nav_order: 1 +has_toc: true +parent: 'StashDB' +grand_parent: FAQ / Getting Started +--- + +# Accessing StashDB +{: .no_toc } + +{: .important } +**Details on joining StashDB and connecting it to Stash.** + +--- + +
+ + Table of Contents + + {: .text-delta } +1. TOC +{:toc} +
+ +## Creating an Account +You will need to register an account on StashDB.org before you can view or access any of its data. The process should be fairly straightforward, but here's a step-by-step guide just in case. + +New accounts start with READ access only. If you'd like to add or edit any data on StashDB.org, you will need to [ask for EDIT access]({{ site.baseurl }}/docs/faq_getting-started/stashdb/contributing-to-stashdb/) after creating your account. + +1. **Go to [https://stashdb.org/register](https://stashdb.org/register){:target="_blank"}** +1. **Enter a valid email address** + - This email address will only be visible to StashDB admins. It will not be used as your username. + - Do not forget it, you will need it if you ever need to reset your password. An admin may also ask you to provide this address if you need their help with your account. +1. **Enter an active invite key** + - Copy and paste this entire code into the registration form:
`21e01328-3605-485d-9091-18ed4f7954ee`
It has a limited number of uses so it will be replaced periodically. + - Invite codes will also be pinned to 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"}. + - If any of these codes have expired, please ask politely for it to be refreshed by pinging either **@AdultSun** on Discord or **@DogmaDragon** on Matrix in the appropriate channel/room. A few other elevated users can also generate invite codes if necessary. +1. **Check for an email from StashDB and click the confirmation link** + - Please wait a few minutes for it to arrive. If you still don't see it, try refreshing your inbox or checking your spam/junk folder. + - The link will direct you to a webpage to *choose your username and password for the first time*. This is not a generic login page even though it may look like one. This has confused others before, so just keep going. +1. **Choose your username** + - *Do not* enter your email address as your username here. + - Admins are able to change or lookup your username upon request. + - If you plan on requesting edit access, please make sure your username in StashDB matches your display name in Discord/Matrix. See the [Contributing to StashDB]({{ site.baseurl }}/docs/faq_getting-started/stashdb/contributing-to-stashdb/) page for further details. +1. **Choose your password** + - Must be at least 8 characters long while avoiding "common" passwords. + - Passwords cannot be seen or reset by an admin. You will need to click the "Forgot Password" link on the login page to reset it yourself. +1. **Click the "Create Account" button** +1. **Re-enter your new username and password to log in** + - You will always need to use your *username* to log in, your email address will not work here. + +## Connecting to Stash +In order to pull StashDB's scene, performer, and studio data directly into your local Stash database, you will need to connect your StashDB account to your local Stash installation. This will also allow you to use [generated fingerprints/hashes]({{ site.baseurl }}/docs/faq_getting-started/stashdb/whats-a-phash/) to match your local videos with their entries on StashDB. Our [Guide to Scraping](https://docs.stashapp.cc/beginner-guides/guide-to-scraping/){:target="_blank"} will walk you through how to do all of that after you've connected StashDB to your Stash. + +The process below can also be used to link other Stash-Box accounts to your Stash. You'll just need to swap out StashDB's info with the relevant details specific to the Stash-Box you'd like to connect. Those details are listed for several available Stash-Boxes in the [Accessing Stash-Boxes]({{ site.baseurl }}/docs/faq_getting-started/stashdb/accessing-stash-boxes/) page. + +1. **Find your unique API key for StashDB** + 1. Log into [StashDB.org](https://stashdb.org/){:target="_blank"} + 1. Click on your username at the top, next to the generic user icon + 1. Copy the entire API key +1. **Find your saved Stash-Boxes in Stash** + 1. Go to the "Settings" page in Stash
*(Located at [http://localhost:9999/settings](http://localhost:9999/settings){:target="_blank"} by default)* + 1. Click "Metadata Providers" on the left side + 1. Find "Stash-box Endpoints" at the top +1. **Add StashDB to your saved Stash-Boxes** + 1. Click the "Add" button + 1. Paste your API key + 1. Enter `StashDB.org` as the "Name"
*(Or use whatever else you want StashDB to be listed as, it doesn't need to be exactly the same.)* + 1. Enter `https://stashdb.org/graphql` as the endpoint + 1. Click the "Confirm" button From 7cbbc5288f9c177096fb454b5c3729caeea2539f Mon Sep 17 00:00:00 2001 From: AdultSun <64123896+AdultSun@users.noreply.github.com> Date: Thu, 7 Mar 2024 14:53:06 -0700 Subject: [PATCH 02/11] Replaces outdated details in Stash-Box tables for StashDB and TPDB --- .../stashdb/accessing-stash-boxes.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/faq_getting-started/stashdb/accessing-stash-boxes.md b/docs/faq_getting-started/stashdb/accessing-stash-boxes.md index ebab08f..681b37c 100644 --- a/docs/faq_getting-started/stashdb/accessing-stash-boxes.md +++ b/docs/faq_getting-started/stashdb/accessing-stash-boxes.md @@ -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 @@ -17,6 +17,8 @@ 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. +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. + ---
@@ -42,7 +44,7 @@ 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"}
*(The pinned messages of this channel also contain detailed instructions.)* +1. Grab an invite token from the [Accessing StashDB]({{ site.baseurl }}/docs/faq_getting-started/stashdb/accessing-stashdb/) guide, the [**#stashdb-invites** channel](https://discord.com/channels/559159668438728723/935614155107471442){:target="_blank"} on [Discord](https://discord.com/invite/2TsNFKt){:target="_blank"}, or 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"}
*(The guide page also contains more detailed instructions for registering an account and connecting it to your Stash.)* 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 @@ -50,16 +52,16 @@ Stash-Box is the name of the software developed alongside Stash that StashDB run ## 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 From edd195d11e83551fc1d35260fb9974a212a66fb7 Mon Sep 17 00:00:00 2001 From: AdultSun <64123896+AdultSun@users.noreply.github.com> Date: Thu, 7 Mar 2024 14:53:59 -0700 Subject: [PATCH 03/11] Updates and renames Discord page to include Matrix details --- .../stashdb/joining-discord-and-matrix.md | 32 +++++++++++++++++++ .../stashdb/joining-our-discord.md | 18 ----------- 2 files changed, 32 insertions(+), 18 deletions(-) create mode 100644 docs/faq_getting-started/stashdb/joining-discord-and-matrix.md delete mode 100644 docs/faq_getting-started/stashdb/joining-our-discord.md diff --git a/docs/faq_getting-started/stashdb/joining-discord-and-matrix.md b/docs/faq_getting-started/stashdb/joining-discord-and-matrix.md new file mode 100644 index 0000000..9ff7244 --- /dev/null +++ b/docs/faq_getting-started/stashdb/joining-discord-and-matrix.md @@ -0,0 +1,32 @@ +--- +layout: default +title: Joining Discord and Matrix +nav_order: 5 +parent: 'StashDB' +grand_parent: FAQ / Getting Started +--- + +# Joining Discord and Matrix + +{: .important } +**Necessary for gaining edit access to StashDB, read below for details.** + +--- + +All members of Stash's Discord and Matrix are expected to follow the servers' rules. These rules exist to foster a respectful community and ensure the longevity of the Stash project. The Discord rules are listed in our [**#readme** channel](https://discord.com/channels/559159668438728723/819802026988273674){:target="_blank"} and the Matrix rules are listed in our [Stash space](https://matrix.to/#/#stashapp:unredacted.org){:target="_blank"}. + +Please note, you will need to join at least one of these servers if you would like to [contribute more than just hashes to StashDB]({{ site.baseurl }}/docs/faq_getting-started/stashdb/contributing-to-stashdb/). Most of the editors are using Discord so that's likely the most convenient option. All active editors are required to be reachable through one or the other. If there is an issue with your contributions and we cannot get in touch with you to address them, you will risk [losing your edit access]({{ site.baseurl }}/docs/faq_getting-started/edits/moderation-enforcement/). + +## Discord + +The Stash Discord server is your best bet for finding someone to help you with anything relating to Stash, Stash-Box, and StashDB. It has far more members than the Matrix space, but we have a bot that allows those Matrix users to communicate with users on Discord (see details below). That bot has limitations and can be buggy at times, so using Discord instead will likely be a smoother experience. + +[Click here to join our Discord server.](https://discord.gg/2TsNFKt){:target="_blank"} + +## Matrix + +Matrix is a federated alternative to Discord. If you are unfamiliar with it, [this page explains in more detail what Matrix is](https://docs.stashapp.cc/matrix/){:target="_blank"}. Some users prefer to use Matrix to avoid the privacy concerns and additional restrictions inherent to Discord. + +Many of Stash's rooms on Matrix are marked as "bridged". Posts in these Matrix rooms will be automatically mirrored in their equivalent channel on Discord and vice versa. That means the smaller number of Matrix users can communicate with the larger number of users on Discord, but the bot his its own limitations and bugs. It also means those Matrix rooms are required to follow the same restrictions enforced by Discord. However, we also have a room named [**General (unbridged)**](https://matrix.to/#/#stash-general-unbridged:unredacted.org) that is exclusive to Matrix and outside of Discord's influence. + +[Click here to join our Matrix space.](https://matrix.to/#/#stashapp:unredacted.org){:target="_blank"} diff --git a/docs/faq_getting-started/stashdb/joining-our-discord.md b/docs/faq_getting-started/stashdb/joining-our-discord.md deleted file mode 100644 index 8d13075..0000000 --- a/docs/faq_getting-started/stashdb/joining-our-discord.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: default -title: Joining Our Discord -nav_order: 3 -parent: 'StashDB' -grand_parent: FAQ / Getting Started ---- - -# Joining Our Discord - -{: .important } -**Necessary for accessing StashDB, click link for details.** - ---- - -The Stash Discord server is your best bet for finding help and resources relating to Stash, Stash-Box, and StashDB. You will need to have a Discord account and join our server in order to [access StashDB]({{ site.baseurl }}/docs/faq_getting-started/stashdb/accessing-stash-boxes/). You could create a temporary throwaway account on Discord for this purpose if you'd like. However, if you would like to [contribute more than just hashes to StashDB]({{ site.baseurl }}/docs/faq_getting-started/stashdb/contributing-to-stashdb/), you will also be expected to be reachable on Discord. If you've already joined, the link is in the sidebar to the left. - -[Click here to join our Discord server.](https://discord.gg/2TsNFKt){:target="_blank"} From eb97fd1b657e37f803093578718da118d6525254 Mon Sep 17 00:00:00 2001 From: AdultSun <64123896+AdultSun@users.noreply.github.com> Date: Thu, 7 Mar 2024 14:56:51 -0700 Subject: [PATCH 04/11] Expands on how to get edit access in the docs instead of redirecting to Discord for details --- .../stashdb/contributing-to-stashdb.md | 23 +++++++++++++++---- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/docs/faq_getting-started/stashdb/contributing-to-stashdb.md b/docs/faq_getting-started/stashdb/contributing-to-stashdb.md index 6badd74..292ae58 100644 --- a/docs/faq_getting-started/stashdb/contributing-to-stashdb.md +++ b/docs/faq_getting-started/stashdb/contributing-to-stashdb.md @@ -1,7 +1,7 @@ --- layout: default title: Contributing to StashDB -nav_order: 8 +nav_order: 4 parent: 'StashDB' grand_parent: FAQ / Getting Started --- @@ -9,12 +9,25 @@ grand_parent: FAQ / Getting Started # Contributing to StashDB {: .important } -**Submitting fingerprints is possible with every account but any other edit/submission requires new permissions, details found on Discord pinned to #stashdb-invites.** +**Submitting fingerprints is possible with every account but adding/editing anything else requires new permissions, read below for details.** --- -Every StashDB account is able to [submit fingerprints/hashes]({{ site.baseurl }}/docs/faq_getting-started/stashdb/whats-a-phash/) from within the [Scene Tagger](https://docs.stashapp.cc/beginner-guides/guide-to-scraping/#use-the-scene-tagger){:target="_blank"} view of Stash. This does not require any additional permissions. However, if you would like to add or edit performers, scenes, studios, or tags, you will need to be granted additional privileges. Requesting edit access is not difficult. Detailed instructions can be found pinned to the **#stashdb-invites** channel on [Discord]({{ site.baseurl }}/docs/faq_getting-started/stashdb/joining-our-discord/). +Every StashDB account is able to [submit fingerprints/hashes]({{ site.baseurl }}/docs/faq_getting-started/stashdb/whats-a-phash/) from within the [Scene Tagger](https://docs.stashapp.cc/beginner-guides/guide-to-scraping/#use-the-scene-tagger){:target="_blank"} view of Stash. This does not require any additional permissions. However, if you would like to add or edit any scenes/performers/studios/tags, you will need to be granted additional privileges. Keep reading to learn how to gain edit access to StashDB. -Please note that you will be expected to be reachable on Discord/Matrix if you become an active contributor on StashDB. This is because the comment system is limited with no direct messaging or notification system from within StashDB at this time. We also ask that you [change your nickname](https://support.discord.com/hc/en-us/articles/219070107-Server-Nicknames){:target="_blank"} on our Discord server to match your StashDB username. It makes it easier for other editors to find you in case there are any questions or issues. It also won't change your username or display name outside of Stash's Discord. If you would like to change your StashDB username instead, please contact **@AdultSun** on Discord. +{: .warning } +**Please read the following sections carefully. Failing to follow these instructions may result in delays, rejections, or the loss of future editing privileges.** -If we cannot reach you through comments or Discord/Matrix messages, your [edit rights may be revoked]({{ site.baseurl }}/docs/faq_getting-started/edits/moderation-enforcement/) by an admin after repeated violations of our guidelines. +First, make sure you **make an account on StashDB.org** if you haven't already. We can't apply the EDIT role to an account that doesn't exist yet. Please see our guide to [Accessing StashDB]({{ site.baseurl }}/docs/faq_getting-started/stashdb/accessing-stashdb/) if you need any help finding an invite code, registering an account, or connecting it to Stash. + +You will also be **required to join either Discord or Matrix**. All active editors must be reachable through one or the other. This is because we have a limited comment system at this time with no direct messaging or notifications from within StashDB (this is currently being worked on so stay tuned for future updates). The [Joining Discord and Matrix]({{ site.baseurl }}/docs/faq_getting-started/stashdb/joining-discord-and-matrix/) page includes invite links for both servers and explains a few of the differences between them. + +**For Discord users**, we require your nickname in our server to match your StashDB username. It makes it easier for other editors to find you in case there are any questions or issues. You can either [go to your user settings](https://support.discord.com/hc/en-us/articles/219070107-Server-Nicknames){:target="_blank"} or type the shortcut `/nick ` into any channel of Stash's Discord server. This will not change your username or display name outside of Stash's Discord. You can also request an admin to change your StashDB username instead (see below). + +**For Matrix users**, we require your display name to match your StashDB username. It makes it easier for other editors to find you in case there are any questions or issues. The process will be slightly different depending on which client you're using. However, this will change your display name for your entire account and not just for Stash's rooms. You can also request an admin to change your StashDB username instead (see below). + +If you would like to **change your StashDB username**, please contact a StashDB admin on Discord/Matrix (preferably **@AdultSun** on Discord). You may be asked to DM the email address you used to join StashDB in order for the admin to verify your account. An admin may also ask you to pick a new username before granting edit access if there is any concern about your current username. + +If we cannot reach you through StashDB comments, Discord, or Matrix, **your [edit rights may be revoked by an admin]({{ site.baseurl }}/docs/faq_getting-started/edits/moderation-enforcement/) after repeated violations of our guidelines**. But don't worry about memorizing all of the guidelines right away. Just try to start slowly with a few submissions at a time, watch for comments or messages on Discord/Matrix, and [update your edits]({{ site.baseurl }}/docs/faq_getting-started/edits/updating-edits/) when necessary. You can also ask in the **#stashdb-general** channels on Discord/Matrix if you have any questions. + +Requesting edit access is not difficult. **After you've read and followed all of the instructions above**, politely ask for edit access in the [**#stashdb-invites** channel on Discord](https://discord.com/channels/559159668438728723/935614155107471442){:target="_blank"} or in the [**StashDB - Invites** room on Matrix](https://matrix.to/#/#stashdb-invites:unredacted.org){:target="_blank"}, provide your StashDB username, and wait patiently. Once an admin has granted edit access, they will respond with a thumbs up 👍 react or (occasionally) a direct reply. This shouldn't take any longer than a day or two and will often happen much sooner. If you fail to follow any of these instructions, someone will direct you back to this webpage and you must try again. From 5979c7d63e9581b8befe08ffa05c46dc067b47d5 Mon Sep 17 00:00:00 2001 From: AdultSun <64123896+AdultSun@users.noreply.github.com> Date: Thu, 7 Mar 2024 14:59:10 -0700 Subject: [PATCH 05/11] Reorders StashDB FAQ folder and updates its summary page, plus minor fixes throughout --- docs/faq_getting-started/drafts.md | 2 +- .../drafts/submit-from-stash.md | 4 +- .../edits/asking-for-votes.md | 2 +- .../edits/updating-edits.md | 2 +- docs/faq_getting-started/scenes.md | 2 +- .../scenes/duplicate-scenes.md | 4 +- docs/faq_getting-started/stashdb.md | 38 +++++++++++-------- .../stashdb/ad-blockers.md | 2 +- .../stashdb/backlog-spreadsheet.md | 2 +- .../stashdb/guideline-proposals.md | 4 +- .../stashdb/unconfirmed-guidelines.md | 4 +- .../stashdb/using-stashdb.md | 10 +++-- .../stashdb/what-is-stashdb.md | 4 +- .../stashdb/what-makes-stashdb-better.md | 4 +- .../stashdb/whats-a-phash.md | 10 ++--- .../stashdb/whats-a-stashid.md | 2 +- docs/index.md | 4 +- .../edit/scene-tags/picking-scene-tags.md | 2 +- .../tag-category/assigning-tag-categories.md | 2 +- docs/tags/merge/merging-sorted-tags.md | 2 +- 20 files changed, 57 insertions(+), 49 deletions(-) diff --git a/docs/faq_getting-started/drafts.md b/docs/faq_getting-started/drafts.md index cb7e648..e59fa53 100644 --- a/docs/faq_getting-started/drafts.md +++ b/docs/faq_getting-started/drafts.md @@ -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)* diff --git a/docs/faq_getting-started/drafts/submit-from-stash.md b/docs/faq_getting-started/drafts/submit-from-stash.md index 1180962..300cf55 100644 --- a/docs/faq_getting-started/drafts/submit-from-stash.md +++ b/docs/faq_getting-started/drafts/submit-from-stash.md @@ -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. diff --git a/docs/faq_getting-started/edits/asking-for-votes.md b/docs/faq_getting-started/edits/asking-for-votes.md index 3290c09..f1b9526 100644 --- a/docs/faq_getting-started/edits/asking-for-votes.md +++ b/docs/faq_getting-started/edits/asking-for-votes.md @@ -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. diff --git a/docs/faq_getting-started/edits/updating-edits.md b/docs/faq_getting-started/edits/updating-edits.md index e3b43dc..85dbaa4 100644 --- a/docs/faq_getting-started/edits/updating-edits.md +++ b/docs/faq_getting-started/edits/updating-edits.md @@ -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. diff --git a/docs/faq_getting-started/scenes.md b/docs/faq_getting-started/scenes.md index 409c28e..084a10b 100644 --- a/docs/faq_getting-started/scenes.md +++ b/docs/faq_getting-started/scenes.md @@ -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) diff --git a/docs/faq_getting-started/scenes/duplicate-scenes.md b/docs/faq_getting-started/scenes/duplicate-scenes.md index 88eb895..1c4dea0 100644 --- a/docs/faq_getting-started/scenes/duplicate-scenes.md +++ b/docs/faq_getting-started/scenes/duplicate-scenes.md @@ -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. diff --git a/docs/faq_getting-started/stashdb.md b/docs/faq_getting-started/stashdb.md index afca12c..aef92ad 100644 --- a/docs/faq_getting-started/stashdb.md +++ b/docs/faq_getting-started/stashdb.md @@ -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) diff --git a/docs/faq_getting-started/stashdb/ad-blockers.md b/docs/faq_getting-started/stashdb/ad-blockers.md index 7475c14..71d091d 100644 --- a/docs/faq_getting-started/stashdb/ad-blockers.md +++ b/docs/faq_getting-started/stashdb/ad-blockers.md @@ -1,7 +1,7 @@ --- layout: default title: Ad Blockers -nav_order: 12 +nav_order: 13 parent: 'StashDB' grand_parent: FAQ / Getting Started --- diff --git a/docs/faq_getting-started/stashdb/backlog-spreadsheet.md b/docs/faq_getting-started/stashdb/backlog-spreadsheet.md index 5fdd0e3..f7963af 100644 --- a/docs/faq_getting-started/stashdb/backlog-spreadsheet.md +++ b/docs/faq_getting-started/stashdb/backlog-spreadsheet.md @@ -1,7 +1,7 @@ --- layout: default title: Backlog Spreadsheet -nav_order: 11 +nav_order: 12 parent: 'StashDB' grand_parent: FAQ / Getting Started --- diff --git a/docs/faq_getting-started/stashdb/guideline-proposals.md b/docs/faq_getting-started/stashdb/guideline-proposals.md index 00737b6..93ba7a6 100644 --- a/docs/faq_getting-started/stashdb/guideline-proposals.md +++ b/docs/faq_getting-started/stashdb/guideline-proposals.md @@ -1,7 +1,7 @@ --- layout: default title: Guideline Proposals -nav_order: 10 +nav_order: 11 parent: 'StashDB' grand_parent: FAQ / Getting Started --- @@ -13,4 +13,4 @@ grand_parent: FAQ / Getting Started --- -If you would like to make a change or addition to the guidelines in this website, please ask about your idea in our **#ministry-of-truth** channel on [Discord]({{ site.baseurl }}/docs/faq_getting-started/stashdb/joining-our-discord/) first. If your suggestion gains traction there, a formal proposal will need to be approved by the community in the **#stashdb-guidelines** channel. Only users with elevated Discord roles will be able to post proposals there. +If you would like to make a change or addition to the guidelines in this website, please ask about your idea in our **#ministry-of-truth** channel on [Discord]({{ site.baseurl }}/docs/faq_getting-started/stashdb/joining-discord-and-matrix/) first. If your suggestion gains traction there, a formal proposal will need to be approved by the community in the **#stashdb-guidelines** channel. Only users with elevated Discord roles will be able to post proposals there. diff --git a/docs/faq_getting-started/stashdb/unconfirmed-guidelines.md b/docs/faq_getting-started/stashdb/unconfirmed-guidelines.md index 9840231..e8f6b56 100644 --- a/docs/faq_getting-started/stashdb/unconfirmed-guidelines.md +++ b/docs/faq_getting-started/stashdb/unconfirmed-guidelines.md @@ -1,7 +1,7 @@ --- layout: default title: Unconfirmed Guidelines -nav_order: 9 +nav_order: 10 parent: 'StashDB' grand_parent: FAQ / Getting Started --- @@ -18,6 +18,6 @@ Early on, many of this website's sections will have this message at the bottom: {: .note } Unconfirmed guideline, subject to change pending formal approval. -This just means the language has not been formally approved by the community in our **#stashdb-guidelines** channel on [Discord]({{ site.baseurl }}/docs/faq_getting-started/stashdb/joining-our-discord/) yet. Each one represents a working consensus developed organically between contributors over time. +This just means the language has not been formally approved by the community in our **#stashdb-guidelines** channel on [Discord]({{ site.baseurl }}/docs/faq_getting-started/stashdb/joining-discord-and-matrix/) yet. Each one represents a working consensus developed organically between contributors over time. Contributors are still expected to follow these unconfirmed guidelines, but should know that they are subject to change in the near future. Continually violating them may still result in the [removal of edit access]({{ site.baseurl }}/docs/faq_getting-started/edits/moderation-enforcement/). diff --git a/docs/faq_getting-started/stashdb/using-stashdb.md b/docs/faq_getting-started/stashdb/using-stashdb.md index 41fe368..74e1b08 100644 --- a/docs/faq_getting-started/stashdb/using-stashdb.md +++ b/docs/faq_getting-started/stashdb/using-stashdb.md @@ -1,7 +1,7 @@ --- layout: default title: Using StashDB -nav_order: 5 +nav_order: 3 parent: 'StashDB' grand_parent: FAQ / Getting Started --- @@ -13,10 +13,12 @@ grand_parent: FAQ / Getting Started --- -The recommended method for pulling information from StashDB into your local Stash is through the Tagger view. The Tagger can be found on both the Scenes page and the Performers page by clicking on the double-label icon on the far right end of the toolbar near the top of the webpage. With the [Scene Tagger](https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/Tagger.md){:target="_blank"}, you can match your scenes with StashDB entries by keyword or fingerprint, save that information to your scene including a link to StashDB called the StashID, and submit your fingerprints back to StashDB to help other users match their own scenes. Be sure to check out the "Scrape All" button (limited to one page at a time), the green checkmarks to customize which fields to overwrite, and the gear icon for additional settings. If you've already found your scene's entry on StashDB, you can paste the [StashID]({{ site.baseurl }}/docs/faq_getting-started/stashdb/whats-a-stashid/) directly into the "Query" field to ensure an accurate match. New users may find [this guide to scraping](https://docs.stashapp.cc/beginner-guides/guide-to-scraping/){:target="_blank"} helpful, featuring a detailed step-by-step walkthrough with screenshots. Stash's in-app manual also has a shorter rundown of its features, found by clicking the "?" icon in the top right corner of Stash or at [this link here](https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/Tagger.md){:target="_blank"}. +The recommended method for pulling information from StashDB into your local Stash is through the Tagger view. The Tagger can be found on both the Scenes page and the Performers page by clicking on the double-label icon on the far right end of the toolbar near the top of the webpage. + +With the [Scene Tagger](https://docs.stashapp.cc/in-app-manual/tagger/){:target="_blank"}, you can match your scenes with StashDB entries by keyword or fingerprint, save that information to your scene including a link to StashDB called the StashID, and submit your fingerprints back to StashDB to help other users match their own scenes. Be sure to check out the "Scrape All" button (limited to one page at a time), the green checkmarks to customize which fields to overwrite, and the gear icon for additional settings. If you've already found your scene's entry on StashDB, you can paste the [StashID]({{ site.baseurl }}/docs/faq_getting-started/stashdb/whats-a-stashid/) directly into the "Query" field to ensure an accurate match. New users may find our [Guide to Scraping](https://docs.stashapp.cc/beginner-guides/guide-to-scraping/){:target="_blank"} helpful, featuring a detailed step-by-step walkthrough with screenshots. Stash's in-app manual also has a shorter rundown of its features, found by clicking the "?" icon in the top right corner of Stash or at [this link here](https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/Tagger.md){:target="_blank"}. The Performer Tagger works similarly. Don't miss the "Batch Add Performers" and "Batch Update Performers" buttons on the top right, with a "Show Configuration" link on the opposite side. You can still paste the [StashID]({{ site.baseurl }}/docs/faq_getting-started/stashdb/whats-a-stashid/) directly into the search field if you've found the correct performer entry on StashDB already. Individual fields can be turned on and off for each scrape as well. -The [Identify](https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Manual/Identify.md){:target="_blank"} task can also pull scene info from StashDB. You can customize your settings beforehand, but this is a hands-off automated function unlike the Tagger views. There's no way to verify a match is correct before its info is saved locally. Because of this lack of manual verification, it does not submit your fingerprints to StashDB during this process. The Scene Tagger is still the only way to do this. +The [Identify](https://docs.stashapp.cc/in-app-manual/tasks/identify/){:target="_blank"} task can also pull scene info from StashDB, but it is not recommended for new users at this time. This is considered an advanced feature of Stash and will be hidden behind the "Advanced Mode" toggle in the settings page. You can customize your settings beforehand, but Identify is a hands-off function unlike the Tagger views. There's no way to verify a match is correct before its info is saved locally. It is highly recommended to **back up your database before running Identify** in case you need to revert any unintended changes. Because of the lack of manual verification, it also does not submit your fingerprints to StashDB during this process. The Scene Tagger is still the only way to do that. -Finally, if you have [edit access]({{ site.baseurl }}/docs/faq_getting-started/stashdb/contributing-to-stashdb/), you can add scenes, update scenes, and add performers to StashDB by submitting drafts directly from within Stash. See [this section]({{ site.baseurl }}/docs/faq_getting-started/drafts/submit-from-stash/) for more details on how to submit drafts. +Finally, if you have [edit access]({{ site.baseurl }}/docs/faq_getting-started/stashdb/contributing-to-stashdb/), you can add/update scenes and performers to StashDB by submitting drafts directly from within Stash. See [this section]({{ site.baseurl }}/docs/faq_getting-started/drafts/submit-from-stash/) for more details on how to submit drafts. diff --git a/docs/faq_getting-started/stashdb/what-is-stashdb.md b/docs/faq_getting-started/stashdb/what-is-stashdb.md index a7ac596..16b0458 100644 --- a/docs/faq_getting-started/stashdb/what-is-stashdb.md +++ b/docs/faq_getting-started/stashdb/what-is-stashdb.md @@ -1,7 +1,7 @@ --- layout: default title: What is StashDB? -nav_order: 1 +nav_order: 6 parent: 'StashDB' grand_parent: FAQ / Getting Started --- @@ -13,4 +13,4 @@ grand_parent: FAQ / Getting Started --- -StashDB is our shared public instance of the Stash-Box software. It hosts information about a wide variety of scenes, studios, and performers that can be easily pulled into your own installation of Stash. It does not host any video files or link to any unofficial downloads. Very few users will have reason to host or install a Stash-Box instance themselves, so if you're confused by the terminology just focus on [linking StashDB to your local installation of Stash]({{ site.baseurl }}/docs/faq_getting-started/stashdb/accessing-stash-boxes/). Detailed instructions for connecting to StashDB can be found in the pinned messages of our **#stashdb-invites** channel on [Discord]({{ site.baseurl }}/docs/faq_getting-started/stashdb/joining-our-discord/). +StashDB is our shared public instance of the Stash-Box software. It hosts information about a wide variety of scenes, studios, and performers that can be easily pulled into your own installation of Stash. It does not host any video files or link to any unofficial downloads. Very few users will have reason to host or install a Stash-Box instance themselves, so if you're confused by the terminology just focus on [linking StashDB to your local installation of Stash]({{ site.baseurl }}/docs/faq_getting-started/stashdb/accessing-stash-boxes/). Detailed instructions for connecting to StashDB can be found in the pinned messages of our **#stashdb-invites** channel on [Discord]({{ site.baseurl }}/docs/faq_getting-started/stashdb/joining-discord-and-matrix/). diff --git a/docs/faq_getting-started/stashdb/what-makes-stashdb-better.md b/docs/faq_getting-started/stashdb/what-makes-stashdb-better.md index 7604373..b8901d4 100644 --- a/docs/faq_getting-started/stashdb/what-makes-stashdb-better.md +++ b/docs/faq_getting-started/stashdb/what-makes-stashdb-better.md @@ -1,7 +1,7 @@ --- layout: default title: What Makes StashDB Better? -nav_order: 2 +nav_order: 7 parent: 'StashDB' grand_parent: FAQ / Getting Started --- @@ -9,7 +9,7 @@ grand_parent: FAQ / Getting Started # What Makes StashDB Better? {: .important } -**Full integration with Stash and improved scene matching using various fingerprints (PHashes).** +**Full integration with Stash and improved scene matching using various fingerprints (pHashes).** --- diff --git a/docs/faq_getting-started/stashdb/whats-a-phash.md b/docs/faq_getting-started/stashdb/whats-a-phash.md index 72cda03..fde5963 100644 --- a/docs/faq_getting-started/stashdb/whats-a-phash.md +++ b/docs/faq_getting-started/stashdb/whats-a-phash.md @@ -1,18 +1,18 @@ --- layout: default -title: What's a PHash? -nav_order: 6 +title: What's a pHash? +nav_order: 8 parent: 'StashDB' grand_parent: FAQ / Getting Started --- -# What's a PHash? +# What's a pHash? {: .important } **Perceptual hashes are generated from what a video looks like, allowing for more reliable scene matching with StashDB.** --- -[Perceptual hashes](https://hackerfactor.com/blog/index.php%3F/archives/432-Looks-Like-It.html){:target="_blank"} (PHashes) are one of the main reasons why we [recommend using StashDB]({{ site.baseurl }}/docs/faq_getting-started/stashdb/what-makes-stashdb-better/) with Stash. PHashes are used to match your video files with scene entries on StashDB. Even files of differing resolutions, encodes, or download sources will often be similar enough to still match with StashDB. In other words, your files and their hashes don't have to be exact matches with the fingerprints on StashDB. Stash will be able to find matches as long as your video _looks just similar enough_ to somebody else's fingerprint submission. This level of fuzzy matching makes our system much more reliable, flexible, and versatile than alternative approaches. PHashes can also be used in Stash to detect duplicate files in your library, using the "Scene Duplicate Checker" in the "Tools" tab of the Settings page. +[Perceptual hashes](https://hackerfactor.com/blog/index.php%3F/archives/432-Looks-Like-It.html){:target="_blank"} (pHashes) are one of the main reasons why we [recommend using StashDB]({{ site.baseurl }}/docs/faq_getting-started/stashdb/what-makes-stashdb-better/) with Stash. pHashes are used to match your video files with scene entries on StashDB. Even files of differing resolutions, encodes, or download sources will often be similar enough to still match with StashDB. In other words, your files and their hashes don't have to be exact matches with the fingerprints on StashDB. Stash will be able to find matches as long as your video _looks just similar enough_ to somebody else's fingerprint submission. This level of fuzzy matching makes our system much more reliable, flexible, and versatile than alternative approaches. pHashes can also be used in Stash to detect duplicate files in your library, using the "Scene Duplicate Checker" in the "Tools" tab of the Settings page. -PHashes are not generated in Stash by default, so you will need to create them yourself. They may be generated during a Scan by activating the switch next to "Generate perceptual hashes" or through the Generate task (in the "Tasks" tab of the Settings page or the "Generate..." option with individual scenes selected) next to "Perceptual hashes (for deduplication)". These may be submitted to existing scenes on StashDB along with other fingerprints using the [Scene Tagger]({{ site.baseurl }}/docs/faq_getting-started/stashdb/using-stashdb/) and will be included automatically when [submitting new scenes via draft]({{ site.baseurl }}/docs/faq_getting-started/stashdb/using-stashdb/). +pHashes are not generated in Stash by default, so you will need to create them yourself. They may be generated during a Scan by activating the switch next to "Generate perceptual hashes" or through the Generate task (in the "Tasks" tab of the Settings page or the "Generate..." option with individual scenes selected) next to "Perceptual hashes (for deduplication)". These may be submitted to existing scenes on StashDB along with other fingerprints using the [Scene Tagger]({{ site.baseurl }}/docs/faq_getting-started/stashdb/using-stashdb/) and will be included automatically when [submitting new scenes via draft]({{ site.baseurl }}/docs/faq_getting-started/stashdb/using-stashdb/). diff --git a/docs/faq_getting-started/stashdb/whats-a-stashid.md b/docs/faq_getting-started/stashdb/whats-a-stashid.md index 3599217..b4cf0b2 100644 --- a/docs/faq_getting-started/stashdb/whats-a-stashid.md +++ b/docs/faq_getting-started/stashdb/whats-a-stashid.md @@ -1,7 +1,7 @@ --- layout: default title: What's a StashID? -nav_order: 7 +nav_order: 9 parent: 'StashDB' grand_parent: FAQ / Getting Started --- diff --git a/docs/index.md b/docs/index.md index fbf16f5..d50f3bb 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,7 +9,7 @@ permalink: / {: .no_toc } **Welcome to the StashDB Guidelines!** -This will serve as a guide and reference document for all contributors to StashDB. It hosts both [tips]({{ site.baseurl }}/docs/faq_getting-started/) for new contributors as well as the guidelines themselves. Being familiar with both will help in getting your edits approved. If something is missing or doesn't make sense, please ask in either **#stashdb-general** or the **#ministry-of-truth** on [Discord]({{ site.baseurl }}/docs/faq_getting-started/stashdb/joining-our-discord/). +This will serve as a guide and reference document for all contributors to StashDB. It hosts both [tips]({{ site.baseurl }}/docs/faq_getting-started/) for new contributors as well as the guidelines themselves. Being familiar with both will help in getting your edits approved. If something is missing or doesn't make sense, please ask in either **#stashdb-general** or the **#ministry-of-truth** on [Discord]({{ site.baseurl }}/docs/faq_getting-started/stashdb/joining-discord-and-matrix/). This website is very much a work in progress at this time so watch for significant updates in the coming days. It is hosted with GitHub Pages, so please direct any suggestions for improving this website to the [StashDB-Docs repo](https://github.com/stashapp/StashDB-Docs){:target="_blank"} as a PR or Issue. Feel free to contact **@AdultSun** on Discord with any suggestions as well. @@ -37,7 +37,7 @@ Some of the content not currently allowed on StashDB can be found on other publi ## **New Contributors** For anyone who wants to browse or pull data from StashDB, you will first need to create a StashDB account using an invite token. Instructions found [here]({{ site.baseurl }}/docs/faq_getting-started/stashdb/accessing-stash-boxes/#stashdb). New accounts will be limited to read-only access, but will still be able to [submit fingerprints]({{ site.baseurl }}/docs/faq_getting-started/stashdb/whats-a-phash/) back to StashDB to help others find matches for their files. -In order to fix incorrect info or add missing data, your account will need to be granted edit access. More information can be found [here]({{ site.baseurl }}/docs/faq_getting-started/stashdb/contributing-to-stashdb/) with more detailed instructions in [Discord]({{ site.baseurl }}/docs/faq_getting-started/stashdb/joining-our-discord/) pinned to the **#stashdb-invites** channel. [Voting access]({{ site.baseurl }}/docs/faq_getting-started/edits/voting/) comes later. Make sure to watch for comments/downvotes on your edits and messages on Discord/Matrix alerting you to any issues or possible violations of the guidelines. +In order to fix incorrect info or add missing data, your account will need to be granted edit access. More information can be found [here]({{ site.baseurl }}/docs/faq_getting-started/stashdb/contributing-to-stashdb/) with more detailed instructions in [Discord]({{ site.baseurl }}/docs/faq_getting-started/stashdb/joining-discord-and-matrix/) pinned to the **#stashdb-invites** channel. [Voting access]({{ site.baseurl }}/docs/faq_getting-started/edits/voting/) comes later. Make sure to watch for comments/downvotes on your edits and messages on Discord/Matrix alerting you to any issues or possible violations of the guidelines. ***At the discretion of an admin, a user’s edit access may be revoked at any time.*** This happens very rarely and is only done when absolutely necessary to maintain the integrity of both the database and the community. The most common reason for losing these privileges is a lack of communication. More information on our enforcement process can be found [here]({{ site.baseurl }}/docs/faq_getting-started/edits/moderation-enforcement/). diff --git a/docs/scenes/edit/scene-tags/picking-scene-tags.md b/docs/scenes/edit/scene-tags/picking-scene-tags.md index 28823b9..071c5f3 100644 --- a/docs/scenes/edit/scene-tags/picking-scene-tags.md +++ b/docs/scenes/edit/scene-tags/picking-scene-tags.md @@ -13,4 +13,4 @@ grand_parent: Edit Scenes --- -The list of tags on StashDB is long. You don't have to be aware of all of them. You don't have to add every tag that possibly fits. Think of tags as an additional way to describe a scene and focus on adding tags you think are important to describing the scene in front of you. That may require relatively few tags or it could require a lot. You may as well start small and slowly expand from there as you become more familiar with the tags available on StashDB. If you have any questions about how to use a particular tag, first read its description carefully. [Previous edit comments]({{ site.baseurl }}/docs/faq_getting-started/tags/tag-edit-comments/) may give you more information as well. Otherwise, feel free to ask in the **#ministry-of-truth** channel on [Discord]({{ site.baseurl }}/docs/faq_getting-started/stashdb/joining-our-discord/). Also, please explain in your own edit comment [where your tags are coming from]({{ site.baseurl }}/docs/scenes/edit/scene-tags/priority-tag-sources/), if they're simply scraped or if you've added/removed some yourself. +The list of tags on StashDB is long. You don't have to be aware of all of them. You don't have to add every tag that possibly fits. Think of tags as an additional way to describe a scene and focus on adding tags you think are important to describing the scene in front of you. That may require relatively few tags or it could require a lot. You may as well start small and slowly expand from there as you become more familiar with the tags available on StashDB. If you have any questions about how to use a particular tag, first read its description carefully. [Previous edit comments]({{ site.baseurl }}/docs/faq_getting-started/tags/tag-edit-comments/) may give you more information as well. Otherwise, feel free to ask in the **#ministry-of-truth** channel on [Discord]({{ site.baseurl }}/docs/faq_getting-started/stashdb/joining-discord-and-matrix/). Also, please explain in your own edit comment [where your tags are coming from]({{ site.baseurl }}/docs/scenes/edit/scene-tags/priority-tag-sources/), if they're simply scraped or if you've added/removed some yourself. diff --git a/docs/tags/edit/tag-category/assigning-tag-categories.md b/docs/tags/edit/tag-category/assigning-tag-categories.md index b259910..6e57807 100644 --- a/docs/tags/edit/tag-category/assigning-tag-categories.md +++ b/docs/tags/edit/tag-category/assigning-tag-categories.md @@ -13,4 +13,4 @@ grand_parent: Edit Tags --- -If the tag you're editing doesn't have a category yet, try to assign one in the same edit. This shows that somebody has handled a tag, [marking it as "sorted"]({{ site.baseurl }}/docs/faq_getting-started/tags/sorted-vs-unsorted-tags/) to some extent. Categories are easy to correct afterwards, so don't worry about guessing. Also feel free to ask in the **#ministry-of-truth** channel on [Discord]({{ site.baseurl }}/docs/faq_getting-started/stashdb/joining-our-discord/) for clarification. +If the tag you're editing doesn't have a category yet, try to assign one in the same edit. This shows that somebody has handled a tag, [marking it as "sorted"]({{ site.baseurl }}/docs/faq_getting-started/tags/sorted-vs-unsorted-tags/) to some extent. Categories are easy to correct afterwards, so don't worry about guessing. Also feel free to ask in the **#ministry-of-truth** channel on [Discord]({{ site.baseurl }}/docs/faq_getting-started/stashdb/joining-discord-and-matrix/) for clarification. diff --git a/docs/tags/merge/merging-sorted-tags.md b/docs/tags/merge/merging-sorted-tags.md index c5a92c8..d917a10 100644 --- a/docs/tags/merge/merging-sorted-tags.md +++ b/docs/tags/merge/merging-sorted-tags.md @@ -13,7 +13,7 @@ grand_parent: Tags --- -If a tag has already been assigned a description, then it has already been organized by another editor. These can be considered ["sorted" tags]({{ site.baseurl }}/docs/faq_getting-started/tags/sorted-vs-unsorted-tags/). It could be used as a merge target, but shouldn't be considered eligible to be deleted or merged into something else at this time. If you feel you've found an exception to this, please ask in the **#ministry-of-truth** channel on [Discord]({{ site.baseurl }}/docs/faq_getting-started/stashdb/joining-our-discord/) first. +If a tag has already been assigned a description, then it has already been organized by another editor. These can be considered ["sorted" tags]({{ site.baseurl }}/docs/faq_getting-started/tags/sorted-vs-unsorted-tags/). It could be used as a merge target, but shouldn't be considered eligible to be deleted or merged into something else at this time. If you feel you've found an exception to this, please ask in the **#ministry-of-truth** channel on [Discord]({{ site.baseurl }}/docs/faq_getting-started/stashdb/joining-discord-and-matrix/) first. {: .note } Unconfirmed guideline, subject to change pending formal approval. From 049090ef31394e994d33b3a15f1cd2aeb0027dcc Mon Sep 17 00:00:00 2001 From: AdultSun <64123896+AdultSun@users.noreply.github.com> Date: Thu, 7 Mar 2024 17:00:38 -0700 Subject: [PATCH 06/11] Uses the "includes" function to replace the invite code more easily --- _includes/invite-code.txt | 1 + docs/faq_getting-started/stashdb/accessing-stashdb.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) create mode 100644 _includes/invite-code.txt diff --git a/_includes/invite-code.txt b/_includes/invite-code.txt new file mode 100644 index 0000000..f7bb5aa --- /dev/null +++ b/_includes/invite-code.txt @@ -0,0 +1 @@ +`21e01328-3605-485d-9091-18ed4f7954ee` \ No newline at end of file diff --git a/docs/faq_getting-started/stashdb/accessing-stashdb.md b/docs/faq_getting-started/stashdb/accessing-stashdb.md index 45df379..f5b92be 100644 --- a/docs/faq_getting-started/stashdb/accessing-stashdb.md +++ b/docs/faq_getting-started/stashdb/accessing-stashdb.md @@ -34,7 +34,7 @@ New accounts start with READ access only. If you'd like to add or edit any data - This email address will only be visible to StashDB admins. It will not be used as your username. - Do not forget it, you will need it if you ever need to reset your password. An admin may also ask you to provide this address if you need their help with your account. 1. **Enter an active invite key** - - Copy and paste this entire code into the registration form:
`21e01328-3605-485d-9091-18ed4f7954ee`
It has a limited number of uses so it will be replaced periodically. + - Copy and paste this entire code into the registration form:
{% include invite-code.txt %}
It has a limited number of uses so it will be replaced periodically. - Invite codes will also be pinned to 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"}. - If any of these codes have expired, please ask politely for it to be refreshed by pinging either **@AdultSun** on Discord or **@DogmaDragon** on Matrix in the appropriate channel/room. A few other elevated users can also generate invite codes if necessary. 1. **Check for an email from StashDB and click the confirmation link** From 441a2f8b73513ffc0b5af68bfaae4c76de541b46 Mon Sep 17 00:00:00 2001 From: AdultSun <64123896+AdultSun@users.noreply.github.com> Date: Thu, 7 Mar 2024 17:19:31 -0700 Subject: [PATCH 07/11] Links invite-code.txt to the StashDB table in "Accessing Stash-Boxes" --- docs/faq_getting-started/stashdb/accessing-stash-boxes.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/faq_getting-started/stashdb/accessing-stash-boxes.md b/docs/faq_getting-started/stashdb/accessing-stash-boxes.md index d300f36..5c0ee0a 100644 --- a/docs/faq_getting-started/stashdb/accessing-stash-boxes.md +++ b/docs/faq_getting-started/stashdb/accessing-stash-boxes.md @@ -45,7 +45,10 @@ If you need a more detailed walkthrough on how to register an account with one o ### Accessing StashDB {: .no_toc } -1. Grab an invite token from the [Accessing StashDB]({{ site.baseurl }}/docs/faq_getting-started/stashdb/accessing-stashdb/) guide, the [**#stashdb-invites** channel](https://discord.com/channels/559159668438728723/935614155107471442){:target="_blank"} on [Discord](https://discord.com/invite/2TsNFKt){:target="_blank"}, or 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"}
*(The guide page also contains more detailed instructions for registering an account and connecting it to your Stash.)* +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 From 154f14f0bcf098d55da23b5ce05b89fb7751b65a Mon Sep 17 00:00:00 2001 From: AdultSun <64123896+AdultSun@users.noreply.github.com> Date: Thu, 7 Mar 2024 17:36:30 -0700 Subject: [PATCH 08/11] Adds warning in "Accessing StashDB" about special characters in username --- docs/faq_getting-started/stashdb/accessing-stashdb.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/faq_getting-started/stashdb/accessing-stashdb.md b/docs/faq_getting-started/stashdb/accessing-stashdb.md index f5b92be..13cf546 100644 --- a/docs/faq_getting-started/stashdb/accessing-stashdb.md +++ b/docs/faq_getting-started/stashdb/accessing-stashdb.md @@ -41,7 +41,8 @@ New accounts start with READ access only. If you'd like to add or edit any data - Please wait a few minutes for it to arrive. If you still don't see it, try refreshing your inbox or checking your spam/junk folder. - The link will direct you to a webpage to *choose your username and password for the first time*. This is not a generic login page even though it may look like one. This has confused others before, so just keep going. 1. **Choose your username** - - *Do not* enter your email address as your username here. + - Do *not* enter your email address as your username here. + - Avoid using special characters like `#` or `/` in your username. A bug in Stash-Box may break the link to your profile page. - Admins are able to change or lookup your username upon request. - If you plan on requesting edit access, please make sure your username in StashDB matches your display name in Discord/Matrix. See the [Contributing to StashDB]({{ site.baseurl }}/docs/faq_getting-started/stashdb/contributing-to-stashdb/) page for further details. 1. **Choose your password** From c054fecc48f0a5f39be7e3eb5c696ce22ff9a75f Mon Sep 17 00:00:00 2001 From: AdultSun <64123896+AdultSun@users.noreply.github.com> Date: Fri, 8 Mar 2024 01:17:48 -0700 Subject: [PATCH 09/11] Adds note to "Accessing StashDB" about expiring activation links --- docs/faq_getting-started/stashdb/accessing-stashdb.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/faq_getting-started/stashdb/accessing-stashdb.md b/docs/faq_getting-started/stashdb/accessing-stashdb.md index 13cf546..6f5297d 100644 --- a/docs/faq_getting-started/stashdb/accessing-stashdb.md +++ b/docs/faq_getting-started/stashdb/accessing-stashdb.md @@ -37,8 +37,9 @@ New accounts start with READ access only. If you'd like to add or edit any data - Copy and paste this entire code into the registration form:
{% include invite-code.txt %}
It has a limited number of uses so it will be replaced periodically. - Invite codes will also be pinned to 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"}. - If any of these codes have expired, please ask politely for it to be refreshed by pinging either **@AdultSun** on Discord or **@DogmaDragon** on Matrix in the appropriate channel/room. A few other elevated users can also generate invite codes if necessary. -1. **Check for an email from StashDB and click the confirmation link** - - Please wait a few minutes for it to arrive. If you still don't see it, try refreshing your inbox or checking your spam/junk folder. +1. **Check for an email from StashDB and click the activation link** + - Please wait a few minutes for the email to arrive. If you still don't see it, try refreshing your inbox or checking your spam/junk folder. + - Your activation link is only good for about 2 hours. You'll have to start over if it expires. - The link will direct you to a webpage to *choose your username and password for the first time*. This is not a generic login page even though it may look like one. This has confused others before, so just keep going. 1. **Choose your username** - Do *not* enter your email address as your username here. From 4de00ee0176cd9e8ba4d6efd012783933a0efc19 Mon Sep 17 00:00:00 2001 From: AdultSun <64123896+AdultSun@users.noreply.github.com> Date: Sun, 10 Mar 2024 16:44:29 -0700 Subject: [PATCH 10/11] Updates language in "Accessing Stash-Boxes" intro --- docs/faq_getting-started/stashdb/accessing-stash-boxes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/faq_getting-started/stashdb/accessing-stash-boxes.md b/docs/faq_getting-started/stashdb/accessing-stash-boxes.md index 5c0ee0a..0dc8c62 100644 --- a/docs/faq_getting-started/stashdb/accessing-stash-boxes.md +++ b/docs/faq_getting-started/stashdb/accessing-stash-boxes.md @@ -15,7 +15,7 @@ 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. From 18856ce583dbb48043e1f6c40ae8d1dc57bd6da6 Mon Sep 17 00:00:00 2001 From: AdultSun <64123896+AdultSun@users.noreply.github.com> Date: Sun, 10 Mar 2024 16:50:07 -0700 Subject: [PATCH 11/11] Minor updates to "Accessing StashDB" language --- docs/faq_getting-started/stashdb/accessing-stashdb.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/faq_getting-started/stashdb/accessing-stashdb.md b/docs/faq_getting-started/stashdb/accessing-stashdb.md index 6f5297d..fe76fb2 100644 --- a/docs/faq_getting-started/stashdb/accessing-stashdb.md +++ b/docs/faq_getting-started/stashdb/accessing-stashdb.md @@ -44,7 +44,7 @@ New accounts start with READ access only. If you'd like to add or edit any data 1. **Choose your username** - Do *not* enter your email address as your username here. - Avoid using special characters like `#` or `/` in your username. A bug in Stash-Box may break the link to your profile page. - - Admins are able to change or lookup your username upon request. + - Admins are able to change or lookup your username upon request. Contact an admin (preferably **@AdultSun** on Discord) and provide your email address in a DM to verify your account. - If you plan on requesting edit access, please make sure your username in StashDB matches your display name in Discord/Matrix. See the [Contributing to StashDB]({{ site.baseurl }}/docs/faq_getting-started/stashdb/contributing-to-stashdb/) page for further details. 1. **Choose your password** - Must be at least 8 characters long while avoiding "common" passwords.