Skip to content

[SyncServer] Add instructions for credentials#451

Open
PetitPotiron wants to merge 1 commit intoankitects:mainfrom
PetitPotiron:patch-1
Open

[SyncServer] Add instructions for credentials#451
PetitPotiron wants to merge 1 commit intoankitects:mainfrom
PetitPotiron:patch-1

Conversation

@PetitPotiron
Copy link
Copy Markdown

It is very hard to understand, when self-hosting your syncserver, where you must put your credentials in order to synchronize the whole thing.

This forum topic illustrates the case. There's no prompt anywhere asking for the credentials, and it's not obvious that the credentials must be set in AnkiWeb Account, because it's written everywhere that's it's a different service, which is not affiliated with Anki...

I also struggled for a long time before finally figuring it out.

So anyways, the UI deserves to be enhanced as well.

In this PR, I added instructions for where to put the user credentials when using a self-hosted syncserver.

@PetitPotiron
Copy link
Copy Markdown
Author

PetitPotiron commented Sep 20, 2025

This forum topic also shows that it's unclear

@GithubAnon0000
Copy link
Copy Markdown
Contributor

it's not obvious that the credentials must be set in AnkiWeb Account, because it's written everywhere that's it's a different service, which is not affiliated with Anki...

Not sure where you read that. AnkiWeb is an official webservice affiliated with Anki, see e.g. the official FAQs (https://faqs.ankiweb.net/anki-knockoffs.html).

However, if you setup your custom sync server the Anki GUI still claims you sync with "AnkiWeb", even though that isn't the case anymore. You sync with your own sync server instead.

@brishtibheja
Copy link
Copy Markdown
Contributor

brishtibheja commented Sep 29, 2025 via email

@PetitPotiron
Copy link
Copy Markdown
Author

because it's written everywhere that's it's a different service, which is not affiliated with Anki...

Not sure where you read that. AnkiWeb is an official webservice affiliated with Anki, see e.g. the official FAQs (https://faqs.ankiweb.net/anki-knockoffs.html).

I apologize for the misunderstanding, I don't know where I read that either.

However, if you setup your custom sync server the Anki GUI still claims you sync with "AnkiWeb", even though that isn't the case anymore. You sync with your own sync server instead.

That's the problem, in my opinion. I believe it's not clear enough. And several forum posts show so too.

Even though it's written at the beginning of the SyncServer doc, not every user who uses a custom SyncServer will be its Administrator, and thus we should also explain it in the section dedicated to the Client setup, for both people who don't read beginnings of documents (almost always prerequisites, which can easily be fulfilled) and people who read the section they are interested in.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants