Skip to content

Commit

Permalink
docs: add production guide
Browse files Browse the repository at this point in the history
  • Loading branch information
aeneasr committed Apr 1, 2021
1 parent e45b28f commit a9163c7
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/docs/concepts/namespaces.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Because namespaces each come with an individual configuration that can even
modify some storage specific options, it is required to manually review and run
migrations on namespace configuration updates. Please refer to the
[namespace migration CLI reference](../cli/keto-namespace-migrate.md) and
[running in production guide](/TODO) to learn more about that process.
[running in production guide](../guides/production.md) to learn more about that process.

## Naming Conventions

Expand Down
27 changes: 27 additions & 0 deletions docs/docs/guides/production.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
id: production
title: Going to Production
---

:::warn

This document is still in development.

:::

## Database

ORY Keto requires a production-grade database such as PostgreSQL, MySQL,
CockroachDB. Do not use SQLite in production!

### Write API

Never expose the ORY Keto Write API to the internet unsecured. Always require
authorization. A good practice is to not expose the Write API at all to the
public internet and use a Zero Trust Networking Architecture within your
intranet.

## Scaling

There are no additional requirements for scaling ORY Keto, just spin up
another container!
3 changes: 2 additions & 1 deletion docs/sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@
"secure",
"guides/simple-access-check-guide",
"guides/list-api-display-objects",
"guides/expand-api-display-who-has-access"
"guides/expand-api-display-who-has-access",
"guides/production"
],
"Examples": ["examples/olymp-file-sharing"],
"Reference": [
Expand Down

0 comments on commit a9163c7

Please sign in to comment.