Skip to content

Created Index Page for Docs #556

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
merged 5 commits into from
Dec 2, 2024
Merged

Created Index Page for Docs #556

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ed94078
Created Index Page for Docs
mattLif Nov 19, 2024
48b9840
Lint Fix
mattLif Nov 21, 2024
aafef68
Removed Items and Switched to Relative Linking
mattLif Nov 22, 2024
24b0e61
Moved Plugins to a Folder And Fixed All Linking to Them
mattLif Nov 22, 2024
4f91a06
<Rename Index to README>
mattLif Nov 26, 2024
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
64 changes: 64 additions & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)