Integration with Anaconda Server


Anaconda Navigator has everything a user needs to set up the Anaconda Server API domain, login with credentials, add channels, and install/update packages from Anaconda Server with Anaconda Navigator.

Login Action

To integrate with Anaconda Server, click Connect in the top-right corner of the Navigator application. Then, click Sign In next to Anaconda Server. If this is the first time you are logging in to Anaconda Server, you’ll be asked to set your Anaconda Server domain.

Enter your domain and click Set Domain.

../../../_images/nav-server-domain.png

If your domain is correct, you’ll see the login pop-up. Enter the credentials you use to log in to your Anaconda Server instance, and then click Login. If all credentials are correct, you will be signed in.

../../../_images/nav-server-sign-in.png

Add default channels action

After signing in, you’ll see a pop-up with a list of available channels. You can choose what channels to use and what channels to add to default_channels by clicking on the checkboxes in the Add to default_channels and Add to channels columns. After you’ve marked channels, click on Add Channels. This step can be skipped by clicking Skip.

../../../_images/nav-server-channels.png

CLI Login Detection

If you have already logged in using CLI, Navigator will detected that and you’ll be asked to check your channels configuration. See Add default channels action for further instruction.

Login Mechanism

A few things happen “under the hood” when you successfully log in:

  • Your access token is created for Anaconda Server. This provides you with the ability to access private/authenticated/public channels, create environments, and download packages.

    ../../../_images/nav-server-token.png

  • logged_api_url, team_edition_token, and team_edition_token_id in the Navigator config file (anaconda-navigator.ini) are updated. This is mostly system data to help Navigator integrate with the Anaconda Server.

    ../../../_images/nav-server-config.png

  • The Conda configuration file (.condarc) is modified:
    1. channels is set to an empty list so you can set appropriate channels
    2. default_channels, if present, will be removed
    3. channel_alias is set to the login used to access your Anaconda Server instance.
    ../../../_images/nav-server-channel-alias.png
  • The access token is stored locally, which gives Conda ‘native’ access to remote channels and packages.

Integration

Once signed in, you will be able to add private channels in the “Manage Channels” popup using the <my_channel_name> format, rather than t/<token>/<my_channel_name>.

Click update index to gain access to all packages located in private/authenticated/public channels in the Anaconda Server instance.

Logout Action

A few things happen “under the hood” when you successfully log out:

  • The Conda configuration file (.condarc) returns to the state it was in before the login. (Navigator saves a copy of the .condarc file before a login in attempted.)
  • logged_api_url, team_edition_token, and team_edition_token_id are set to None in the Navigator config file (anaconda-navigator.ini).
  • The access token created in the Anaconda Server instance is removed.
  • The access token that was stored locally is removed.

Change Anaconda Server API domain

To set the Anaconda Server API domain, go to the navigation bar and click on Preferences. In the text field labeled Anaconda Server API domain, enter the valid domain name:

../../../_images/nav-server-api-domain.png

Alternatively, this API domain can be set through the Configure Conda action:

  1. Click the button Configure Navigator:
../../../_images/configure-navigator1.png

  1. In the pop-up, find the option team_edition_api_url in the section [main] and enter your domain name (by default, the value is set to None):
../../../_images/nav-server-api-url.png

  1. Click Save and Restart. The application will restart and the setting will be set.

Yet another option for users is to change this setting directly where the anaconda-navigator.ini file is located by default.

Note

The domain must be a full path without a trailing slash. For example: http(s)://ate-mysite.com

Troubleshooting

If you are having issues logging in or know you’re logged in but cannot interact with Anaconda Server, see Trouble logging in to Anaconda Server from Navigator.