Repository navigation
docs: sign in with a Tolgee account for the CLI, the browser extension and MCP clients - #1151
Merged
Merged
Conversation
✅ Deploy Preview for tolgee-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
bdshadow
force-pushed
the
bdshadow/oauth-mcp-clients
branch
3 times, most recently
from
October 2, 2026 11:33
f76356a to
49edf6f
Compare
bdshadow
marked this pull request as ready for review
October 2, 2026 11:36
Barush
requested changes
Oct 8, 2026
bdshadow
force-pushed
the
bdshadow/oauth-mcp-clients
branch
from
October 12, 2026 12:09
49edf6f to
9191bdc
Compare
…ser extension and MCP clients Tolgee now acts as an OAuth 2.1 authorization server. Apps send the user to a consent screen in the browser and get a short-lived token instead of a copied API key. Nothing in the docs described this yet. Platform (user facing): a new "Sign in with Tolgee (OAuth)" page explains the consent screen, lifetimes and how to end access. A new self-hosting page tells operators what is on by default, how to register the browser extension and which switches narrow it. The MCP server pages put account sign-in first and keep API keys as the second option. CLI and JS SDK (developer facing): the CLI login section is rewritten around a bare `tolgee login`, with CI behaviour, project binding and the credential order. The in-context page documents the browser extension sign-in and what a site has to provide for it.
The platform now re-reads a client's document when one of its users refreshes a token, so the backlog metric is gone.
bdshadow
force-pushed
the
bdshadow/oauth-mcp-clients
branch
from
October 12, 2026 13:35
9191bdc to
d1145fa
Compare
This was referenced Oct 19, 2026
Barush
added a commit
that referenced
this pull request
Oct 19, 2026
Documents Community Translation end to end: public projects and community contributors in the platform (pitch tolgee/tolgee-platform#3806), and suggesting translations in context through the Tolgee Tools browser plugin (pitch tolgee/tolgee-platform#3780). It includes the changes from #1144, which was built on top of this branch and is merged into it. The feature is released: | Part | Release | | --- | --- | | Public projects | Tolgee v3.206.0 | | `Community translation` switcher entry | Tolgee v3.207.0 | | `Community` tab, `Invite to Team` | Tolgee v3.215.0 | | Plugin sign-in on self-hosted (`tolgee.oauth2.browser-extension-enabled`) | Tolgee v3.230.0 | | Suggestions in the in-context dialog | `@tolgee/web` 7.3.0, Tolgee v3.227.0 | | Missing-permissions alert in the plugin | Tolgee Tools v1.11.0 | ## New pages - **`platform/translation_process/community-translation.mdx`**, the feature hub. It has a part for owners and members (making a project public and what that exposes, sharing it, reviewing suggestions, seeing who contributed, making it private again) and a part for contributors (what they can do, finding the projects they helped with). It also covers the self-hosted requirements: version floor, authentication and open registrations. - **`platform/translation_process/community-translation-in-context.mdx`**, for owners whose website uses the Tolgee JS SDK. It covers what to switch on in the project and on a self-hosted server, what to declare on the website (`apiUrl`, `projectId`, no `apiKey`), what contributors need, the `Translate with Tolgee` badge, and what contributors can do in the dialog. - **`platform/translate-with-tolgee.mdx`** is the page the badge links to, through the short link `/translate-with-tolgee` that `static/_redirects` points to it. It walks a first-time contributor through installing the plugin, signing in and Alt+clicking a string, and lists fixes for common problems. ## Updated pages - **`js-sdk/in_context.mdx`** gets a new section, "Suggesting Translations in Context". It covers the `Save` / `Suggest` / `Save & suggest` button, the per-field notes, partial failures, reviewing suggestions in the dialog, suggest-only permissions and troubleshooting. A short paragraph links the sign-in section to it. The page is based on main's version from #1151. - **`suggestions.mdx`** describes the two accept actions (`Accept only` and `Accept and decline others`) and the display of up to three suggestions with `Show all`. It notes that `Suggestions mode` off rejects new suggestions with `suggestions_disabled` (HTTP 409), and it documents the `Delete own` permission. It also corrects which permissions accepting and declining need. - **`project_settings.mdx`** gets a `Public project` section, and the Advanced screenshot is retaken and moved to the top of the section (see the review comments below). - **`members.mdx`** gets a `Community Contributors` section (the `Team` and `Community` tabs) and a community-permissions note. - **`sidebarPlatform.js`**: both community pages sit under Translation Process, and the contributor page sits under Get Started. ## Review comments addressed - The page moved to Translation Process. - The open-source offer now names the free Business plan for non-commercial open source and links to `mailto:sales@tolgee.io`. - The lead paragraph is rewritten as who, what, how and what's next, with no links, and says "anyone with a Tolgee account". - Sections are grouped by owner and contributor point of view. - The full public projects URL is given, with the self-hosted equivalent. - The page says where the organization switcher is and when `Community translation` appears. - The community projects screenshot is explained: logged in, what `My contributions only` filters, and that `Community translation` is not a real organization. - Accept options and the Team and Community tabs are bullets. - The Advanced project settings screenshot was missing `Public project` and sat at the bottom of the section. It is retaken with `Public project` on top and moved directly under the section heading. - `Read more` from the settings page links to the "Making a Project Public" anchor. - The `public project` links on the Members page go to the "Making a Project Public" anchor instead of the page top. ## Screenshots These are captured against a local Tolgee v3.236.0 and the `@tolgee/web` test app, or reused from main. - public toggle - Advanced settings - public projects page - community projects page - Community tab - the accept actions - the in-context dialog in suggest-only mode - the plugin's `Connect to Tolgee` popup and consent screen, reused from main's #1151 images ## Open - [x] The short link redirects to the page on the deploy preview (`/translate-with-tolgee` answers 301 to `/platform/translate-with-tolgee`). - [ ] Tolgee Tools v1.11.0 is a GitHub pre-release. Confirm it is live in the Chrome Web Store and Firefox Add-ons before release notes point at the missing-permissions alert. - [ ] Optional: replace `static/img/docs/platform/oauth/consent-screen-browser-extension.webp` on the contributor page with a capture made as a contributor. The current one shows a user with edit rights. The branch is up to date with `main`. Checked with `npm run build`, which throws on broken links and anchors. --------- Co-authored-by: Barush Urbanová <bara.skrivankova@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this does
Tolgee can now sign apps in with the user's account instead of a copied API key. The platform acts as an OAuth 2.1 authorization server, the Tolgee CLI, the Tolgee Tools browser extension and MCP clients use it. The docs said nothing about this yet. This PR adds the missing pages and updates the ones that only knew API keys.
Platform docs are written for users, the CLI and JS SDK docs for developers. Simple English throughout.
New pages
back-end-urlmatters on a split-origin setup, how to register the browser extension, the switchescli-enabled,cimd-enabledandcimd-allowed-hosts, token lifetimes, the two metrics to watch.Updated pages
tolgee login:--no-browser, CI behaviour, the project taken from the approval,login --list, the threelogoutforms, the credential priority order, where the store lives. Introduction and Project configuration got short notes.projectId,@tolgee/web7.2.0), how requests are relayed through the extension, the API key fallback.Depends on
tolgee loginthrough the browser).@tolgee/web7.2.0 and Tolgee Tools 1.10.0 are already released.Screenshots
Four new images under
static/img/docs/platform/oauth/: the consent screen for the CLI, and the Tolgee Tools popup before and after signing in together with the consent screen it opens. They were taken against a local instance, so they showlocalhostand a demo project.Not in this PR
Checks
npm run build(with broken links set to throw),npm run eslintandnpm run prettier-checkpass locally.