Skip to content

docs: add new security doc to best practices section #15805

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Dec 16, 2024
Merged
4 changes: 2 additions & 2 deletions docs/admin/monitoring/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Monitoring Coder

Learn about our the tools, techniques, and best practices to monitor Coder your
Coder deployment.
Learn about our the tools, techniques, and best practices to monitor your Coder
deployment.

## Quick Start: Observability Helm Chart

Expand Down
4 changes: 4 additions & 0 deletions docs/admin/security/database-encryption.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,3 +185,7 @@ To delete all encrypted data from your database, perform the following actions:
- Decryption may fail if newly encrypted data is written while decryption is in
progress. If this happens, ensure that all active coder instances are stopped,
and retry.

## Next steps

- [Security - best practices](../../tutorials/best-practices/security-best-practices.md)
9 changes: 8 additions & 1 deletion docs/admin/security/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
# Security Advisories
# Security

<children></children>

For other security tips, visit our guide to
[security best practices](../../tutorials/best-practices/security-best-practices.md).

## Security Advisories

> If you discover a vulnerability in Coder, please do not hesitate to report it
> to us by following the instructions
Expand Down
23 changes: 15 additions & 8 deletions docs/admin/security/secrets.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,20 @@
# Secrets

<blockquote class="info">
This article explains how to use secrets in a workspace. To authenticate the
workspace provisioner, see <a href="../users">this</a>.
</blockquote>
Coder is open-minded about how you get your secrets into your workspaces. For
more information about how to use secrets and other security tips, visit our
guide to
[security best practices](../../tutorials/best-practices/security-best-practices.md#secrets).

Coder is open-minded about how you get your secrets into your workspaces.
This article explains how to use secrets in a workspace. To authenticate the
workspace provisioner, see the
<a href="../provisioners.md#authentication">provisioners documentation</a>.

## Wait a minute...

Your first stab at secrets with Coder should be your local method. You can do
everything you can locally and more with your Coder workspace, so whatever
workflow and tools you already use to manage secrets may be brought over.
Your first attempt to use secrets with Coder should be your local method. You
can do everything you can locally and more with your Coder workspace, so
whatever workflow and tools you already use to manage secrets may be brought
over.

Often, this workflow is simply:

Expand Down Expand Up @@ -111,3 +114,7 @@ workspace.

Refer to our [HashiCorp Vault Integration](../integrations/vault.md) guide for
more information on how to integrate HashiCorp Vault with Coder.

## Next steps

- [Security - best practices](../../tutorials/best-practices/security-best-practices.md)
5 changes: 5 additions & 0 deletions docs/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -761,6 +761,11 @@
"description": "Guides to help you make the most of your Coder experience",
"path": "./tutorials/best-practices/index.md",
"children": [
{
"title": "Security - best practices",
"description": "Make your Coder deployment more secure",
"path": "./tutorials/best-practices/security-best-practices.md"
},
{
"title": "Organizations - best practices",
"description": "How to make the best use of Coder Organizations",
Expand Down
Loading
Loading