From 21e4cc9f4dc7522b46c28c05ec025c01be387409 Mon Sep 17 00:00:00 2001 From: kevgliss Date: Thu, 24 Sep 2015 09:21:08 -0700 Subject: [PATCH] Adding connections in user guides --- docs/guide/index.rst | 82 +++++++++++++++++++++------------------ docs/quickstart/index.rst | 6 ++- 2 files changed, 49 insertions(+), 39 deletions(-) diff --git a/docs/guide/index.rst b/docs/guide/index.rst index bb369402..d34d4baf 100644 --- a/docs/guide/index.rst +++ b/docs/guide/index.rst @@ -3,46 +3,15 @@ User Guide These guides are quick tutorials on how to perform basic tasks in Lemur. -Create a New User -~~~~~~~~~~~~~~~~~ -.. figure:: settings.png - - From the settings dropdown select "Users" - -.. figure:: create.png - - In the user table select "Create" - -.. figure:: create_user.png - - Enter the username, email and password for the user. You can also assign any - roles that the user will need when they login. While there is no deletion - (we want to track creators forever) you can mark a user as 'Inactive' that will - not allow them to login to Lemur. - - -Create a New Role -~~~~~~~~~~~~~~~~~ - -.. figure:: settings.png - - From the settings dropdown select "Roles" - -.. figure:: create.png - - In the role table select "Create" - -.. figure:: create_role.png - - Enter a role name and short description about the role. You can optionally store - a user/password on the role. This is useful if your authority require specific roles. - You can then accurately map those roles onto Lemur users. Also optional you can assign - users to your new role. - Create a New Authority ~~~~~~~~~~~~~~~~~~~~~~ +Before Lemur can issue certificates you must configure the authority you wish use. Lemur itself does +not issue certificates, it relies on external CAs and the plugins associated with those CAs to create the certificate +that Lemur can then manage. + + .. figure:: create.png In the authority table select "Create" @@ -92,4 +61,43 @@ Import an Existing Certificate a certificate name but you can override that by passing a value to the `Custom Name` field. You can add notification options and upload the created certificate to a destination, both - of these are editable features and can be changed after the certificate has been created. + of these are editable features and can be changed after the certificate has been created. + + +Create a New User +~~~~~~~~~~~~~~~~~ +.. figure:: settings.png + + From the settings dropdown select "Users" + +.. figure:: create.png + + In the user table select "Create" + +.. figure:: create_user.png + + Enter the username, email and password for the user. You can also assign any + roles that the user will need when they login. While there is no deletion + (we want to track creators forever) you can mark a user as 'Inactive' that will + not allow them to login to Lemur. + + +Create a New Role +~~~~~~~~~~~~~~~~~ + +.. figure:: settings.png + + From the settings dropdown select "Roles" + +.. figure:: create.png + + In the role table select "Create" + +.. figure:: create_role.png + + Enter a role name and short description about the role. You can optionally store + a user/password on the role. This is useful if your authority require specific roles. + You can then accurately map those roles onto Lemur users. Also optional you can assign + users to your new role. + + diff --git a/docs/quickstart/index.rst b/docs/quickstart/index.rst index 342dde7d..4e2ec150 100644 --- a/docs/quickstart/index.rst +++ b/docs/quickstart/index.rst @@ -270,7 +270,9 @@ Decrypts sensitive key material - Used to decrypt the secrets stored in source d What's Next? ------------ -The above gets you going, but for production there are several different security considerations to take into account, +Get familiar with how Lemur works by reviewing the :doc:`../guide/index`. When you're ready +see :doc:`../production/index` for more details on how to configure Lemur for production. + +Remember the above just gets you going, but for production there are several different security considerations to take into account, remember Lemur is handling sensitive data and security is imperative. -See :doc:`../production/index` for more details on how to configure Lemur for production.