refactor: cleanup documentation phrasing and guides#12
Conversation
WalkthroughThis update revises multiple documentation files for clarity, consistency, and improved guidance. Changes include editorial refinements, reworded instructions, expanded explanations, new informational notes, and the addition of configuration and access control options. No functional code or logic is altered; all updates are limited to documentation content, examples, and formatting. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Docs
participant Tinyauth
User->>Docs: Reads updated documentation
Docs-->>User: Provides clearer instructions, new notes, and examples
User->>Tinyauth: Applies improved setup/configuration based on docs
Tinyauth-->>User: Behaves as before (no code changes)
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🔭 Outside diff range comments (1)
docs/community/caddy.md (1)
72-83:⚠️ Potential issueFix hostname to match the “whoami” example
The snippet header mentions “whoami” but thecaddylabel still points tonginx.example.com. Update the hostname towhoami.example.comfor consistency:- caddy: http://nginx.example.com + caddy: http://whoami.example.com
🧹 Nitpick comments (80)
docs/guides/using-the-binary.md (1)
49-49: Capitalize the first word of the sentence
Markdown best practices recommend sentences start with a capital letter. Change "if you need tinyauth…" to "If you need tinyauth…".🧰 Tools
🪛 LanguageTool
[uncategorized] ~49-~49: Possible missing comma found.
Context: ...e if you need tinyauth to autostart on boot you can do so by creating a systemd ser...(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~49-~49: Consider adding a comma after ‘Firstly’ for more clarity.
Context: ...are using systemd as your init system). Firstly you will need to create the `/etc/syste...(RB_LY_COMMA)
[style] ~49-~49: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... as your init system). Firstly you will need to create the `/etc/systemd/system/tinyaut...(REP_NEED_TO_VB)
docs/reference/flow.md (1)
3-3: Remove weak intensifier
Consider omitting "really" for a more concise statement (e.g., "Tinyauth is a simple application.").🧰 Tools
🪛 LanguageTool
[style] ~3-~3: As an alternative to the over-used intensifier ‘really’, consider replacing this phrase.
Context: # Flow Tinyauth is a really simple application. The way the authentication...(EN_WEAK_ADJECTIVE)
docs/about.md (4)
7-7: Streamline phrasing by removing redundancy
Consider removing "additional" for brevity (e.g., "add a layer of authentication" instead of "add an additional layer of authentication").🧰 Tools
🪛 LanguageTool
[uncategorized] ~7-~7: Possible missing comma found.
Context: ...tect them when they don't offer a login screen or just to add an additional layer of a...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~7-~7: This phrase might be redundant. Consider either removing or replacing the adjective ‘additional’.
Context: ...y don't offer a login screen or just to add an additional layer of authentication. While the projects m...(ADD_AN_ADDITIONAL)
[style] ~7-~7: Consider using a more concise synonym.
Context: ...bove can certainly do the job and offer a variety of configuration options, they can be hard...(A_VARIETY_OF)
[style] ~7-~7: To elevate your writing, try using a synonym here.
Context: ...y of configuration options, they can be hard to configure for new users, resource hu...(HARD_TO)
11-11: Insert missing comma for clarity
Add a comma after "out of the box" to separate clauses:... didn't even support traefik's forward auth out of the box, and they needed weird plugins ...🧰 Tools
🪛 LanguageTool
[uncategorized] ~11-~11: Possible missing comma found.
Context: ... wide variety of authentication projects but most of them didn't even support traefi...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~11-~11: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...rt traefik's forward auth out of the box and they needed weird plugins requiring mor...(COMMA_COMPOUND_SENTENCE)
15-15: Use the correct preposition for exposure
Replace "exposed in the internet" with "exposed on the internet".🧰 Tools
🪛 LanguageTool
[grammar] ~15-~15: The usual collocation for technology is “on”, not “in”.
Context: ...nyauth secure enough to even be exposed in the internet, it has some limitations like being com...(IN_THE_INTERNET)
[uncategorized] ~15-~15: A comma might be missing here.
Context: ...upport more advanced backends (like LDAP) my recommendation is Authentik. ## The...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
19-19: Omit weak intensifier for conciseness
Remove "really" to strengthen the statement (e.g., "Tinyauth has reached a good state...").🧰 Tools
🪛 LanguageTool
[style] ~19-~19: As an alternative to the over-used intensifier ‘really’, consider replacing this phrase.
Context: ...lans for tinyauth Tinyauth has reached a really good state where it supports almost everythi...(EN_WEAK_ADJECTIVE)
[typographical] ~19-~19: To make your text more readable, consider placing this phrase between commas.
Context: ... from an app like this. It supports what I believe are the most important features like OA...(WHICH_I_THOUGHT_COMMA)
[uncategorized] ~19-~19: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ike OAuth, TOTP and even access controls and it also integrates very well with the m...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~19-~19: Possible missing comma found.
Context: ...d any fancy dashboards or configuration files since I do not want to change the proje...(AI_HYDRA_LEO_MISSING_COMMA)
docs/contributing.md (3)
3-3: Insert comma before conjunction in compound sentence.
Add a comma before “and” to separate independent clauses for clarity.
Proposed diff:-Contributing is relatively easy, you just need to follow the steps below and you will be up and running with a development server in less than five minutes. +Contributing is relatively easy, you just need to follow the steps below, and you will be up and running with a development server in less than five minutes.🧰 Tools
🪛 LanguageTool
[uncategorized] ~3-~3: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... you just need to follow the steps below and you will be up and running with a devel...(COMMA_COMPOUND_SENTENCE)
23-23: Use gerund after “recommend”.
Replace “recommend to install them” with “recommend installing them” to correct verb usage and improve readability. Also capitalize “Docker” and correct “on your machine”.
Proposed diff:-Although you will not need the requirements in your machine since the development will happen in docker, I still recommend to install them because this way you will not have import errors. +Although you will not need the requirements on your machine since the development will happen in Docker, I still recommend installing them because this way you will not have import errors.🧰 Tools
🪛 LanguageTool
[grammar] ~23-~23: The verb ‘recommend’ is used with the gerund form.
Context: ...elopment will happen in docker, I still recommend to install them because this way you will not have...(ADMIT_ENJOY_VB)
38-38: Break up comma splice and simplify phrasing.
The sentence contains a comma splice and is lengthy. Split into two sentences for clarity and add missing comma after “app”.
Proposed diff:-In order to configure the app you need to create an environment file, this can be done by copying the `.env.example` file to `.env` and modifying the environment variables to suit your needs. +To configure the app, create an environment file by copying `.env.example` to `.env`. Then modify the environment variables to suit your needs.🧰 Tools
🪛 LanguageTool
[typographical] ~38-~38: It seems that a comma is missing.
Context: ....envfile In order to configure the app you need to create an environment file,...(IN_ORDER_TO_VB_COMMA)
[style] ~38-~38: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...file In order to configure the app you need to create an environment file, this can be...(REP_NEED_TO_VB)
index.md (1)
25-27: Add comma and standardize unit formatting.
Insert a comma after “Vite” and capitalize “MB” for consistency with technical documentation.
Proposed diff:- - title: Lightweight - details: Tinyauth is built with Go and Vite making it extremely lightweight at just 20mb. + - title: Lightweight + details: Tinyauth is built with Go and Vite, making it extremely lightweight at just 20 MB.docs/guides/nginx-proxy-manager.md (1)
3-4: Consider splitting long sentence for clarity.
The introductory line is a bit dense. Splitting it can improve readability:-Nginx Proxy Manager is definitely a piece of software that everybody loves in the homelab community. This is why it is mandatory that tinyauth supports it. +Nginx Proxy Manager is a popular tool in the homelab community. Because of its widespread use, Tinyauth includes dedicated support for it.docs/getting-started.md (2)
3-3: Replace weak intensifier “extremely”.
Consider a more precise adjective or remove it to tighten the prose.
Proposed diff:-As promised, tinyauth is extremely easy to get up and running. +As promised, Tinyauth is quick and straightforward to get up and running.🧰 Tools
🪛 LanguageTool
[style] ~3-~3: As an alternative to the over-used intensifier ‘extremely’, consider replacing this phrase.
Context: ...tting Started As promised, tinyauth is extremely easy to get up and running. ::: info Tinyau...(EN_WEAK_ADJECTIVE)
48-49: Simplify wording and remove redundancy.
The phrase “in order to be able to authenticate you” can be streamlined.
Proposed diff:-The way tinyauth works is by setting a cookie for the parent domain of the app URL. In other words if your app URL is `http://tinyauth.example.com`, tinyauth will set a cookie for `.example.com` in order to be able to authenticate you. +Tinyauth sets a cookie on the parent domain of your app URL. For example, if your app URL is `http://tinyauth.example.com`, Tinyauth will set a `.example.com` cookie to authenticate you.🧰 Tools
🪛 LanguageTool
[style] ~48-~48: Consider a more concise word here.
Context: ...th will set a cookie for.example.comin order to be able to authenticate you. This means...(IN_ORDER_TO_PREMIUM)
docs/guides/totp.md (2)
7-7: Prefer “first” over “firstly”.
Use “first” for a more natural instruction tone.
Proposed diff:-You firstly need to generate a TOTP secret, to do this you will need your current `username:hash`. +You first need to generate a TOTP secret; to do this, you will need your current `username:hash`.🧰 Tools
🪛 LanguageTool
[style] ~7-~7: Consider a more expressive alternative.
Context: ...stly need to generate a TOTP secret, to do this you will need your current `userna...(DO_ACHIEVE)
13-13: Fix grammar, punctuation, and terminology.
This sentence has punctuation gaps, a typo (“your” vs. “you”), and uses “login” incorrectly.
Proposed diff:-It will prompt you for your user and then give you _a massive_ QR code to scan with your authenticator app. After you add it you can copy your newly generated user (the part after the `user=` log message) and add it to your tinyauth user list and restart. Finally every time you try to login tinyauth will prompt your for your TOTP code. +It will prompt you for your user and then display _a massive_ QR code to scan with your authenticator app. After you scan it, copy the newly generated user (the text following the `user=` log message) into your Tinyauth user list and restart the service. Finally, each time you log in, Tinyauth will prompt you for your TOTP code.🧰 Tools
🪛 LanguageTool
[typographical] ~13-~13: Consider adding a comma here.
Context: ...h your authenticator app. After you add it you can copy your newly generated user ...(IF_COMMA)
[typographical] ~13-~13: Consider adding a comma after ‘Finally’ for more clarity.
Context: ...to your tinyauth user list and restart. Finally every time you try to login tinyauth wi...(RB_LY_COMMA)
[misspelling] ~13-~13: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ... restart. Finally every time you try to login tinyauth will prompt your for your TOTP...(LOG_IN)
docs/guides/github-oauth.md (8)
3-3: Use correct branding and hyphenation.Change "builtin" to "built-in" and "Github" to "GitHub" for consistency and accuracy.
-Tinyauth has builtin support for Github OAuth with just two environment variables. +Tinyauth has built-in support for GitHub OAuth with just two environment variables.
14-14: Avoid comma splice; break into clear sentences.Consider splitting the sentence to improve readability:
-The first thing you need to do is create a Github OAuth app, this can be done by going to the [Github developer settings](https://github.com/settings/developers) and clicking _New OAuth App_. +The first thing you need to do is create a GitHub OAuth app. Go to the [GitHub developer settings](https://github.com/settings/developers) and click _New OAuth App_.
32-32: Refine sentence structure and branding.Replace comma splice and update "Github" to "GitHub":
-Here make sure to note down your client ID. Now, let's create the client secret, this can be done by clicking the _Generate a new client secret_ button. +Here, make sure to note down your Client ID. Then click the _Generate a new client secret_ button to obtain your secret.🧰 Tools
🪛 LanguageTool
[uncategorized] ~32-~32: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...t, Github will prompt you to login again and then it will create your secret which i...(COMMA_COMPOUND_SENTENCE)
36-36: Correct branding and punctuation.Update "Github" to "GitHub" and split into two sentences:
-Make sure to note this down as well since we will need it later and that's it, we are done with Github. +Make sure to note this down as well since we will need it later. That’s it—we’re done with GitHub.
40-40: Consistent capitalization for Docker.Capitalize "Docker" to match branding and pluralize pronouns:
-Now that you have your client ID and secret, you can pass it to the tinyauth docker container: +Now that you have your Client ID and secret, pass them to the Tinyauth Docker container:
60-60: Grammar and verb usage.
- Add comma after intro clause.
- Use "log in" (verb) instead of "login".
- Update "Github" to "GitHub".
-OAuth doesn't mean security, with the current setup everybody with a Github account can login to Tinyauth as a normal user. +OAuth doesn’t mean security. With the current setup, everybody with a GitHub account can log in to Tinyauth as a normal user.🧰 Tools
🪛 LanguageTool
[misspelling] ~60-~60: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...tup everybody with a Github account can login to Tinyauth as a normal user. If you wo...(LOG_IN)
[misspelling] ~60-~60: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...you would like to limit which users can login with OAuth, you can add the `OAUTH_WHIT...(LOG_IN)
[uncategorized] ~60-~60: Possible missing comma found.
Context: ...w your email address to login. For more information check the [configuration](/docs/referen...(AI_HYDRA_LEO_MISSING_COMMA)
64-64: Fix typo and verb form.Change "ony" to "only" and use "log in":
-Since you have OAuth enabled, you can now remove the `USERS` or `USERS_FILE` environment variables so as you can ony login with your OAuth provider. +Since you have OAuth enabled, you can now remove the `USERS` or `USERS_FILE` environment variables so that you can only log in with your OAuth provider.
67-67: Consistent verb form and branding.Use "log in" and "GitHub":
-And you are done! After you restart tinyauth and try to login to an app, you should have an additional option to login with Github. +And you are done! After you restart Tinyauth and try to log in to an app, you should have an additional option to log in with GitHub.🧰 Tools
🪛 LanguageTool
[misspelling] ~67-~67: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...! After you restart tinyauth and try to login to an app, you should have an additiona...(LOG_IN)
[misspelling] ~67-~67: Did you mean the verb “log in”?
Context: ...you should have an additional option to login with Github.(LOG_IN)
docs/guides/google-oauth.md (5)
3-3: Improve sentence flow and tone.
- Add comma before "and".
- Consider replacing "extremely" with a stronger verb or dropping intensifier.
- Use "built-in" consistently.
-Tinyauth has builtin support for Google OAuth and it is extremely easy to set up. +Tinyauth has built-in support for Google OAuth, making setup straightforward.🧰 Tools
🪛 LanguageTool
[uncategorized] ~3-~3: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...uth has builtin support for Google OAuth and it is extremely easy to set up. It's a ...(COMMA_COMPOUND_SENTENCE)
[style] ~3-~3: As an alternative to the over-used intensifier ‘extremely’, consider replacing this phrase.
Context: ...ltin support for Google OAuth and it is extremely easy to set up. It's a bit harder than Githu...(EN_WEAK_ADJECTIVE)
[formatting] ~3-~3: Consider inserting a comma here, unless the first half is essential to the meaning of the sentence.
Context: ... a bit harder than Github but with this guide you should be up and running in less th...(WITH_THAT_COMMA)
14-14: Clarify description and remove redundancy.Combine sentences and add comma for readability:
-To begin with, you need to create an app in Google. This can be done by visiting the [Google Cloud Console](https://console.cloud.google.com/). +To begin, create an app in Google by visiting the [Google Cloud Console](https://console.cloud.google.com/).
60-60: Consistent capitalization and branding.Capitalize "Tinyauth" and "Docker" and clarify pronouns:
-Now that you have your client ID and secret, you can pass it to the tinyauth docker container: +Now that you have your Client ID and secret, pass them to the Tinyauth Docker container:
85-85: Fix typo and verb form.Correct "ony" to "only" and "login" to "log in":
-Since you have OAuth enabled, you can now remove the `USERS` or `USERS_FILE` environment variables so as you can ony login with your OAuth provider. +Since you have OAuth enabled, you can now remove the `USERS` or `USERS_FILE` environment variables so that you can only log in with your OAuth provider.
87-87: Consistent verb form.Use "log in" in both instances:
-And you are done! After you restart tinyauth and try to login to an app, you should have an additional option to login with Google. +And you are done! After you restart Tinyauth and try to log in to an app, you should have an additional option to log in with Google.🧰 Tools
🪛 LanguageTool
[misspelling] ~87-~87: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...! After you restart tinyauth and try to login to an app, you should have an additiona...(LOG_IN)
[misspelling] ~87-~87: Did you mean the verb “log in”?
Context: ...you should have an additional option to login with Google.(LOG_IN)
docs/community/kubernetes.md (5)
24-24: Prefer "First" over "Firstly".For clearer and more concise instructions, replace "Firstly" with "First":
-Firstly, you will need to create a namespace for tinyauth: +First, you will need to create a namespace for Tinyauth:
33-33: Heading case consistency.Change "Create a secret" to title case "Create a Secret" for consistency with other section headings:
-### Create a secret +### Create a Secret
37-37: Clarify command description.The sentence is verbose and can be simplified:
-Next, base64 encode the generated secret key, replacing `your-generated-secret` with the actual generated secret, using the following command: +Next, encode your generated secret key in base64 by running:
58-58: Capitalize product name and tighten phrasing.Capitalize "Tinyauth" and streamline:
-Now it's time to create the tinyauth deployment: +Next, create the Tinyauth Deployment:
104-104: Add comma after "Finally".Improve readability by inserting a comma:
-Finally create the service: +Finally, create the Service:docs/guides/access-controls.md (5)
48-48: Insert missing comma and article.Add a comma after "work" and ensure article usage for clarity:
-In order for the access controls to work the app must have the same container name as the subdomain it is exposed at, e.g. container name should be `hello` and the app should be exposed at `hello.example.com`. +In order for the access controls to work, the app must have the same container name as the subdomain it is exposed at, e.g., the container name should be `hello` and the app should be exposed at `hello.example.com`.🧰 Tools
🪛 LanguageTool
[uncategorized] ~48-~48: A comma might be missing here.
Context: ...ing In order for the access controls to work the app must have the same container na...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~48-~48: You might be missing the article “the” here.
Context: ...as the subdomain it is exposed at, e.g. container name should behelloand the app shou...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
51-51: Clarify regex syntax description.Specify that the pattern must be enclosed in slashes and can include flags:
-The OAuth and user whitelist can be a regular regex expression if it has the slash (`/`) prefix and suffix. +The OAuth and user whitelist can also be a regular expression if the pattern is enclosed between slashes (e.g., `/^user@.*\.example\.com$/`).
55-55: Heading rephrase for parallelism.Consider adjusting to match other headings:
-## Access controls using OIDC groups +## Access Controls Using OIDC Groups
57-57: Improve sentence flow and punctuation.Add commas and refine wording:
-Some proxies like pocket ID support user groups in the OIDC response. If your OIDC server supports this you can use groups to do access controls. +Some proxies, such as Pocket ID, support user groups in the OIDC response. If your OIDC server supports this, you can use groups to enforce access controls.🧰 Tools
🪛 LanguageTool
[uncategorized] ~57-~57: A comma might be missing here.
Context: ... response. If your OIDC server supports this you can use groups to do access control...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~57-~57: A comma might be missing here.
Context: ... groups to do access controls. To begin with you will need to make sure that the `GE...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[grammar] ~57-~57: Did you mean “do”? ‘does’ is only used for the third person singular (he/she/it).
Context: ...thegroupsscope. After you ensure it does you can modify your app like this: ```...(DOES_YOU)
74-74: Comma and branding consistency.Add comma before "not" and capitalize "GitHub":
-The OAuth groups label is only supported for the generic OAuth provider **_not_** for Google or Github. +The OAuth groups label is only supported for the generic OAuth provider, **_not_** for Google or GitHub.docs/community/zitadel-oauth.md (6)
16-16: Streamline instructions and add a direct link.To improve clarity, merge sentences and provide a link to the console:
-To begin with, you need to create an app in Zitadel. This can be done by visiting the Zitadel Console. +To begin, create an app in Zitadel by visiting the [Zitadel Console](https://console.zitadel.com/) and creating a new project. Use "Tinyauth" as the project name.
30-30: Avoid comma splice; split into two sentences.Separate actions for clarity:
-Finalize by clicking on the _Create_ button, and copy the client ID and the client secret. +Click the _Create_ button to finalize the application setup. Then copy the Client ID and Client Secret.
40-40: Consistent capitalization and pronoun agreement.Capitalize product name and use plural pronouns:
-Now that you have your Client ID and Secret, you can pass it to the tinyauth docker container: +Now that you have your Client ID and Secret, pass them to the Tinyauth Docker container:
50-50: Clarify example value for GENERIC_SCOPES.Add context that this is an example and ensure readability:
- - GENERIC_SCOPES=openid profile email preferred_username groups + - GENERIC_SCOPES="openid profile email preferred_username groups" # example scopes to request user groups
71-71: Fix typo and verb usage.Correct "ony" to "only" and use "log in":
-Since you have OAuth enabled, you can now remove the `USERS` or `USERS_FILE` environment variables so as you can ony login with your OAuth provider. +Since you have OAuth enabled, you can now remove the `USERS` or `USERS_FILE` environment variables so that you can only log in with your OAuth provider.
74-74: Consistent verb form and branding.Use "log in" and capitalize Tinyauth:
-And you are done! After you restart tinyauth and try to login to an app, you should have an additional option to login with Zitadel. +And you are done! After you restart Tinyauth and try to log in to an app, you should have an additional option to log in with Zitadel.🧰 Tools
🪛 LanguageTool
[misspelling] ~74-~74: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...! After you restart tinyauth and try to login to an app, you should have an additiona...(LOG_IN)
[misspelling] ~74-~74: Did you mean the verb “log in”?
Context: ...you should have an additional option to login with Zitadel.(LOG_IN)
docs/reference/cli.md (7)
3-3: Consider toning down the intensifier.
The phrase “very simple CLI” could be more concise and impactful if you remove “very” or replace it with a stronger adjective (e.g., “straightforward” or “lightweight”).🧰 Tools
🪛 LanguageTool
[style] ~3-~3: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: # CLI Tinyauth offers a very simple CLI that aims to help you to configure ...(EN_WEAK_ADJECTIVE)
7-7: Refine wording for clarity.
Consider rephrasing “All commands can be run when the app is run as a binary” to “All commands can be run when you execute the app as a binary” or simply “All commands can be run in binary mode.”
29-29: Add missing comma.
Insert a comma after “To create a user” for improved readability:- To create a user simply run: + To create a user, simply run:🧰 Tools
🪛 LanguageTool
[uncategorized] ~29-~29: Possible missing comma found.
Context: ...ing to use any other tools. To create a user simply run: ```sh ./tinyauth user crea...(AI_HYDRA_LEO_MISSING_COMMA)
35-35: Improve punctuation and hyphenation.
Multiple small adjustments can enhance clarity:- This command will launch an interactive TUI where you can provide a username and a password and it will generate the `username:hash` format required by the app. It can also auto format it for docker if you would like to use it within a docker compose file. Apart from the interactive mode you can also create a user with flags: + This command launches an interactive TUI, where you can provide a username and a password, and it generates the `username:hash` format required by the app. It can also auto-format it for Docker if you’d like to use it within a Docker Compose file. Apart from interactive mode, you can also create a user with flags:🧰 Tools
🪛 LanguageTool
[uncategorized] ~35-~35: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ou can provide a username and a password and it will generate theusername:hashfo...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~35-~35: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...format required by the app. It can also auto format it for docker if you would like to use ...(AUTO_HYPHEN)
[uncategorized] ~35-~35: Possible missing comma found.
Context: ...ompose file. Apart from the interactive mode you can also create a user with flags: ...(AI_HYDRA_LEO_MISSING_COMMA)
65-65: Insert comma before “so”.
Add a comma for compound sentence correctness:- Make sure to use quotes (`'`) when typing this in a bash shell so your hash gets passed correctly to tinyauth. + Make sure to use quotes (`'`) when typing this in a bash shell, so your hash gets passed correctly to tinyauth.🧰 Tools
🪛 LanguageTool
[uncategorized] ~65-~65: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...s (') when typing this in a bash shell so your hash gets passed correctly to tiny...(COMMA_COMPOUND_SENTENCE_2)
79-79: Hyphenate “auto-generate”.
Consider changing “auto generate” to “auto-generate” for consistency and to match common usage:- Tinyauth can auto generate TOTP codes for you… + Tinyauth can auto-generate TOTP codes for you…🧰 Tools
🪛 LanguageTool
[uncategorized] ~79-~79: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...### Generate TOTP command Tinyauth can auto generate TOTP codes for you, the combination is ...(AUTO_HYPHEN)
92-92: Insert comma before “so”.
Same as above, add a comma before “so” to correctly join the clauses:- Make sure to use quotes (`'`) when typing this in a bash shell so your hash gets passed correctly to tinyauth. + Make sure to use quotes (`'`) when typing this in a bash shell, so your hash gets passed correctly to tinyauth.🧰 Tools
🪛 LanguageTool
[uncategorized] ~92-~92: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...s (') when typing this in a bash shell so your hash gets passed correctly to tiny...(COMMA_COMPOUND_SENTENCE_2)
docs/guides/github-app-oauth.md (8)
14-14: Prefer “First” over “Firstly”.
To align with common style guides, consider replacing “Firstly” with “First” or “To begin,” for a more direct tone.
18-18: Clarify directional adverb.
You might replace “There you need to fill in the following information:” with “Here you need to fill in the following information:” to keep the focus on the current step.
36-36: Add comma before “but”.
Insert a comma for the compound sentence:- You may need to authenticate again but once you do, it will appear like this: + You may need to authenticate again, but once you do, it will appear like this:🧰 Tools
🪛 LanguageTool
[uncategorized] ~36-~36: A comma might be missing here.
Context: ...t_ button. You may need to authenticate again but once you do, it will appear like th...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
40-40: Insert comma before “and”.
Enhance readability by adding a comma before “and”:- Make sure to also note this down as it will not be available again and you will need it for tinyauth. + Make sure to also note this down, as it will not be available again, and you will need it for tinyauth.🧰 Tools
🪛 LanguageTool
[uncategorized] ~40-~40: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...s down as it will not be available again and you will need it for tinyauth. ## Conf...(COMMA_COMPOUND_SENTENCE)
44-44: Correct pronoun number and capitalize Docker.
Update the pronoun and proper noun capitalization for clarity:- Now that you have your client ID and secret, you can pass it to the tinyauth docker container: + Now that you have your client ID and secret, you can pass them to the Tinyauth Docker container:
64-64: Reword warning and correct “login” usage.
Split the warning into two sentences and use “log in” where appropriate:- OAuth doesn't mean security, with the current setup everybody with a Github account can login to Tinyauth as a normal user. + OAuth doesn't guarantee security. With the current setup, anybody with a GitHub account can log in to Tinyauth as a normal user.🧰 Tools
🪛 LanguageTool
[uncategorized] ~64-~64: A comma might be missing here.
Context: ...doesn't mean security, with the current setup everybody with a Github account can log...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[misspelling] ~64-~64: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...tup everybody with a Github account can login to Tinyauth as a normal user. If you wo...(LOG_IN)
[misspelling] ~64-~64: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...you would like to limit which users can login with OAuth, you can add the `OAUTH_WHIT...(LOG_IN)
68-68: Fix typo and verb form.
Replace “ony” with “only” and use the verb form “log in”:- so as you can ony login with your OAuth provider. + so you can only log in with your OAuth provider.
71-71: Correct “login” verb usage.
Use “log in” for the action and simplify phrasing:- After you restart tinyauth and try to login to an app, you should have an additional option to login with Github. + After restarting Tinyauth and attempting to log in to an app, you’ll see an option to log in with GitHub.🧰 Tools
🪛 LanguageTool
[misspelling] ~71-~71: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...! After you restart tinyauth and try to login to an app, you should have an additiona...(LOG_IN)
[misspelling] ~71-~71: Did you mean the verb “log in”?
Context: ...you should have an additional option to login with Github.(LOG_IN)
docs/reference/api.md (3)
3-3: Remove weak intensifier and redundant “of”.
Consider dropping “very” and “of” for a more concise opening:- Tinyauth has a very simple API used for both the reverse proxies and the web UI. All of the available endpoints are listed below. + Tinyauth has a simple API used by reverse proxies and the web UI. All available endpoints are listed below.🧰 Tools
🪛 LanguageTool
[style] ~3-~3: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: # API Tinyauth has a very simple API used for both the reverse proxies a...(EN_WEAK_ADJECTIVE)
[style] ~3-~3: Consider removing “of” to be more concise
Context: ...oth the reverse proxies and the web UI. All of the available endpoints are listed below. ...(ALL_OF_THE)
58-58: Clarify proxy type.
For consistency with the intro, consider changing “proxies” to “reverse proxies”:- Authentication endpoint used by proxies. + Authentication endpoint used by reverse proxies.
180-193: Suggest using boolean for totpPending.
In the/api/userexample,"totpPending": "false"is a string. If the API returns a boolean in other contexts, consider updating it to:- "totpPending": "false" + "totpPending": falseThis ensures type consistency across responses.
docs/guides/runtipi.md (6)
3-3: Hyphenate and refine intensifier.
Consider changing “very popular open source” to “popular open-source” and removing “very”:- Runtipi is a very popular open source personal homeserver helper… + Runtipi is a popular open-source personal homeserver helper…🧰 Tools
🪛 LanguageTool
[uncategorized] ~3-~3: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...with Runtipi Runtipi is a very popular open source personal homeserver helper that enables...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~3-~3: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...ebsite](https://runtipi.io). Due to the very powerful proxy features it offers, it can be eas...(EN_WEAK_ADJECTIVE)
7-7: Add comma and improve flow.
Insert a comma after “users” and restructure to avoid “firstly”:- You firstly need to create your users, this can be done with the tinyauth CLI. Make sure to select yes in the format for docker option else tinyauth won't be able to parse the user. + First, create your users using the Tinyauth CLI. Make sure to select “yes” for the Docker format option; otherwise, Tinyauth won't be able to parse the user.🧰 Tools
🪛 LanguageTool
[uncategorized] ~7-~7: A comma might be missing here.
Context: ... to select yes in the format for docker option else tinyauth won't be able to parse th...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
9-9: Insert comma and split sentence.
Enhance readability by adding a comma before “so” and splitting into two sentences:- The runtipi app also includes inputs for Github and Google, so if you would like to use OAuth you can follow the OAuth guides and note down your client IDs and secrets. + The Runtipi app also includes inputs for GitHub and Google. If you’d like to use OAuth, follow the OAuth guides and note down your client IDs and secrets.🧰 Tools
🪛 LanguageTool
[uncategorized] ~9-~9: Possible missing comma found.
Context: ...and Google, so if you would like to use OAuth you can follow the OAuth guides and not...(AI_HYDRA_LEO_MISSING_COMMA)
17-17: Avoid starting with “And”.
Begin the step more directly and use an imperative:- And setting the forward auth URL to `http://tinyauth:3000/api/auth/traefik`: + Then set the forward auth URL to `http://tinyauth:3000/api/auth/traefik`:
24-24: Clarify version and add comma.
Rephrase for clarity and proper noun capitalization, and insert a comma:- From runtipi version v4 multiple app stores are supported. + From Runtipi version 4 onward, multiple app stores are supported.
29-29: Split long sentence and add punctuation.
Break into shorter sentences and add commas/articles for clarity:- Now we can go to the app store tab, click the tinyauth app, fill in our users, OAuth credentials and any other information you like. But before we click install we need to either flip the local domain switch or the expose switch to expose tinyauth to a domain. This is required for tinyauth to function as it will not be able to set the cookies correctly through the port. So, depending on your setup either use your local domain as an app URL or the expose domain as app URL (in either case you should use https). Finally click install and everything should be good to go. + Go to the App Store tab, click the Tinyauth app, and fill in your users, OAuth credentials, and any other information you like. Before installing, flip either the Local Domain switch or the Expose switch to expose Tinyauth to a domain; this is required because Tinyauth cannot set cookies correctly through a port. Depending on your setup, use your local domain as the App URL or the expose domain as the App URL (in either case, use HTTPS). Finally, click Install to complete the setup.🧰 Tools
🪛 LanguageTool
[uncategorized] ~29-~29: Possible missing comma found.
Context: ...formation you like. But before we click install we need to either flip the local domain...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~29-~29: Possible missing comma found.
Context: ...omain. This is required for tinyauth to function as it will not be able to set the cooki...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~29-~29: A comma might be missing here.
Context: ...through the port. So, depending on your setup either use your local domain as an app ...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~29-~29: Possible missing article found.
Context: ...n as an app URL or the expose domain as app URL (in either case you should use http...(AI_HYDRA_LEO_MISSING_AN)
[uncategorized] ~29-~29: Possible missing comma found.
Context: ... (in either case you should use https). Finally click install and everything should be ...(AI_HYDRA_LEO_MISSING_COMMA)
docs/reference/headers.md (9)
3-3: Correct collocation “returned in” → “returned to”.
Change for standard phrasing:- while tinyauth offers some defaults, it also allows you to set any headers you like that will be automatically returned in the authentication server response. + while tinyauth offers some defaults, it also allows you to set any headers you like that will be automatically returned to the authentication server response.🧰 Tools
🪛 LanguageTool
[grammar] ~3-~3: The usual collocation for “returned” is “to”, not “in”.
Context: ...ers you like that will be automatically returned in the authentication server response. ##...(RETURN_IN_THE)
9-9: Hyphenate “logged-in”.
Standardize the modifier with a hyphen:- currently logged in user + currently logged-in user🧰 Tools
🪛 LanguageTool
[grammar] ~9-~9: When ‘logged-in’ is used as a modifier, it is usually spelled with a hyphen.
Context: ... contains the username of the currently logged in user. If you are using an OAuth provid...(LOGGED_IN_HYPHEN)
15-15: Hyphenate “logged-in”.
Apply consistent modifier punctuation:- currently logged in user + currently logged-in user🧰 Tools
🪛 LanguageTool
[grammar] ~15-~15: When ‘logged-in’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...der contains the email of the currently logged in user. If you are using simple username...(LOGGED_IN_HYPHEN)
21-21: Hyphenate “logged-in”.
Maintain modifier consistency:- currently logged in user + currently logged-in user🧰 Tools
🪛 LanguageTool
[grammar] ~21-~21: When ‘logged-in’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...contains the full name of the currently logged in user. If you are using simple username...(LOGGED_IN_HYPHEN)
23-23: Remove duplicate “either” and refine.
There is a duplicated “either”:- a pseudo name will be created either with either your username… + a pseudo name will be created with your username…
27-27: Hyphenate “logged-in”.
Maintain modifier consistency:- currently logged in user + currently logged-in user🧰 Tools
🪛 LanguageTool
[grammar] ~27-~27: When ‘logged-in’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...er contains the groups of the currently logged in user. They are retrieved from the `grou...(LOGGED_IN_HYPHEN)
44-44: Add comma and use more formal verb.
Improve punctuation and formality:- This is a temporary issue and it will be fixed in a future update. + This is a temporary issue, and it will be resolved in a future update.🧰 Tools
🪛 LanguageTool
[uncategorized] ~44-~44: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...up the labels. This is a temporary issue and it will be fixed in a future update. ::...(COMMA_COMPOUND_SENTENCE)
[style] ~44-~44: Consider using a different verb for a more formal wording.
Context: ...his is a temporary issue and it will be fixed in a future update. ::: ## Adding head...(FIX_RESOLVE)
49-49: Insert comma before dependent clause.
Enhance readability:- To add the headers to the proxy responses you need to tell your proxy to forward the headers. + To add the headers to the proxy responses, you need to tell your proxy to forward them.🧰 Tools
🪛 LanguageTool
[uncategorized] ~49-~49: Possible missing comma found.
Context: ... proxy To add the headers to the proxy responses you need to tell your proxy to forward ...(AI_HYDRA_LEO_MISSING_COMMA)
53-53: Fix typo “lables” → “labels”.
Correct the spelling:- tinyauth container lables: + tinyauth container labels:docs/reference/configuration.md (3)
9-10: Add missing comma and capitalize Docker.In the sentence "In this case you shouldn't use quotes...", add a comma after "In this case," and capitalize "Docker" for consistency.
-In this case you **_shouldn't_** use quotes as docker can handle them. +In this case, you **_shouldn't_** use quotes as Docker can handle them.🧰 Tools
🪛 LanguageTool
[formatting] ~10-~10: Consider inserting a comma after an introductory phrase for better readability.
Context: ...GENERIC_SCOPES=openid profile email). In this case you shouldn't use quotes as docke...(IN_THAT_CASE_COMMA)
17-31: Use correct verb form "log in".Instances of "login" in the action context should use the verb form "log in". For consistency, update the following rows:
-| `OAUTH_WHITELIST`/`--oauth-whitelist` | A list of usernames that are allowed to login with OAuth (can be a regex if it has the slash prefix and suffix). | - | no | +| `OAUTH_WHITELIST`/`--oauth-whitelist` | A list of usernames that are allowed to log in with OAuth (can be a regex if it has the slash prefix and suffix). | - | no | -| `LOGIN_MAX_RETRIES`/`--login-max-retries` | The max retries to login after which the account gets locked. | 5 | no | +| `LOGIN_MAX_RETRIES`/`--login-max-retries` | The max retries to log in after which the account gets locked. | 5 | no |🧰 Tools
🪛 LanguageTool
[uncategorized] ~18-~18: A punctuation mark might be missing here.
Context: ... | no | |ADDRESS/--address| The a...(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~20-~20: A punctuation mark might be missing here.
Context: ... | yes | |SECRET/--secret| The...(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~21-~21: A punctuation mark might be missing here.
Context: ... | yes | |USERS/--users| A...(AI_EN_LECTOR_MISSING_PUNCTUATION)
[misspelling] ~26-~26: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...A list of usernames that are allowed to login with OAuth (can be a regex if it has th...(LOG_IN)
[misspelling] ~30-~30: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...tries` | The max retries to login after which the account gets locked. ...(LOG_IN)
32-33: Improve default value formatting and list spacing.The default message and option list formatting can be simplified and spaced for clarity:
-| `FORGOT_PASSWORD_MESSAGE`/`--forgot-password-message` | Set a custom message for the forgot password screen. | `` You can reset your password by changing the `USERS` environment variable." `` | no | +| `FORGOT_PASSWORD_MESSAGE`/`--forgot-password-message` | Set a custom message for the forgot password screen. | `You can reset your password by changing the USERS environment variable.` | no | -| `OAUTH_AUTO_REDIRECT`/`--oauth-auto-redirect` | Automatically redirect to your OAuth provider on login (available options are `none`,`github`,`google` and `generic`). | `none` | no | +| `OAUTH_AUTO_REDIRECT`/`--oauth-auto-redirect` | Automatically redirect to your OAuth provider on login (available options are `none`, `github`, `google`, and `generic`). | `none` | no |
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (21)
docs/about.md(1 hunks)docs/community/caddy.md(1 hunks)docs/community/kubernetes.md(4 hunks)docs/community/zitadel-oauth.md(5 hunks)docs/contributing.md(4 hunks)docs/getting-started.md(2 hunks)docs/guides/access-controls.md(1 hunks)docs/guides/allowed-paths.md(1 hunks)docs/guides/github-app-oauth.md(3 hunks)docs/guides/github-oauth.md(4 hunks)docs/guides/google-oauth.md(4 hunks)docs/guides/nginx-proxy-manager.md(2 hunks)docs/guides/runtipi.md(1 hunks)docs/guides/totp.md(1 hunks)docs/guides/using-the-binary.md(1 hunks)docs/reference/api.md(4 hunks)docs/reference/cli.md(4 hunks)docs/reference/configuration.md(1 hunks)docs/reference/flow.md(1 hunks)docs/reference/headers.md(2 hunks)index.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/reference/flow.md
[style] ~3-~3: As an alternative to the over-used intensifier ‘really’, consider replacing this phrase.
Context: # Flow Tinyauth is a really simple application. The way the authentication...
(EN_WEAK_ADJECTIVE)
docs/getting-started.md
[style] ~3-~3: As an alternative to the over-used intensifier ‘extremely’, consider replacing this phrase.
Context: ...tting Started As promised, tinyauth is extremely easy to get up and running. ::: info Tinyau...
(EN_WEAK_ADJECTIVE)
[style] ~48-~48: Consider a more concise word here.
Context: ...th will set a cookie for .example.com in order to be able to authenticate you. This means...
(IN_ORDER_TO_PREMIUM)
docs/guides/totp.md
[style] ~7-~7: Consider a more expressive alternative.
Context: ...stly need to generate a TOTP secret, to do this you will need your current `userna...
(DO_ACHIEVE)
[typographical] ~13-~13: Consider adding a comma here.
Context: ...h your authenticator app. After you add it you can copy your newly generated user ...
(IF_COMMA)
[typographical] ~13-~13: Consider adding a comma after ‘Finally’ for more clarity.
Context: ...to your tinyauth user list and restart. Finally every time you try to login tinyauth wi...
(RB_LY_COMMA)
[misspelling] ~13-~13: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ... restart. Finally every time you try to login tinyauth will prompt your for your TOTP...
(LOG_IN)
docs/reference/cli.md
[style] ~3-~3: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: # CLI Tinyauth offers a very simple CLI that aims to help you to configure ...
(EN_WEAK_ADJECTIVE)
[uncategorized] ~29-~29: Possible missing comma found.
Context: ...ing to use any other tools. To create a user simply run: ```sh ./tinyauth user crea...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~35-~35: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ou can provide a username and a password and it will generate the username:hash fo...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~35-~35: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...format required by the app. It can also auto format it for docker if you would like to use ...
(AUTO_HYPHEN)
[uncategorized] ~35-~35: Possible missing comma found.
Context: ...ompose file. Apart from the interactive mode you can also create a user with flags: ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~52-~52: Possible missing comma found.
Context: ... match with the username:hash. To use it just run: ```sh ./tinyauth user verify...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~58-~58: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... combination, your username and password and then it will check if the credentials m...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~65-~65: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...s (') when typing this in a bash shell so your hash gets passed correctly to tiny...
(COMMA_COMPOUND_SENTENCE_2)
[uncategorized] ~79-~79: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...### Generate TOTP command Tinyauth can auto generate TOTP codes for you, the combination is ...
(AUTO_HYPHEN)
[style] ~85-~85: This phrase is redundant. Consider writing “alongside” or “with”.
Context: ... new user (username:hash:totp-secret) alongside with a QR code so as you can add it to your ...
(ALONGSIDE_WITH)
[uncategorized] ~92-~92: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...s (') when typing this in a bash shell so your hash gets passed correctly to tiny...
(COMMA_COMPOUND_SENTENCE_2)
docs/contributing.md
[uncategorized] ~3-~3: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... you just need to follow the steps below and you will be up and running with a devel...
(COMMA_COMPOUND_SENTENCE)
[grammar] ~23-~23: The verb ‘recommend’ is used with the gerund form.
Context: ...elopment will happen in docker, I still recommend to install them because this way you will not have...
(ADMIT_ENJOY_VB)
[typographical] ~38-~38: It seems that a comma is missing.
Context: ... .env file In order to configure the app you need to create an environment file,...
(IN_ORDER_TO_VB_COMMA)
[style] ~38-~38: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...file In order to configure the app you need to create an environment file, this can be...
(REP_NEED_TO_VB)
docs/reference/api.md
[style] ~3-~3: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: # API Tinyauth has a very simple API used for both the reverse proxies a...
(EN_WEAK_ADJECTIVE)
[style] ~3-~3: Consider removing “of” to be more concise
Context: ...oth the reverse proxies and the web UI. All of the available endpoints are listed below. ...
(ALL_OF_THE)
docs/guides/google-oauth.md
[uncategorized] ~3-~3: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...uth has builtin support for Google OAuth and it is extremely easy to set up. It's a ...
(COMMA_COMPOUND_SENTENCE)
[style] ~3-~3: As an alternative to the over-used intensifier ‘extremely’, consider replacing this phrase.
Context: ...ltin support for Google OAuth and it is extremely easy to set up. It's a bit harder than Githu...
(EN_WEAK_ADJECTIVE)
[formatting] ~3-~3: Consider inserting a comma here, unless the first half is essential to the meaning of the sentence.
Context: ... a bit harder than Github but with this guide you should be up and running in less th...
(WITH_THAT_COMMA)
[uncategorized] ~80-~80: A comma might be missing here.
Context: ...doesn't mean security, with the current setup everybody with a Github account can log...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[misspelling] ~80-~80: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...tup everybody with a Github account can login to Tinyauth as a normal user. If you wo...
(LOG_IN)
[misspelling] ~80-~80: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...you would like to limit which users can login with OAuth, you can add the `OAUTH_WHIT...
(LOG_IN)
[misspelling] ~87-~87: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...! After you restart tinyauth and try to login to an app, you should have an additiona...
(LOG_IN)
[misspelling] ~87-~87: Did you mean the verb “log in”?
Context: ...you should have an additional option to login with Google.
(LOG_IN)
docs/guides/access-controls.md
[uncategorized] ~48-~48: A comma might be missing here.
Context: ...ing In order for the access controls to work the app must have the same container na...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~48-~48: You might be missing the article “the” here.
Context: ...as the subdomain it is exposed at, e.g. container name should be hello and the app shou...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~57-~57: A comma might be missing here.
Context: ... response. If your OIDC server supports this you can use groups to do access control...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~57-~57: A comma might be missing here.
Context: ... groups to do access controls. To begin with you will need to make sure that the `GE...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[grammar] ~57-~57: Did you mean “do”? ‘does’ is only used for the third person singular (he/she/it).
Context: ...the groups scope. After you ensure it does you can modify your app like this: ```...
(DOES_YOU)
docs/reference/headers.md
[grammar] ~3-~3: The usual collocation for “returned” is “to”, not “in”.
Context: ...ers you like that will be automatically returned in the authentication server response. ##...
(RETURN_IN_THE)
[grammar] ~9-~9: When ‘logged-in’ is used as a modifier, it is usually spelled with a hyphen.
Context: ... contains the username of the currently logged in user. If you are using an OAuth provid...
(LOGGED_IN_HYPHEN)
[grammar] ~15-~15: When ‘logged-in’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...der contains the email of the currently logged in user. If you are using simple username...
(LOGGED_IN_HYPHEN)
[grammar] ~21-~21: When ‘logged-in’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...contains the full name of the currently logged in user. If you are using simple username...
(LOGGED_IN_HYPHEN)
[grammar] ~27-~27: When ‘logged-in’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...er contains the groups of the currently logged in user. They are retrieved from the `grou...
(LOGGED_IN_HYPHEN)
[uncategorized] ~44-~44: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...up the labels. This is a temporary issue and it will be fixed in a future update. ::...
(COMMA_COMPOUND_SENTENCE)
[style] ~44-~44: Consider using a different verb for a more formal wording.
Context: ...his is a temporary issue and it will be fixed in a future update. ::: ## Adding head...
(FIX_RESOLVE)
[uncategorized] ~49-~49: Possible missing comma found.
Context: ... proxy To add the headers to the proxy responses you need to tell your proxy to forward ...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/community/zitadel-oauth.md
[uncategorized] ~67-~67: A comma might be missing here.
Context: ...doesn't mean security, with the current setup everybody with a Github account can log...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[misspelling] ~67-~67: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...tup everybody with a Github account can login to Tinyauth as a normal user. If you wo...
(LOG_IN)
[misspelling] ~67-~67: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...you would like to limit which users can login with OAuth, you can add the `OAUTH_WHIT...
(LOG_IN)
[uncategorized] ~67-~67: Possible missing comma found.
Context: ...w your email address to login. For more information check the [configuration](/docs/referen...
(AI_HYDRA_LEO_MISSING_COMMA)
[misspelling] ~74-~74: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...! After you restart tinyauth and try to login to an app, you should have an additiona...
(LOG_IN)
[misspelling] ~74-~74: Did you mean the verb “log in”?
Context: ...you should have an additional option to login with Zitadel.
(LOG_IN)
docs/community/kubernetes.md
[uncategorized] ~103-~103: Possible missing comma found.
Context: ... port: 3000 ### Create a Service Finally create the service: yaml apiVersion...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/guides/github-oauth.md
[uncategorized] ~32-~32: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...t, Github will prompt you to login again and then it will create your secret which i...
(COMMA_COMPOUND_SENTENCE)
[misspelling] ~60-~60: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...tup everybody with a Github account can login to Tinyauth as a normal user. If you wo...
(LOG_IN)
[misspelling] ~60-~60: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...you would like to limit which users can login with OAuth, you can add the `OAUTH_WHIT...
(LOG_IN)
[uncategorized] ~60-~60: Possible missing comma found.
Context: ...w your email address to login. For more information check the [configuration](/docs/referen...
(AI_HYDRA_LEO_MISSING_COMMA)
[misspelling] ~67-~67: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...! After you restart tinyauth and try to login to an app, you should have an additiona...
(LOG_IN)
[misspelling] ~67-~67: Did you mean the verb “log in”?
Context: ...you should have an additional option to login with Github.
(LOG_IN)
docs/about.md
[uncategorized] ~7-~7: Possible missing comma found.
Context: ...tect them when they don't offer a login screen or just to add an additional layer of a...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~7-~7: This phrase might be redundant. Consider either removing or replacing the adjective ‘additional’.
Context: ...y don't offer a login screen or just to add an additional layer of authentication. While the projects m...
(ADD_AN_ADDITIONAL)
[style] ~7-~7: Consider using a more concise synonym.
Context: ...bove can certainly do the job and offer a variety of configuration options, they can be hard...
(A_VARIETY_OF)
[style] ~7-~7: To elevate your writing, try using a synonym here.
Context: ...y of configuration options, they can be hard to configure for new users, resource hu...
(HARD_TO)
[uncategorized] ~11-~11: Possible missing comma found.
Context: ... wide variety of authentication projects but most of them didn't even support traefi...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~11-~11: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...rt traefik's forward auth out of the box and they needed weird plugins requiring mor...
(COMMA_COMPOUND_SENTENCE)
[grammar] ~15-~15: The usual collocation for technology is “on”, not “in”.
Context: ...nyauth secure enough to even be exposed in the internet, it has some limitations like being com...
(IN_THE_INTERNET)
[uncategorized] ~15-~15: A comma might be missing here.
Context: ...upport more advanced backends (like LDAP) my recommendation is Authentik. ## The...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~17-~17: ‘future plans’ might be wordy. Consider a shorter alternative.
Context: ...my recommendation is Authentik. ## The future plans for tinyauth Tinyauth has reached a re...
(EN_WORDINESS_PREMIUM_FUTURE_PLANS)
[style] ~19-~19: As an alternative to the over-used intensifier ‘really’, consider replacing this phrase.
Context: ...lans for tinyauth Tinyauth has reached a really good state where it supports almost everythi...
(EN_WEAK_ADJECTIVE)
[typographical] ~19-~19: To make your text more readable, consider placing this phrase between commas.
Context: ... from an app like this. It supports what I believe are the most important features like OA...
(WHICH_I_THOUGHT_COMMA)
[uncategorized] ~19-~19: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ike OAuth, TOTP and even access controls and it also integrates very well with the m...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~19-~19: Possible missing comma found.
Context: ...d any fancy dashboards or configuration files since I do not want to change the proje...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/guides/runtipi.md
[uncategorized] ~3-~3: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...with Runtipi Runtipi is a very popular open source personal homeserver helper that enables...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~3-~3: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...ebsite](https://runtipi.io). Due to the very powerful proxy features it offers, it can be eas...
(EN_WEAK_ADJECTIVE)
[uncategorized] ~7-~7: A comma might be missing here.
Context: ... to select yes in the format for docker option else tinyauth won't be able to parse th...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~9-~9: Possible missing comma found.
Context: ...and Google, so if you would like to use OAuth you can follow the OAuth guides and not...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~20-~20: A comma might be missing here.
Context: ...eenshots/runtipi-forward-auth-url.png) Finally make sure to save your settings and res...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~29-~29: Possible missing comma found.
Context: ...formation you like. But before we click install we need to either flip the local domain...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~29-~29: Possible missing comma found.
Context: ...omain. This is required for tinyauth to function as it will not be able to set the cooki...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~29-~29: A comma might be missing here.
Context: ...through the port. So, depending on your setup either use your local domain as an app ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~29-~29: Possible missing article found.
Context: ...n as an app URL or the expose domain as app URL (in either case you should use http...
(AI_HYDRA_LEO_MISSING_AN)
[uncategorized] ~29-~29: Possible missing comma found.
Context: ... (in either case you should use https). Finally click install and everything should be ...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/guides/github-app-oauth.md
[uncategorized] ~17-~17: Possible missing comma found.
Context: ...reen](/screenshots/github-app-new.png) There you need to fill in the following infor...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~36-~36: A comma might be missing here.
Context: ...t_ button. You may need to authenticate again but once you do, it will appear like th...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~40-~40: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...s down as it will not be available again and you will need it for tinyauth. ## Conf...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~64-~64: A comma might be missing here.
Context: ...doesn't mean security, with the current setup everybody with a Github account can log...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[misspelling] ~64-~64: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...tup everybody with a Github account can login to Tinyauth as a normal user. If you wo...
(LOG_IN)
[misspelling] ~64-~64: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...you would like to limit which users can login with OAuth, you can add the `OAUTH_WHIT...
(LOG_IN)
[misspelling] ~71-~71: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...! After you restart tinyauth and try to login to an app, you should have an additiona...
(LOG_IN)
[misspelling] ~71-~71: Did you mean the verb “log in”?
Context: ...you should have an additional option to login with Github.
(LOG_IN)
docs/reference/configuration.md
[formatting] ~10-~10: Consider inserting a comma after an introductory phrase for better readability.
Context: ...GENERIC_SCOPES=openid profile email). In this case you shouldn't use quotes as docke...
(IN_THAT_CASE_COMMA)
[uncategorized] ~18-~18: A punctuation mark might be missing here.
Context: ... | no | | ADDRESS/--address | The a...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~20-~20: A punctuation mark might be missing here.
Context: ... | yes | | SECRET/--secret | The...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~21-~21: A punctuation mark might be missing here.
Context: ... | yes | | USERS/--users | A...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
[misspelling] ~26-~26: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...A list of usernames that are allowed to login with OAuth (can be a regex if it has th...
(LOG_IN)
[misspelling] ~30-~30: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...tries` | The max retries to login after which the account gets locked. ...
(LOG_IN)
🔇 Additional comments (19)
docs/guides/using-the-binary.md (1)
47-47: Clarify service type with explicit heading
Great clarification by specifying "systemd" in the heading. This makes the documentation more precise for users running tinyauth as a service under systemd.docs/guides/allowed-paths.md (1)
45-45: Approve streamlined phrasing
The change from "I would recommend" to "I recommend" improves clarity and brevity.docs/about.md (1)
5-5: Approve corrected preposition
Changing "authentication on homelabs" to "authentication in homelabs" accurately reflects the intended collocation.docs/guides/nginx-proxy-manager.md (1)
106-108: Informational note is clear and helpful.
The added note about websockets is concise and valuable for users.docs/guides/google-oauth.md (1)
80-80: Correct provider reference and comma usage.This warning still mentions GitHub. It should refer to Google accounts for this guide:
-::: warning -OAuth doesn't mean security, with the current setup everybody with a Github account can login to Tinyauth as a normal user. +::: warning +OAuth doesn’t mean security. With this setup, everybody with a Google account can log in to Tinyauth as a normal user.Likely an incorrect or invalid review comment.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~80-~80: A comma might be missing here.
Context: ...doesn't mean security, with the current setup everybody with a Github account can log...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[misspelling] ~80-~80: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...tup everybody with a Github account can login to Tinyauth as a normal user. If you wo...(LOG_IN)
[misspelling] ~80-~80: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...you would like to limit which users can login with OAuth, you can add the `OAUTH_WHIT...(LOG_IN)
docs/community/kubernetes.md (3)
22-22: Skip heading review.The heading "Create a Namespace" follows the established style and requires no changes.
56-56: Skip heading review.The heading "Create a Deployment" matches the style and needs no update.
102-102: Skip heading review.The heading "Create a Service" follows the established style; no changes needed.
docs/community/zitadel-oauth.md (1)
67-67: Provider-specific warning update.The warning still references GitHub but this is the generic OAuth guide for Zitadel. Update accordingly:
-::: warning -OAuth doesn't mean security, with the current setup everybody with a Github account can login to Tinyauth as a normal user. +::: warning +OAuth doesn’t mean security. With this setup, anybody with valid Zitadel credentials can log in to Tinyauth as a normal user.Likely an incorrect or invalid review comment.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~67-~67: A comma might be missing here.
Context: ...doesn't mean security, with the current setup everybody with a Github account can log...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[misspelling] ~67-~67: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...tup everybody with a Github account can login to Tinyauth as a normal user. If you wo...(LOG_IN)
[misspelling] ~67-~67: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...you would like to limit which users can login with OAuth, you can add the `OAUTH_WHIT...(LOG_IN)
[uncategorized] ~67-~67: Possible missing comma found.
Context: ...w your email address to login. For more information check the [configuration](/docs/referen...(AI_HYDRA_LEO_MISSING_COMMA)
docs/reference/api.md (1)
23-24: New warning is clear and appropriate.
The added warning correctly highlights that basic auth is disabled for TOTP-enabled accounts.docs/reference/headers.md (6)
7-7: Header level change is fine; no comment needed.
11-11: This explanatory line reads well.
13-13: Section heading is consistent.
17-17: The explanatory line is clear.
19-19: Section heading is consistent.
25-25: Section heading is consistent.docs/reference/configuration.md (3)
3-3: Clear introduction phrasing.The new opening sentence succinctly explains the dual configuration methods without ambiguity.
6-6: Info box on FILE_ equivalents is clear.The explanation of using
FILE_-prefixed environment variables or flags is concise and accurate.
15-16: Table header formatting is consistent and clear.The revised header and alignment improve readability of the configuration options table.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
docs/reference/configuration.md (3)
6-6: Remove the extra comma after the parenthetical.The comma after “USERS_FILE)” interrupts the flow. It’s more idiomatic to write:
- Every configuration option that has a `FILE_` equivalent (e.g. `USERS` and `USERS_FILE`), allows for the `FILE_` environment variable/CLI flag to be used instead of the original one. + Every configuration option that has a `FILE_` equivalent (e.g. `USERS` and `USERS_FILE`) allows for the `FILE_` environment variable or CLI flag to be used instead of the original one.
9-10: Add missing comma and capitalize Docker.The clause “In this case you shouldn’t use quotes” needs a comma after “In this case”, and “docker” should be “Docker”:
- In this case you **_shouldn't_** use quotes as docker can handle them. + In this case, you **_shouldn't_** use quotes as Docker can handle them.🧰 Tools
🪛 LanguageTool
[formatting] ~10-~10: Consider inserting a comma after an introductory phrase for better readability.
Context: ...GENERIC_SCOPES=openid profile email). In this case you shouldn't use quotes as docke...(IN_THAT_CASE_COMMA)
15-33: Minor grammar and formatting tweaks in the options table.Overall the table is much clearer, but a few small refinements will improve consistency:
- Use “log in” (verb) instead of “login” in descriptions.
- Add spaces after commas in the
--oauth-auto-redirectoptions list.@@ -26,7 +26,7 @@ -| `OAUTH_WHITELIST`/`--oauth-whitelist` | A list of usernames that are allowed to login with OAuth (can be a regex if it has the slash prefix and suffix). | - | no | +| `OAUTH_WHITELIST`/`--oauth-whitelist` | A list of usernames that are allowed to log in with OAuth (can be a regex if it has the slash prefix and suffix). | - | no | @@ -30,7 +30,7 @@ -| `LOGIN_MAX_RETRIES`/`--login-max-retries` | The max retries to login after which the account gets locked. | 5 | no | +| `LOGIN_MAX_RETRIES`/`--login-max-retries` | The max retries to log in after which the account gets locked. | 5 | no | @@ -33,7 +33,7 @@ -| `OAUTH_AUTO_REDIRECT`/`--oauth-auto-redirect` | Automatically redirect to your OAuth provider on login (available options are `none`,`github`,`google` and `generic`). | `none` | no | +| `OAUTH_AUTO_REDIRECT`/`--oauth-auto-redirect` | Automatically redirect to your OAuth provider on login (available options are `none`, `github`, `google`, and `generic`). | `none` | no |🧰 Tools
🪛 LanguageTool
[uncategorized] ~18-~18: A punctuation mark might be missing here.
Context: ... | no | |ADDRESS/--address| The a...(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~20-~20: A punctuation mark might be missing here.
Context: ... | yes | |SECRET/--secret| The...(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~21-~21: A punctuation mark might be missing here.
Context: ... | yes | |USERS/--users| A...(AI_EN_LECTOR_MISSING_PUNCTUATION)
[misspelling] ~26-~26: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...A list of usernames that are allowed to login with OAuth (can be a regex if it has th...(LOG_IN)
[misspelling] ~30-~30: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...tries` | The max retries to login after which the account gets locked. ...(LOG_IN)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
bun.lockbis excluded by!**/bun.lockb
📒 Files selected for processing (3)
docs/reference/configuration.md(1 hunks)package.json(1 hunks)public/site.webmanifest(1 hunks)
✅ Files skipped from review due to trivial changes (2)
- public/site.webmanifest
- package.json
🧰 Additional context used
🪛 LanguageTool
docs/reference/configuration.md
[formatting] ~10-~10: Consider inserting a comma after an introductory phrase for better readability.
Context: ...GENERIC_SCOPES=openid profile email). In this case you shouldn't use quotes as docke...
(IN_THAT_CASE_COMMA)
[uncategorized] ~18-~18: A punctuation mark might be missing here.
Context: ... | no | | ADDRESS/--address | The a...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~20-~20: A punctuation mark might be missing here.
Context: ... | yes | | SECRET/--secret | The...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~21-~21: A punctuation mark might be missing here.
Context: ... | yes | | USERS/--users | A...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
[misspelling] ~26-~26: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...A list of usernames that are allowed to login with OAuth (can be a regex if it has th...
(LOG_IN)
[misspelling] ~30-~30: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...tries` | The max retries to login after which the account gets locked. ...
(LOG_IN)
🔇 Additional comments (1)
docs/reference/configuration.md (1)
3-3: Approve the split introductory sentence.Splitting the original run-on intro into two clear sentences improves readability and sets the stage for the configuration list.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (10)
docs/reference/cli.md (6)
3-3: Remove unnecessary intensifier
The word “very” adds little meaning and can be removed to tighten the phrasing.- Tinyauth offers a very simple CLI that aims to help you to configure the app and manage users. + Tinyauth offers a simple CLI that aims to help you to configure the app and manage users.🧰 Tools
🪛 LanguageTool
[style] ~3-~3: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: # CLI Tinyauth offers a very simple CLI that aims to help you to configure ...(EN_WEAK_ADJECTIVE)
35-35: Enhance grammar and punctuation
Several minor edits will improve readability and consistency:- This command will launch an interactive TUI where you can provide a username and a password and it will generate the `username:hash` format required by the app. It can also auto format it for docker if you would like to use it within a docker compose file. Apart from the interactive mode you can also create a user with flags: + This command will launch an interactive TUI where you can provide a username and a password, and it will generate the `username:hash` format required by the app. It can also auto-format it for Docker if you would like to use it within a Docker Compose file. Apart from the interactive mode, you can also create a user with flags:🧰 Tools
🪛 LanguageTool
[uncategorized] ~35-~35: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ou can provide a username and a password and it will generate theusername:hashfo...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~35-~35: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...format required by the app. It can also auto format it for docker if you would like to use ...(AUTO_HYPHEN)
[uncategorized] ~35-~35: A comma might be missing here.
Context: ...ompose file. Apart from the interactive mode you can also create a user with flags: ...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
65-65: Add missing comma for clarity
A comma before “so” clarifies the causal relationship:- > Make sure to use quotes (`'`) when typing this in a bash shell so your hash gets passed correctly to tinyauth. + > Make sure to use quotes (`'`) when typing this in a bash shell, so your hash gets passed correctly to tinyauth.🧰 Tools
🪛 LanguageTool
[uncategorized] ~65-~65: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...s (') when typing this in a bash shell so your hash gets passed correctly to tiny...(COMMA_COMPOUND_SENTENCE_2)
79-79: Hyphenate “auto-generate”
Use a hyphen to form the compound verb:- Tinyauth can auto generate TOTP codes for you, the combination is `username:hash:totp-secret`. + Tinyauth can auto-generate TOTP codes for you, the combination is `username:hash:totp-secret`.🧰 Tools
🪛 LanguageTool
[uncategorized] ~79-~79: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...### Generate TOTP command Tinyauth can auto generate TOTP codes for you, the combination is ...(AUTO_HYPHEN)
85-85: Remove redundant “with”
The phrase “alongside with” is redundant; use one or the other:- alongside with a QR code + alongside a QR code🧰 Tools
🪛 LanguageTool
[style] ~85-~85: This phrase is redundant. Consider writing “alongside” or “with”.
Context: ... new user (username:hash:totp-secret) alongside with a QR code so as you can add it to your ...(ALONGSIDE_WITH)
92-92: Add missing comma for clarity
Insert a comma before “so” to improve flow:- > Make sure to use quotes (`'`) when typing this in a bash shell so your hash gets passed correctly to tinyauth. + > Make sure to use quotes (`'`) when typing this in a bash shell, so your hash gets passed correctly to tinyauth.🧰 Tools
🪛 LanguageTool
[uncategorized] ~92-~92: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...s (') when typing this in a bash shell so your hash gets passed correctly to tiny...(COMMA_COMPOUND_SENTENCE_2)
docs/reference/api.md (4)
3-3: Remove weak intensifier and redundant “of”
Streamline the sentence by dropping “very” and “of”:- Tinyauth has a very simple API used for both the reverse proxies and the web UI. All of the available endpoints are listed below. + Tinyauth has a simple API used for both reverse proxies and the web UI. All available endpoints are listed below.🧰 Tools
🪛 LanguageTool
[style] ~3-~3: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: # API Tinyauth has a very simple API used for both the reverse proxies a...(EN_WEAK_ADJECTIVE)
[style] ~3-~3: Consider removing “of” to be more concise
Context: ...oth the reverse proxies and the web UI. All of the available endpoints are listed below. ...(ALL_OF_THE)
152-152: Correct verb agreement
The subject “information” is singular; change “are” to “is”:- Endpoint used to retrieve app information that are global for all users. + Endpoint used to retrieve app information that is global for all users.🧰 Tools
🪛 LanguageTool
[uncategorized] ~152-~152: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...t used to retrieve app information that are global for all users. It is used by the...(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
58-58: Clarify “proxies” to “reverse proxies”
To maintain consistency with other docs, specify “reverse proxies”:- Authentication endpoint used by proxies. + Authentication endpoint used by reverse proxies.
191-191: Consistent boolean typing fortotpPending
Use a boolean literal instead of a string for consistency with other boolean fields:- "totpPending": "false" + "totpPending": false
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/reference/api.md(4 hunks)docs/reference/cli.md(4 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/reference/api.md
[style] ~3-~3: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: # API Tinyauth has a very simple API used for both the reverse proxies a...
(EN_WEAK_ADJECTIVE)
[style] ~3-~3: Consider removing “of” to be more concise
Context: ...oth the reverse proxies and the web UI. All of the available endpoints are listed below. ...
(ALL_OF_THE)
[uncategorized] ~152-~152: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...t used to retrieve app information that are global for all users. It is used by the...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
docs/reference/cli.md
[style] ~3-~3: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: # CLI Tinyauth offers a very simple CLI that aims to help you to configure ...
(EN_WEAK_ADJECTIVE)
[uncategorized] ~29-~29: A comma might be missing here.
Context: ...ing to use any other tools. To create a user simply run: ```sh ./tinyauth user crea...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~35-~35: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ou can provide a username and a password and it will generate the username:hash fo...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~35-~35: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...format required by the app. It can also auto format it for docker if you would like to use ...
(AUTO_HYPHEN)
[uncategorized] ~35-~35: A comma might be missing here.
Context: ...ompose file. Apart from the interactive mode you can also create a user with flags: ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~52-~52: A comma might be missing here.
Context: ... match with the username:hash. To use it just run: ```sh ./tinyauth user verify...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~58-~58: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... combination, your username and password and then it will check if the credentials m...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~65-~65: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...s (') when typing this in a bash shell so your hash gets passed correctly to tiny...
(COMMA_COMPOUND_SENTENCE_2)
[uncategorized] ~79-~79: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...### Generate TOTP command Tinyauth can auto generate TOTP codes for you, the combination is ...
(AUTO_HYPHEN)
[style] ~85-~85: This phrase is redundant. Consider writing “alongside” or “with”.
Context: ... new user (username:hash:totp-secret) alongside with a QR code so as you can add it to your ...
(ALONGSIDE_WITH)
[uncategorized] ~92-~92: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...s (') when typing this in a bash shell so your hash gets passed correctly to tiny...
(COMMA_COMPOUND_SENTENCE_2)
🔇 Additional comments (6)
docs/reference/cli.md (4)
7-7: Approve terminology update
Replacing “executable” with “binary” standardizes terminology and aligns with project conventions.
25-25: Approve link clarity improvement
The phrasing is clear, and the link to the configuration page is correctly referenced.
29-29: Skip comma suggestion
The two sentences here are intentionally separate for readability; no comma is needed.🧰 Tools
🪛 LanguageTool
[uncategorized] ~29-~29: A comma might be missing here.
Context: ...ing to use any other tools. To create a user simply run: ```sh ./tinyauth user crea...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
52-52: Approve verify command phrasing
The updated description clearly explains the verify command’s purpose and usage.🧰 Tools
🪛 LanguageTool
[uncategorized] ~52-~52: A comma might be missing here.
Context: ... match with theusername:hash. To use it just run: ```sh ./tinyauth user verify...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
docs/reference/api.md (2)
23-25: Approve TOTP disable warning
The new warning regarding disabled basic auth for TOTP accounts is clear and important for security.
160-170: Approve enhanced/api/appresponse fields
The expanded example now includes all relevant global app settings and aligns with configuration reference.
1 participant
Summary by CodeRabbit