Skip to content

Commit 2b1d34f

Browse files
committed
Add a security doc
I thought it would be good to put a security page into the docs, so that it shows up in a search. Content is just pointing at other resources. Signed-off-by: Bryan Boreham <[email protected]>
1 parent ff0d1a6 commit 2b1d34f

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

docs/_index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@ should read:
3636
1. [Getting started with Cortex](getting-started/_index.md)
3737
1. [Information regarding configuring Cortex](configuration/_index.md)
3838

39+
There are also individual [guides](guides/_index.md) to many tasks.
40+
Please review the important [security advice](guides/security.md) before deploying.
41+
3942
For a guide to contributing to Cortex, see the [contributor guidelines](contributing/).
4043

4144
## Further reading

docs/guides/security.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: "Security"
3+
linkTitle: "Security"
4+
weight: 10
5+
slug: security
6+
---
7+
8+
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.
9+
10+
You must configure authorisation and authentication externally to Cortex; see [this guide](auth)
11+
12+
Information about security disclosures and mailing lists is [in the main repo](https://github.com/cortexproject/cortex/blob/master/SECURITY.md)
13+

0 commit comments

Comments
 (0)