Skip to content

Add a security doc #4337

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.

Sign up for GitHub

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
pracucci merged 1 commit into from
Jul 9, 2021
Merged

Add a security doc #4337

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ should read:
1. [Getting started with Cortex](getting-started/_index.md)
1. [Information regarding configuring Cortex](configuration/_index.md)

There are also individual [guides](guides/_index.md) to many tasks.
Please review the important [security advice](guides/security.md) before deploying.

For a guide to contributing to Cortex, see the [contributor guidelines](contributing/).

## Further reading
Expand Down
12 changes: 12 additions & 0 deletions docs/guides/security.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: "Security"
linkTitle: "Security"
weight: 10
slug: security
---

Cortex must be deployed with due care over system configuration, using principles such as "least privilege" to limit any exposure due to flaws in the source code.

You must configure authorisation and authentication externally to Cortex; see [this guide](./authentication-and-authorisation.md)

Information about security disclosures and mailing lists is [in the main repo](https://github.com/cortexproject/cortex/blob/master/SECURITY.md)