Skip to content

Commit aa21c06

Browse files
egeozcanclaude
andcommitted
docs(site): correct stale "no authentication" security warnings
Auth is opt-in (-auth) since the accounts + RBAC feature shipped, so the absolute "Mahresources has no authentication" claims were false. - Announcement bar: reword to "off by default (opt-in via -auth)", keep the reverse-proxy advice, link to the Authentication & RBAC page - Reword the No-Authentication danger admonitions in api/overview, getting-started/installation, and deployment/docker to "off by default" with a pointer to the opt-in feature - Add CSS so the banner link and -auth code chip stay high-contrast (white + underline) on the red background Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 645058c commit aa21c06

5 files changed

Lines changed: 20 additions & 5 deletions

File tree

docs-site/docs/api/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ sidebar_position: 1
66

77
All features are accessible via a REST API. Most write endpoints accept either JSON or form-encoded requests, and most `/v1` endpoints return JSON.
88

9-
:::danger No Authentication
9+
:::danger Authentication is off by default
1010

11-
There is no authentication or authorization. The API is designed for use on private, trusted networks only. **Never expose the server directly to the public internet.**
11+
Out of the box the API has no authentication or authorization, so it is designed for private, trusted networks only. **Never expose the server directly to the public internet.** Opt-in [Authentication & RBAC](../features/authentication.md) (`-auth`) adds per-user accounts, roles, and API tokens (`Authorization: Bearer <token>`); even then, front the server with a reverse proxy for internet-facing deployments.
1212

1313
:::
1414

docs-site/docs/deployment/docker.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: Running Mahresources in Docker containers
77
# Docker Deployment
88

99
:::danger Security Warning
10-
There is **no built-in authentication**. Never expose Docker containers directly to the internet. Always use a reverse proxy with authentication. See [Reverse Proxy](./reverse-proxy.md) for setup instructions.
10+
Authentication is **off by default**. Never expose Docker containers directly to the internet -- always use a reverse proxy with authentication. See [Reverse Proxy](./reverse-proxy.md) for setup instructions. Built-in [Authentication & RBAC](../features/authentication.md) (`-auth`) adds per-user accounts on top.
1111
:::
1212

1313
## Building the Image

docs-site/docs/getting-started/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_position: 1
66

77
:::danger Security Warning
88

9-
There is **no built-in authentication**. Never expose the server directly to the public internet. Always run it on a private network or behind a reverse proxy with proper authentication.
9+
Authentication is **off by default**. Never expose the server directly to the public internet -- run it on a private network or behind a reverse proxy with authentication. Built-in [Authentication & RBAC](../features/authentication.md) is available (opt-in via `-auth`) when you need per-user accounts and roles.
1010

1111
:::
1212

docs-site/docusaurus.config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ const config: Config = {
5454
},
5555
announcementBar: {
5656
id: 'security_warning',
57-
content: '⚠️ <strong>Security Notice:</strong> Mahresources has no authentication. Only run on trusted private networks.',
57+
content: '⚠️ <strong>Security Notice:</strong> Authentication is off by default (opt-in via <code>-auth</code>). Never expose Mahresources to the internet without a reverse proxy. <a href="/mahresources/features/authentication">Learn more</a>.',
5858
backgroundColor: '#dc2626',
5959
textColor: '#ffffff',
6060
isCloseable: false,

docs-site/src/css/custom.css

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,21 @@
1717
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
1818
}
1919

20+
/* Keep the security-notice announcement bar link and inline code readable on
21+
its red background (white text + underline, never the low-contrast blue link
22+
color). The class names are CSS-module-hashed, so target by prefix. */
23+
div[class^='announcementBar_'] a,
24+
div[class*=' announcementBar_'] a {
25+
color: inherit;
26+
text-decoration: underline;
27+
}
28+
div[class^='announcementBar_'] code,
29+
div[class*=' announcementBar_'] code {
30+
color: inherit;
31+
background-color: rgba(255, 255, 255, 0.2);
32+
border-color: rgba(255, 255, 255, 0.4);
33+
}
34+
2035
/* For readability concerns, you should choose a lighter palette in dark mode. */
2136
[data-theme='dark'] {
2237
--ifm-color-primary: #25c2a0;

0 commit comments

Comments
 (0)