From ed94078ba67db3a60982f31ea99e9f4e403bc8f0 Mon Sep 17 00:00:00 2001 From: Matthew <133825715+mattLif@users.noreply.github.com> Date: Tue, 19 Nov 2024 16:53:37 -0500 Subject: [PATCH] Created Index Page for Docs Signed-off-by: Matthew <133825715+mattLif@users.noreply.github.com> --- docs/index.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 docs/index.md diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..83e77ba1 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,64 @@ +# Index + +- [Blogs](https://github.com/spiffe/tornjak/blob/main/docs/blogs.md) + +- [Debugging, Hints and Tips for Solving Common Problems with Tornjak](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-hints.md) + - [Tornjak Deployment](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-hints.md#tornjak-deployment) + - [Tornjak Configuration](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-hints.md#tornjak-configuration) + - [User Management](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-hints.md#user-management) + +- [JSON Format for New Entry](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md) + +- [Server plugin: Authentication "Keycloak"](https://github.com/spiffe/tornjak/blob/main/docs/plugin_server_authentication_keycloak.md) + +- [Server plugin: Authorization "RBAC"](https://github.com/spiffe/tornjak/blob/main/docs/plugin_server_authorization_rbac.md) + +- [Server plugin: Datastore "SQL"](https://github.com/spiffe/tornjak/blob/main/docs/plugin_server_datastore_sql.md) + +- [Server plugin: SPIRECRDManager](https://github.com/spiffe/tornjak/blob/main/docs/plugin_server_spirecrd.md) + +- [Tornjak Agent](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-agent.md) + - [Tornjak SPIRE Server Agent](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-agent.md#tornjak-spire-server-agent) + - [APIs](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-agent.md#apis) + - [Authentication](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-agent.md#authentication) + - [Authorization](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-agent.md#authorization) + +- [Tornjak Manager](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-manager.md) + - [Global Visibility](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-manager.md#global-visibility) + - [Identity Policy Management](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-manager.md#identity-policy-management) + - [Auditability of Identities And Use For Operations/Forensics](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-manager.md#auditability-of-identities-and-use-for-operationsforensics) + - [Management of SPIRE Identity Configurations](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-manager.md#management-of-spire-identity-configurations) + +- [Tornjak Plan](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md) + - [Milestone A: Global Visibility](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-a-global-visibility) + - [Milestone B: Global Visibility + Authentication](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-b-global-visibility--authentication) + - [Milestone C: Policy management](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-c-policy-management) + - [Milestone D: Improve Policy definitions and UX](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-d-improve-policy-definitions-and-ux) + - [Milestone E: Auditability](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-e-auditability) + - [Milestone F: Advanced Authentication](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-f-advanced-authentication) + - [Milestone G: Enhancing SPIRE API](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-g-enhancing-spire-api) + +- [Tornjak Server Configuration Reference](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md) + - [Command line options](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#command-line-options) + - [The Tornjak Config](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#the-tornjak-config) + - [General Tornjak Server Configs](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#general-tornjak-server-configs) + - [About Tornjak Plugins](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#about-tornjak-plugins) + - [Sample Configuration Files](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#sample-configuration-files) + - [Further Reading](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#further-reading) + +- [Tornjak UI-API Documentation](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md) + - [Overview](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#11-overview) + - [Tornjak User Interface (UI) Architecture](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#2-tornjak-user-interface-ui-architecture) + - [UI Pages (With their paths)](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#21-ui-pages-with-their-paths) + - [Tornjak User Interface (UI) Interaction with API Endpoints](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#3-tornjak-user-interface-ui-interaction-with-api-endpoints) + - [Agent API’s](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#31-tornjak-apis) + - [Manager API’s](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#32-manager-apis) + - [Tornjak Redux Reducers and Actions With Their Respective Descriptions](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#4-tornjak-redux-reducers-and-actions-with-their-respective-descriptions) + - [Reducers](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#41-reducers) + - [Actions](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#42-actions) + +- [User Management](https://github.com/spiffe/tornjak/blob/main/docs/user-management.md) + - [Overview](https://github.com/spiffe/tornjak/blob/main/docs/user-management.md#overview) + - [Architecture](https://github.com/spiffe/tornjak/blob/main/docs/user-management.md#architecture) + - [General Deployment](https://github.com/spiffe/tornjak/blob/main/docs/user-management.md#general-deployment) + - [Examples and Tutorials](https://github.com/spiffe/tornjak/blob/main/docs/user-management.md#examples-and-tutorials) \ No newline at end of file