Introduction
Nanako is the account hub and identity provider for the Nanako ecosystem. The main web application combines account management, OAuth consent and a set of personal tools behind one account.
This page was checked against the NanakoHome routes and client API on 2026-09-10. The links below are configured product addresses; this documentation does not assert their current availability.
Accounts and security
Depending on server configuration, the sign-in page can offer phone or email credentials and Google, GitHub or Apple sign-in. New accounts complete a short profile setup. Account settings include:
- profile and avatar editing;
- phone, email and external identity linking;
- password setup and changes;
- TOTP two-factor authentication and recovery codes;
- active login-session review and revocation;
- review and revocation of OAuth application grants.
The settings UI also renders account deletion, but this checkout cannot complete it: the backend handler asserts the authenticated UUID user ID as an integer and fails before the deletion transaction. Treat deletion as unavailable until that handler is fixed and verified.
The browser keeps the short-lived access token in memory and the current tab's session storage. Session renewal uses a refresh token in an HttpOnly cookie. Closing or revoking a server-side session remains the authoritative way to end continued access.
Built-in tools
The current NanakoHome frontend contains routes for:
| Tool | Current scope |
|---|---|
| Todo | Private boards, items, sharing and read-only public board links |
| Pomodoro | Focus timer, saved preferences and statistics |
| Honeycomb | Authenticated file deposits and public pickup by code |
| Script hosting | Managed scripts with public /s/:slug links |
| PDF translation | Provider selection, asynchronous progress and result downloads; access can require an administrator grant |
| Document parsing | PDF/Office upload, fast or accurate processing, progress and downloads |
| Image hosting | Authenticated upload, listing and deletion |
| Showcase | Public catalogue of applications and synchronized GitHub Release assets |
| GitHub acceleration | Token-based acceleration for GitHub file downloads such as release, raw and archive URLs |
| Developer center | Developer application, OAuth client management and authorization logs |
Administrators can disable or completely hide individual tools. A visible card therefore does not guarantee that its backend dependency is configured or currently available.
GitHub acceleration currently covers file downloads. It is not a GitHub website mirror, search engine, Git API proxy or general-purpose proxy.
External first-party applications
NanoStart and NanoUptime are separate applications:
| Product | Relationship to NanakoHome | Configured address |
|---|---|---|
| NanoStart | The home-page card opens the external start-page application in a new tab. Its UI is not implemented by NanakoHome. | start.nanako.org |
| NanoUptime | The /apps/uptime route obtains a one-time SSO launch URL, then redirects to the external monitoring application. | uptime.nanako.org |
These products do not yet have their own sections on this documentation site.
Notifications
The implemented notification baseline includes an in-app inbox, unread counts, read/archive actions, per-category preferences, per-authorized-app mute controls and live updates. If the live stream is unavailable, the browser falls back to periodic polling. Email delivery is available when the deployment enables the notification worker and email channel.
Browser Web Push and Apple Push Notification service delivery are future channels. The backend model reserves them, but NanakoHome currently has no device-registration endpoints; their controls are shown as unavailable and cannot be enabled.
Developer access
Nanako can act as an OAuth 2.0 / OpenID Connect provider. Sign in, open the Developer Center, apply for developer access, and register exact redirect URIs after approval. A client secret is displayed only when a client is created or regenerated.
- OAuth 2.0 — add "Sign in with Nanako" to your own product
- API reference — the verified endpoint surface and authentication conventions
- Changelog — a dated historical record; check the status notes in older entries before treating them as today's capability list