majuna/docs/user/eotk.rst

60 lines
No EOL
1.7 KiB
ReStructuredText

Enterprise Onion Toolkit
========================
Once your administrator has provided you access to the portal, you can begin to configure your onion service
deployments. To get started, select "Groups" under "Configuration" from the menu on the left hand side.
If you are using a mobile device, you may need to click the hamburger icon at the top of the screen to open the menu.
.. image:: /_static/groups/list.png
:width: 800
You will see a ✅ or ❌ in the "EOTK" column for the group to show whether or not EOTK instances are enabled for that
group.
Creating a new group
--------------------
If the group you would like to use EOTK for does not yet exist, create a new group by clicking the "Create new group"
button.
.. image:: /_static/groups/new.png
:width: 800
Short Name
""""""""""
This must be a unique short name for the group. It needs to be short. No more than 4-5 characters.
Description
"""""""""""
A free-form description for the group.
Deploy EOTK instances
"""""""""""""""""""""
Tick this checkbox to deploy EOTK instances for this group.
Adding EOTK to an existing group
--------------------------------
Click "View/Edit" next to the group that you'd like to edit.
.. image:: /_static/groups/edit.png
:width: 800
Description
"""""""""""
A free-form description for the group.
Deploy EOTK instances
"""""""""""""""""""""
Tick this checkbox to deploy EOTK instances for this group.
Managing EOTK instances
-----------------------
It is not currently possible to manage the EOTK instances via the portal. Rather, you must use the AWS Systems Manager
to manage the EOTK instances via the command line. See the :doc:`Administration Guide <../admin/eotk>` for more details.