luxolus
/
open-vault
2
0
Fork 0
Code Issues 1 Pull Requests Releases Activity
open-vault/website/source/layouts/api.erb

303 lines
14 KiB
Plaintext
Raw Normal View History

website: lots more docs
2015-04-10 05:52:02 +00:00
<% wrap_layout :inner do %>
Fix http layout
2017-03-06 21:10:35 +00:00
<% content_for :sidebar do %>
Cleanup CSS
2017-03-26 20:04:14 +00:00
<ul class="nav docs-sidenav">
<li<%= sidebar_current("docs-http-overview") %>>
<a href="/api/index.html">Overview</a>
</li>
<li<%= sidebar_current("docs-http-libraries") %>>
<a href="/api/libraries.html">Client Libraries</a>
</li>
Sync docs
2017-11-14 11:13:11 +00:00
<li<%= sidebar_current("docs-http-related") %>>
<a href="/api/relatedtools.html">Related Tools</a>
</li>
Fix http layout
2017-03-06 21:10:35 +00:00
Cleanup CSS
2017-03-26 20:04:14 +00:00
<hr>
Fix http layout
2017-03-06 21:10:35 +00:00
Cleanup CSS
2017-03-26 20:04:14 +00:00
<li<%= sidebar_current("docs-http-secret") %>>
<a href="/api/secret/index.html">Secret Backends</a>
<ul class="nav">
<li<%= sidebar_current("docs-http-secret-aws") %>>
<a href="/api/secret/aws/index.html">AWS</a>
</li>
<li<%= sidebar_current("docs-http-secret-consul") %>>
<a href="/api/secret/consul/index.html">Consul</a>
</li>
<li<%= sidebar_current("docs-http-secret-cubbyhole") %>>
<a href="/api/secret/cubbyhole/index.html">Cubbyhole</a>
</li>
Add API docs
2017-05-03 09:13:07 +00:00
<li<%= sidebar_current("docs-http-secret-databases") %>>
API Docs updates (#3101)
2017-08-08 16:28:17 +00:00
<a href="/api/secret/databases/index.html">Databases</a>
Add API docs
2017-05-03 09:13:07 +00:00
<ul class="nav">
<li<%= sidebar_current("docs-http-secret-databases-cassandra") %>>
<a href="/api/secret/databases/cassandra.html">Cassandra</a>
</li>
Add missing link to sidebar menu (#3153) * Add missing link to sidebar menu * Add missing link to sidebar menu
2017-08-14 16:33:47 +00:00
<li<%= sidebar_current("docs-http-secret-databases-hanadb") %>>
<a href="/api/secret/databases/hanadb.html">HanaDB</a>
</li>
Mongodb plugin (#2698) * WIP on mongodb plugin * Add mongodb plugin * Add tests * Update mongodb.CreateUser() comment * Update docs * Add missing docs * Fix mongodb docs * Minor comment and test updates * Fix imports * Fix dockertest import * Set c.Initialized at the end, check for empty CreationStmts first on CreateUser * Remove Initialized check on Connection() * Add back Initialized check * Update docs * Move connProducer and credsProducer into pkg for mongodb and cassandra * Chage parseMongoURL to be a private func * Default to admin if no db is provided in creation_statements * Update comments and docs
2017-05-11 21:38:54 +00:00
<li<%= sidebar_current("docs-http-secret-databases-mongodb") %>>
<a href="/api/secret/databases/mongodb.html">MongoDB</a>
</li>
Add API docs
2017-05-03 09:13:07 +00:00
<li<%= sidebar_current("docs-http-secret-databases-mssql") %>>
<a href="/api/secret/databases/mssql.html">MSSQL</a>
</li>
<li<%= sidebar_current("docs-http-secret-databases-mysql-maria") %>>
<a href="/api/secret/databases/mysql-maria.html">MySQL/MariaDB</a>
</li>
<li<%= sidebar_current("docs-http-secret-databases-postgresql") %>>
<a href="/api/secret/databases/postgresql.html">PostgreSQL</a>
</li>
Oracle plugin docs (#3131) * Add oracle database docs * Add oracle database docs * Fix commas in json output * Update oracle.html.md
2017-08-16 00:24:01 +00:00
<li<%= sidebar_current("docs-http-secret-databases-oracle") %>>
<a href="/api/secret/databases/oracle.html">Oracle</a>
</li>
Add API docs
2017-05-03 09:13:07 +00:00
</ul>
</li>
Rename "generic" secret backend to "kv" (#3292)
2017-09-15 13:02:29 +00:00
<li<%= sidebar_current("docs-http-secret-kv") %>>
<a href="/api/secret/kv/index.html">Key/Value</a>
Cleanup CSS
2017-03-26 20:04:14 +00:00
</li>
docs: Identity Store (#3055)
2017-07-25 22:33:17 +00:00
<li<%= sidebar_current("docs-http-secret-identity") %>>
<a href="/api/secret/identity/index.html">Identity</a>
API refactoring and doc updates (#3577) * Doc updates and API refactoring * fix tests * change metadata fieldtype to TypeKVPairs * Give example for TypeKVPairs in CLI for metadata * Update API docs examples to reflect the native expected value for TypeKVPairs * Don't mention comma separation in the docs for TypeCommaStringSlice * s/groups/group; s/entities/entity; s/entity-aliases/entity-alias; s/group-aliases/group-alias * Address review feedback * Fix formatting * fix sidebar links
2017-11-14 01:59:42 +00:00
<ul class="nav">
<li<%= sidebar_current("docs-http-secret-identity-entity") %>>
<a href="/api/secret/identity/entity.html">Entity</a>
</li>
<li<%= sidebar_current("docs-http-secret-identity-entity-alias") %>>
<a href="/api/secret/identity/entity-alias.html">Entity Alias</a>
</li>
<li<%= sidebar_current("docs-http-secret-identity-group") %>>
<a href="/api/secret/identity/group.html">Group</a>
</li>
<li<%= sidebar_current("docs-http-secret-identity-group-alias") %>>
<a href="/api/secret/identity/group-alias.html">Group Alias</a>
</li>
<li<%= sidebar_current("docs-http-secret-identity-lookup") %>>
<a href="/api/secret/identity/lookup.html">Lookup</a>
</li>
</ul>
docs: Identity Store (#3055)
2017-07-25 22:33:17 +00:00
</li>
Cleanup CSS
2017-03-26 20:04:14 +00:00
<li<%= sidebar_current("docs-http-secret-pki") %>>
<a href="/api/secret/pki/index.html">PKI</a>
</li>
<li<%= sidebar_current("docs-http-secret-rabbitmq") %>>
<a href="/api/secret/rabbitmq/index.html">RabbitMQ</a>
</li>
<li<%= sidebar_current("docs-http-secret-ssh") %>>
<a href="/api/secret/ssh/index.html">SSH</a>
</li>
Implemented TOTP Secret Backend (#2492) * Initialized basic outline of TOTP backend using Postgresql backend as template * Updated TOTP backend.go's structure and help string * Updated TOTP path_roles.go's structure and help strings * Updated TOTP path_role_create.go's structure and help strings * Fixed typo in path_roles.go * Fixed errors in path_role_create.go and path_roles.go * Added TOTP secret backend information to cli commands * Fixed build errors in path_roles.go and path_role_create.go * Changed field values of period and digits from uint to int, added uint conversion of period when generating passwords * Initialized TOTP test file based on structure of postgresql test file * Added enforcement of input values * Added otp library to vendor folder * Added test steps and cleaned up errors * Modified read credential test step, not working yet * Use of vendored package not allowed - Test error * Removed vendor files for TOTP library * Revert "Removed vendor files for TOTP library" This reverts commit fcd030994bc1741dbf490f3995944e091b11da61. * Hopefully fixed vendor folder issue with TOTP Library * Added additional tests for TOTP backend * Cleaned up comments in TOTP backend_test.go * Added default values of period, algorithm and digits to field schema * Changed account_name and issuer fields to optional * Removed MD5 as a hash algorithm option * Implemented requested pull request changes * Added ability to validate TOTP codes * Added ability to have a key generated * Added skew, qr size and key size parameters * Reset vendor.json prior to merge * Readded otp and barcode libraries to vendor.json * Modified help strings for path_role_create.go * Fixed test issue in testAccStepReadRole * Cleaned up error formatting, variable names and path names. Also added some additional documentation * Moveed barcode and url output to key creation function and did some additional cleanup based on requested changes * Added ability to pass in TOTP urls * Added additional tests for TOTP server functions * Removed unused QRSize, URL and Generate members of keyEntry struct * Removed unnecessary urlstring variable from pathKeyCreate * Added website documentation for TOTP secret backend * Added errors if generate is true and url or key is passed, removed logger from backend, and revised parameter documentation. * Updated website documentation and added QR example * Added exported variable and ability to disable QR generation, cleaned up error reporting, changed default skew value, updated documentation and added additional tests * Updated API documentation to inlude to exported variable and qr size option * Cleaned up return statements in path_code, added error handling while validating codes and clarified documentation for generate parameters in path_keys
2017-05-04 17:49:42 +00:00
<li<%= sidebar_current("docs-http-secret-totp") %>>
<a href="/api/secret/totp/index.html">TOTP</a>
</li>
Cleanup CSS
2017-03-26 20:04:14 +00:00
<li<%= sidebar_current("docs-http-secret-transit") %>>
<a href="/api/secret/transit/index.html">Transit</a>
</li>
API Docs updates (#3101)
2017-08-08 16:28:17 +00:00
<hr>
<li<%= sidebar_current("docs-http-secret-cassandra") %>>
<a href="/api/secret/cassandra/index.html">Cassandra <sup>DEPRECATED</sup></a>
</li>
<li<%= sidebar_current("docs-http-secret-mongodb") %>>
<a href="/api/secret/mongodb/index.html">MongoDB <sup>DEPRECATED</sup></a>
</li>
<li<%= sidebar_current("docs-http-secret-mssql") %>>
<a href="/api/secret/mssql/index.html">MSSQL <sup>DEPRECATED</sup></a>
</li>
<li<%= sidebar_current("docs-http-secret-mysql") %>>
<a href="/api/secret/mysql/index.html">MySQL <sup>DEPRECATED</sup></a>
</li>
<li<%= sidebar_current("docs-http-secret-postgresql") %>>
<a href="/api/secret/postgresql/index.html">PostgreSQL <sup>DEPRECATED</sup></a>
</li>
</ul>
</li>
<li<%= sidebar_current("docs-http-auth") %>>
<a href="/api/auth/index.html">Auth Backends</a>
<ul class="nav">
<li<%= sidebar_current("docs-http-auth-approle") %>>
<a href="/api/auth/approle/index.html">AppRole</a>
</li>
<li<%= sidebar_current("docs-http-auth-aws") %>>
<a href="/api/auth/aws/index.html">AWS</a>
</li>
<li<%= sidebar_current("docs-http-auth-github") %>>
<a href="/api/auth/github/index.html">Github</a>
</li>
Initial GCP auth backend documentation (#3167)
2017-08-16 02:03:04 +00:00
<li<%= sidebar_current("docs-http-auth-gcp") %>>
<a href="/api/auth/gcp/index.html">Google Cloud</a>
</li>
Kubernetes auth (#3350) * Import the kubernetes credential backend * Add kubernetes docs * Escape * characters * Revert "Import the kubernetes credential backend" This reverts commit f12627a9427bcde7e73cea41dea19d0922f94789. * Update the vendored directory
2017-09-19 14:27:26 +00:00
<li<%= sidebar_current("docs-http-auth-kubernetes") %>>
<a href="/api/auth/kubernetes/index.html">Kubernetes</a>
</li>
API Docs updates (#3101)
2017-08-08 16:28:17 +00:00
<li<%= sidebar_current("docs-http-auth-ldap") %>>
<a href="/api/auth/ldap/index.html">LDAP</a>
</li>
<li<%= sidebar_current("docs-http-auth-okta") %>>
<a href="/api/auth/okta/index.html">Okta</a>
</li>
<li<%= sidebar_current("docs-http-auth-radius") %>>
<a href="/api/auth/radius/index.html">RADIUS</a>
</li>
<li<%= sidebar_current("docs-http-auth-cert") %>>
<a href="/api/auth/cert/index.html">TLS Certificates</a>
</li>
<li<%= sidebar_current("docs-http-auth-token") %>>
<a href="/api/auth/token/index.html">Tokens</a>
</li>
<li<%= sidebar_current("docs-http-auth-userpass") %>>
<a href="/api/auth/userpass/index.html">Username & Password</a>
</li>
<hr>
<li<%= sidebar_current("docs-http-auth-appid") %>>
<a href="/api/auth/app-id/index.html">App ID <sup>DEPRECATED</sup></a>
</li>
Cleanup CSS
2017-03-26 20:04:14 +00:00
</ul>
</li>
Fix http layout
2017-03-06 21:10:35 +00:00
Cleanup CSS
2017-03-26 20:04:14 +00:00
<li<%= sidebar_current("docs-http-system")%>>
<a href="/api/system/index.html">System Backend</a>
<ul class="nav">
<li<%= sidebar_current("docs-http-system-audit/") %>>
<a href="/api/system/audit.html"><tt>/sys/audit</tt></a>
</li>
<li<%= sidebar_current("docs-http-system-audit-hash") %>>
<a href="/api/system/audit-hash.html"><tt>/sys/audit-hash</tt></a>
</li>
<li<%= sidebar_current("docs-http-system-auth") %>>
<a href="/api/system/auth.html"><tt>/sys/auth</tt></a>
</li>
<li<%= sidebar_current("docs-http-system-capabilities/") %>>
<a href="/api/system/capabilities.html"><tt>/sys/capabilities</tt></a>
</li>
<li<%= sidebar_current("docs-http-system-capabilities-accessor") %>>
<a href="/api/system/capabilities-accessor.html"><tt>/sys/capabilities-accessor</tt></a>
</li>
<li<%= sidebar_current("docs-http-system-capabilities-self") %>>
<a href="/api/system/capabilities-self.html"><tt>/sys/capabilities-self</tt></a>
</li>
<li<%= sidebar_current("docs-http-system-config-auditing") %>>
<a href="/api/system/config-auditing.html"><tt>/sys/config/auditing</tt></a>
</li>
Sync docs
2017-11-14 11:13:11 +00:00
<li<%= sidebar_current("docs-http-system-config-control-group") %>>
<a href="/api/system/config-control-group.html"><tt>/sys/config/control-group</tt></a>
</li>
Fix up CORS. Ref #2021
2017-06-17 05:26:25 +00:00
<li<%= sidebar_current("docs-http-system-config-cors") %>>
<a href="/api/system/config-cors.html"><tt>/sys/config/cors</tt></a>
</li>
Sync docs
2017-11-14 11:13:11 +00:00
<li<%= sidebar_current("docs-http-system-control-group") %>>
<a href="/api/system/control-group.html"><tt>/sys/control-group</tt></a>
</li>
Cleanup CSS
2017-03-26 20:04:14 +00:00
<li<%= sidebar_current("docs-http-system-generate-root") %>>
<a href="/api/system/generate-root.html"><tt>/sys/generate-root</tt></a>
</li>
<li<%= sidebar_current("docs-http-system-health") %>>
<a href="/api/system/health.html"><tt>/sys/health</tt></a>
</li>
<li<%= sidebar_current("docs-http-system-init") %>>
<a href="/api/system/init.html"><tt>/sys/init</tt></a>
</li>
<li<%= sidebar_current("docs-http-system-key-status") %>>
<a href="/api/system/key-status.html"><tt>/sys/key-status</tt></a>
</li>
<li<%= sidebar_current("docs-http-system-leader") %>>
<a href="/api/system/leader.html"><tt>/sys/leader</tt></a>
</li>
Add the ability to view and list of leases metadata (#2650)
2017-05-04 02:03:42 +00:00
<li<%= sidebar_current("docs-http-system-leases") %>>
<a href="/api/system/leases.html"><tt>/sys/leases</tt></a>
</li>
docs: MFA API (#3109)
2017-08-04 03:32:22 +00:00
<li<%= sidebar_current("docs-http-system-mfa") %>>
<a href="/api/system/mfa.html"><tt>/sys/mfa</tt></a>
docs: API docs for TOTP, Okta and Duo MFA (#3129) * docs: API docs for TOTP, Okta and Duo MFA * docs: List types in the MFA main page
2017-08-09 00:20:37 +00:00
<ul class="nav">
Add PingID MFA docs (#3182)
2017-08-16 02:01:34 +00:00
<li<%= sidebar_current("docs-http-system-mfa-duo") %>>
<a href="/api/system/mfa-duo.html"><tt>/sys/mfa/method/duo</tt></a>
docs: API docs for TOTP, Okta and Duo MFA (#3129) * docs: API docs for TOTP, Okta and Duo MFA * docs: List types in the MFA main page
2017-08-09 00:20:37 +00:00
</li>
<li<%= sidebar_current("docs-http-system-mfa-okta") %>>
<a href="/api/system/mfa-okta.html"><tt>/sys/mfa/method/okta</tt></a>
</li>
Add PingID MFA docs (#3182)
2017-08-16 02:01:34 +00:00
<li<%= sidebar_current("docs-http-system-mfa-pingid") %>>
<a href="/api/system/mfa-pingid.html"><tt>/sys/mfa/method/pingid</tt></a>
</li>
<li<%= sidebar_current("docs-http-system-mfa-totp") %>>
<a href="/api/system/mfa-totp.html"><tt>/sys/mfa/method/totp</tt></a>
docs: API docs for TOTP, Okta and Duo MFA (#3129) * docs: API docs for TOTP, Okta and Duo MFA * docs: List types in the MFA main page
2017-08-09 00:20:37 +00:00
</li>
</ul>
docs: MFA API (#3109)
2017-08-04 03:32:22 +00:00
</li>
Cleanup CSS
2017-03-26 20:04:14 +00:00
<li<%= sidebar_current("docs-http-system-mounts") %>>
<a href="/api/system/mounts.html"><tt>/sys/mounts</tt></a>
</li>
plugins/backend/reload -> plugins/reload/backend (#3186)
2017-08-16 16:40:38 +00:00
<li<%= sidebar_current("docs-http-system-plugins-reload-backend") %>>
<a href="/api/system/plugins-reload-backend.html"><tt>/sys/plugins/reload/backend</tt></a>
Add plugin backends docs (#3125) * Add docs on plugins/backend/reload, add plugin backend guide * Fix docs headers * Fix API endpoint description * Update plugin guide and internals pages
2017-08-08 16:39:19 +00:00
</li>
Add the plugins catalog API docs
2017-05-03 18:43:24 +00:00
<li<%= sidebar_current("docs-http-system-plugins-catalog") %>>
<a href="/api/system/plugins-catalog.html"><tt>/sys/plugins/catalog</tt></a>
</li>
Cleanup CSS
2017-03-26 20:04:14 +00:00
<li<%= sidebar_current("docs-http-system-policy") %>>
<a href="/api/system/policy.html"><tt>/sys/policy</tt></a>
</li>
Sync docs
2017-11-14 11:13:11 +00:00
<li<%= sidebar_current("docs-http-system-policies") %>>
<a href="/api/system/policies.html"><tt>/sys/policies</tt></a>
</li>
Cleanup CSS
2017-03-26 20:04:14 +00:00
<li<%= sidebar_current("docs-http-system-raw") %>>
<a href="/api/system/raw.html"><tt>/sys/raw</tt></a>
</li>
<li<%= sidebar_current("docs-http-system-rekey") %>>
<a href="/api/system/rekey.html"><tt>/sys/rekey</tt></a>
</li>
Add docs for /sys/rekey-recovery-key (#3520)
2017-11-08 19:22:30 +00:00
<li<%= sidebar_current("docs-http-system-rekey-recovery-key") %>>
<a href="/api/system/rekey-recovery-key.html"><tt>/sys/rekey-recovery-key</tt></a>
</li>
Cleanup CSS
2017-03-26 20:04:14 +00:00
<li<%= sidebar_current("docs-http-system-remount") %>>
<a href="/api/system/remount.html"><tt>/sys/remount</tt></a>
</li>
<li<%= sidebar_current("docs-http-system-replication") %>>
<a href="/api/system/replication.html"><tt>/sys/replication</tt></a>
Add docs for DR Replication (#3067) * Add docs for DR Replication * Fix up docs
2017-07-26 20:47:41 +00:00
<ul class="nav">
<li<%= sidebar_current("docs-http-system-replication-performance") %>>
<a href="/api/system/replication-performance.html"><tt>/sys/replication/performance</tt></a>
</li>
<li<%= sidebar_current("docs-http-system-replication-dr") %>>
<a href="/api/system/replication-dr.html"><tt>/sys/replication/dr</tt></a>
</li>
</ul>
</li>
Cleanup CSS
2017-03-26 20:04:14 +00:00
<li<%= sidebar_current("docs-http-system-rotate") %>>
<a href="/api/system/rotate.html"><tt>/sys/rotate</tt></a>
</li>
<li<%= sidebar_current("docs-http-system-seal/") %>>
<a href="/api/system/seal.html"><tt>/sys/seal</tt></a>
</li>
<li<%= sidebar_current("docs-http-system-seal-status") %>>
<a href="/api/system/seal-status.html"><tt>/sys/seal-status</tt></a>
</li>
<li<%= sidebar_current("docs-http-system-step-down") %>>
<a href="/api/system/step-down.html"><tt>/sys/step-down</tt></a>
</li>
copying general purpose tools from transit backend to /sys/tools (#3391)
2017-10-20 14:59:17 +00:00
<li<%= sidebar_current("docs-http-system-tools") %>>
<a href="/api/system/tools.html"><tt>/sys/tools</tt></a>
</li>
Cleanup CSS
2017-03-26 20:04:14 +00:00
<li<%= sidebar_current("docs-http-system-unseal") %>>
<a href="/api/system/unseal.html"><tt>/sys/unseal</tt></a>
</li>
<li<%= sidebar_current("docs-http-system-wrapping-lookup") %>>
<a href="/api/system/wrapping-lookup.html"><tt>/sys/wrapping/lookup</tt></a>
</li>
<li<%= sidebar_current("docs-http-system-wrapping-rewrap") %>>
<a href="/api/system/wrapping-rewrap.html"><tt>/sys/wrapping/rewrap</tt></a>
</li>
<li<%= sidebar_current("docs-http-system-wrapping-unwrap") %>>
<a href="/api/system/wrapping-unwrap.html"><tt>/sys/wrapping/unwrap</tt></a>
</li>
<li<%= sidebar_current("docs-http-system-wrapping-wrap") %>>
<a href="/api/system/wrapping-wrap.html"><tt>/sys/wrapping/wrap</tt></a>
</li>
</ul>
</li>
</ul>
Fix http layout
2017-03-06 21:10:35 +00:00
<% end %>
website: lots more docs
2015-04-10 05:52:02 +00:00
Fix http layout
2017-03-06 21:10:35 +00:00
<%= yield %>
website: lots more docs
2015-04-10 05:52:02 +00:00
<% end %>