Skip to content

Commit 3a35413

Browse files
committed
edit path-based apps section
1 parent 1dcc3f4 commit 3a35413

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

docs/tutorials/best-practices/security-best-practices.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -68,16 +68,28 @@ determining the nature and scope of the impact.
6868

6969
### Disable path-based apps
7070

71-
By default, path-based apps are enabled in Coder to make demos and trials easier for new users.
71+
For production deployments, disable path-based apps.
7272

73-
In production deployments, however, path-based apps reduce security significantly as it allows user workspace apps to be hosted on the same domain as other apps and the Coder API itself in the default region.
73+
Path-based apps share the same origin as the Coder API.
74+
This setup is convenient for demos, but can expose the deployment to cross-site-scripting (XSS) attacks in production.
75+
A malicious workspace could reuse Coder cookies to call the API or interact with other workspaces owned by the same user.
7476

75-
We recommend turning off path-based apps after you have configured and enabled subdomain apps via a wildcard DNS entry.
77+
1. [Enable sub-domain apps with a wildcard DNS record](../../admin/setup/index.md#wildcard-access-url) (like `*.coder.example.com`)
7678

77-
The impact of having path-based apps enabled is mitigated by default, but we still recommend disabling it to prevent malicious workspaces accessing other workspaces owned by the same user or performing requests against the Coder API:
79+
1. Disable path-based apps:
7880

79-
- Path-based apps cannot be shared with other users without a special flag `--dangerous-allow-path-app-sharing`
80-
- Users with the site "owner" role cannot use their admin privileges to access path-based apps for workspace they do not own without a special flag `--dangerous-allow-path-app-site-owner-access`
81+
```shell
82+
coderd server --disable-path-apps
83+
# or
84+
export CODER_DISABLE_PATH_APPS=true
85+
```
86+
87+
By default, Coder mitigates the impact of having path-based apps enabled, but we still recommend disabling it to prevent malicious workspaces accessing other workspaces owned by the same user or performing requests against the Coder API.
88+
89+
If you do keep path-based apps enabled, Coder limits the risk:
90+
91+
- Path-based apps cannot be shared with other users unless you start the Coder server with `--dangerous-allow-path-app-sharing`.
92+
- Users with the site `owner` role cannot use their admin privileges to access path-based apps for workspace unless the server is started with `--dangerous-allow-path-app-site-owner-access`.
8193

8294
## PostgreSQL
8395

0 commit comments

Comments
 (0)