Accessing StashDB

Details on joining StashDB and connecting it to Stash.

Table of Contents
  1. Creating an Account
  2. Connecting to Stash

Creating an Account

You will need to register an account on 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, you will need to ask for EDIT access after creating your account.

  1. Go to
  2. 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.
  3. Enter an active invite key
    • Copy and paste this entire code into the registration form:
      It has a limited number of uses so it will be replaced periodically.
    • Invite codes will also be pinned to the #stashdb-invites channel on Discord and in the StashDB - Invites room topic on Matrix.
    • 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.
  4. 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.
  5. 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. 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 page for further details.
  6. 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.
  7. Click the “Create Account” button
  8. 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 to match your local videos with their entries on StashDB. Our Guide to Scraping 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 page.

  1. Find your unique API key for StashDB
    1. Log into
    2. Click on your username at the top, next to the generic user icon
    3. Copy the entire API key
  2. Find your saved Stash-Boxes in Stash
    1. Go to the “Settings” page in Stash
      (Located at http://localhost:9999/settings by default)
    2. Click “Metadata Providers” on the left side
    3. Find “Stash-box Endpoints” at the top
  3. Add StashDB to your saved Stash-Boxes
    1. Click the “Add” button
    2. Paste your API key
    3. Enter as the “Name”
      (Or use whatever else you want StashDB to be listed as, it doesn’t need to be exactly the same.)
    4. Enter as the endpoint
    5. Click the “Confirm” button