Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,34 @@ The directory for Linux/macOS might differ, if you changed it on the Docker comm
[installation](/getting-started/installing-shoko-server).
:::

:::details I've Forgotten My Password — How Do I Reset It?
A forgotten password can be reset with a small file, without any direct database access. This works the same for the

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For @hidden4003's concerns we just need modify the start of the first line to indicate it's only available from 6.0.0 and up. Then we can also merge it before 6.0.0 is released.

CLI, Docker, and the Windows Tray Service.

1. Create a file named **password-reset.json** in your Shoko data folder (the folder containing
`server-settings.json`) with the following content, replacing the values as needed:

```json
{ "username": "Default", "password": "NewPassword12" }
```

The username is not case-sensitive.

2. Start the server. It will reset the password for that user, invalidate all of that user's existing API tokens
(signed-in devices will need to sign in again), delete the file, and exit.

3. Start the server again. It boots normally and you can sign in with the new password.

If the server exits without resetting anything, the username didn't match any user — the file is kept, so you can
correct it and restart to try again. If the server starts normally and ignores the file, the file could not be read
(invalid JSON, missing username, or empty password); nothing was changed and your server stays online.

> [!WARNING]
> The new password is stored in plain text in the file until a successful reset deletes it. If the reset fails,
> delete the file yourself when you're done. Anyone with write access to your data folder can use this method, so
> don't expose that folder beyond what you need.
:::

:::details I've Been Banned From AniDB?
The message you're encountering indicates a **temporary ban** due to excessive connection attempts. AniDB imposes such
bans when it suspects data leeching through numerous rapid connection attempts. In reality, this doesn't imply any
Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/running-shoko-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ You'll need to create an account to use Shoko. This account allows Shoko to mana
sites, enabling synchronization of watch states and collection status.

There are no specific password requirements for your local account. However, we strongly recommend saving your login
information, as we currently do not offer an easy way to reset your password. If you do forget it, refer to
the [Frequently Asked Questions](/faq) page for instructions on how to reset it.
information. If you do forget your password, refer to the [Frequently Asked Questions](/faq) page for instructions on

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe also mention it here too.

how to reset it with a `password-reset.json` file.

## AniDB Account

Expand Down