Skip to content
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

Jump to bottom

docs: Adds documentation on third-party deps #728

Merged
merged 1 commit into from
Dec 23, 2017
Merged

docs: Adds documentation on third-party deps #728

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
1 change: 1 addition & 0 deletions docs/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
* [Introduction to Hydra](README.md#introduction-to-hydra)
* [OAuth2 Case Study](README.md#oauth-20-case-study)
* [Introduction Tutorial (5 minutes)](tutorial.md)
* [Dependencies](environment.md)
* Understanding Hydra
* [OAuth2 & OpenID Connect](oauth2.md)
* [Overview](oauth2.md#overview)
Expand Down
17 changes: 17 additions & 0 deletions docs/environment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Dependencies & Environment

ORY Hydra is built cloud native and implements [12factor](http://12factor.net) principles. The Docker Image is 5 MB light
and thoroughly versioned with [verbose upgrade instructions](https://github.com/ory/hydra/blob/master/UPGRADE.md)
and [detailed changelogs](https://github.com/ory/hydra/blob/master/CHANGELOG.md). Auto-scaling, migrations, health checks,
it all works with zero additional work required. It is possible to run ORY Hydra on any platform, including but not limited
to OSX, Linux, Windows, ARM, FreeBSD and more.

ORY Hydra has two operational modes:

* In-memory: This mode does not work with more than one instance ("cluster") and any state is lost after restarting the instance.
* SQL: This mode works with more than one instance and state is not lost after restarts.

The SQL adapter supports two DBMS: PostgreSQL 9.6+ and MySQL 5.7+. Please note that
older MySQL versions have issues with ORY Hydra's database schema. For more information [go here](https://github.com/ory/hydra/issues/377).

No further dependencies are required for a production-ready instance.