Skip to content

feat: document TINYAUTH_AUTH_STANDALONE option#70

Open
jacekkow wants to merge 1 commit intosteveiliop56:mainfrom
jacekkow:main
Open

feat: document TINYAUTH_AUTH_STANDALONE option#70
jacekkow wants to merge 1 commit intosteveiliop56:mainfrom
jacekkow:main

Conversation

@jacekkow
Copy link

@jacekkow jacekkow commented Mar 20, 2026

Documentation updates for feature from steveiliop56/tinyauth#710

Summary by CodeRabbit

  • Documentation
    • Updated domain configuration guidance explaining conditional authentication cookie behavior based on standalone mode
    • Added documentation for new TINYAUTH_AUTH_STANDALONE configuration option controlling subdomain cookie behavior

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 20, 2026

📝 Walkthrough

Walkthrough

Documentation updated to reflect a new authentication configuration option (TINYAUTH_AUTH_STANDALONE) that controls cookie behavior in standalone mode. The Domain Configuration guidance in getting-started and reference configuration documentation have been revised accordingly.

Changes

Cohort / File(s) Summary
Authentication Configuration Documentation
src/content/docs/docs/getting-started.mdx, src/content/docs/docs/reference/configuration.mdx
Added conditional guidance for Domain Configuration based on TINYAUTH_AUTH_STANDALONE setting; documented new config option with description and default value (false).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 A cookie that switches its stance,
In standalone or shared-domain dance,
Docs now clarify when and why,
Auth's behavior, neat and spry,
Configuration wisdom at a glance!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically describes the main change: documenting the TINYAUTH_AUTH_STANDALONE option. It is concise and directly reflects the documentation updates made across two files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
📝 Coding Plan
  • Generate coding plan for human review comments

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
src/content/docs/docs/getting-started.mdx (1)

69-69: Add a direct reference link for faster discoverability.

Line [69] mentions TINYAUTH_AUTH_STANDALONE but doesn’t link to the configuration reference; adding a link would make this easier to follow.

✍️ Suggested doc tweak
-Tinyauth sets a cookie for the parent domain of the application URL, unless `TINYAUTH_AUTH_STANDALONE=true` is set. For example, if the application URL is `http://tinyauth.example.com`, the cookie is set for `.example.com`, enabling authentication across all subdomains. Below is an example of an ideal domain structure:
+Tinyauth sets a cookie for the parent domain of the application URL, unless [`TINYAUTH_AUTH_STANDALONE=true`](/docs/reference/configuration) is set. For example, if the application URL is `http://tinyauth.example.com`, the cookie is set for `.example.com`, enabling authentication across all subdomains. Below is an example of an ideal domain structure:
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@src/content/docs/docs/getting-started.mdx` at line 69, Replace the plain
mention of TINYAUTH_AUTH_STANDALONE in the Getting Started text with a direct
Markdown link to the configuration reference for that environment variable (wrap
`TINYAUTH_AUTH_STANDALONE=true` in a link to the existing configuration
docs/anchor for TINYAUTH_AUTH_STANDALONE) so readers can click through to the
config details from the Getting Started page.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@src/content/docs/docs/getting-started.mdx`:
- Line 69: Replace the plain mention of TINYAUTH_AUTH_STANDALONE in the Getting
Started text with a direct Markdown link to the configuration reference for that
environment variable (wrap `TINYAUTH_AUTH_STANDALONE=true` in a link to the
existing configuration docs/anchor for TINYAUTH_AUTH_STANDALONE) so readers can
click through to the config details from the Getting Started page.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: def4e910-bf84-4f93-82c9-d3152b0c6d4f

📥 Commits

Reviewing files that changed from the base of the PR and between cd98c92 and 6a0f6c5.

📒 Files selected for processing (2)
  • src/content/docs/docs/getting-started.mdx
  • src/content/docs/docs/reference/configuration.mdx

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.

1 participant