Installing Sensei ================= This guide will go through the steps to install and authenticate your Sensei installation. Note that a nightly build version is also available, see :doc:`/topics/alphaversion`. .. contents:: Install Direct from Marketplace ------------------------------- You can install direct from the JetBrains marketplace by clicking the button below. .. raw:: html :file: install-direct.html Downloading and Installing -------------------------- Since Sensei gets distributed through the JetBrains marketplace, there is no need to leave your IDE to install the tool. It can be installed by going to the IDE plugin settings. Find Sensei in the list of plugins and hit the install button ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Open the IDE settings and navigate to the 'plugins' section. This can be opened from the menu bar: * macOS: :guilabel:`IntelliJ IDEA | Preferences | Plugins` .. image:: images/mac-preferences.png * Windows and Linux: :guilabel:`File | Settings | Plugins` .. image:: images/linux-windows-settings.png Search for Sensei and hit the install button .. image:: images/plugins-sensei.png :class: noshadow Restart after IntelliJ finished the download ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Wait until IntelliJ has finished the download and installation. Afterwards, IntelliJ is going to prompt you to restart your IDE. .. image:: images/plugins-sensei-installed.png :class: noshadow Optional authentication ----------------------- After the restart of IntelliJ, Sensei will be ready for use. If you are using an Enterprise version of Sensei then authenticate the plugin to use the organization features like centrally controlled Remote Cookbooks. Authenticating in the settings menu ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Find the Sensei entry in the IDE settings. .. image:: images/settings-entry.png :class: noshadow At the top there is the account section where the authentication process can be started using the :guilabel:`Authenticate in Browser` button. Inside the browser, a website will be loaded that takes you to our login page. Provide your authentication credentials or register a new account to sign in. .. note:: If your company is using SSO, you will be redirected to your internal authentication provider after providing your email address. .. image:: images/portal-login.png Once you've authenticated yourself, you will receive the message that you have been successfully authenticated, and that you may close the browser window. .. image:: images/portal-success-msg.png Back in the IDE, you may want to press the :guilabel:`Refresh now` button or wait until a refresh happens automatically. .. image:: images/waiting-for-portal-login.png :class: noshadow Sensei will then complete the registration and load the cookbook configurations and recipes that are configured in the organized to which the account belongs to, if applicable. Your Sensei installation is now authenticated and the organization cookbooks should have been loaded. .. image:: images/authenticated.png :class: noshadow