diff --git a/docs/api/api.rst b/docs/api/api.rst --- a/docs/api/api.rst +++ b/docs/api/api.rst @@ -9,6 +9,14 @@ methods. Everything is available by send ``/_admin/api``. +API keys +-------- + +Every Kallithea user automatically receives an API key, which they can +view under "My Account". On this page, API keys can also be revoked, and +additional API keys can be generated. + + API access ---------- diff --git a/kallithea/templates/admin/my_account/my_account_api_keys.html b/kallithea/templates/admin/my_account/my_account_api_keys.html --- a/kallithea/templates/admin/my_account/my_account_api_keys.html +++ b/kallithea/templates/admin/my_account/my_account_api_keys.html @@ -79,6 +79,19 @@ ${h.end_form()} +
+

${_(''' +API keys are used to let scripts or services access %s using your +account, as if you had provided the script or service with your actual +password. +''') % (c.site_name or 'Kallithea')}

+

${_(''' +Like passwords, API keys should therefore never be shared with others, +nor passed to untrusted scripts or services. If such sharing should +happen anyway, reset the API key on this page to prevent further use. +''')}

+
+