Quickstart guide for Commercial Edition

To set up Commercial Edition, you will need to make updates to the anaconda or conda configuration file called .condarc. The changes will update the source repository configuration to access the Commercial Edition repository located at repo.anaconda.cloud. The Commercial Edition repository also requires a token for access.


Completely new to Commercial Edition? Start by creating an account.

Already have an account, a profile, and your new Commercial Edition subscription? Skip ahead to learn how to authenticate to Commercial Edition.


This topic provides guidance on the following actions:


What’s available to you through Commercial Edition

The following active channels are available for sourcing packages:

The following archived channels are available for sourcing packages:

Creating an account

Go to https://anaconda.cloud/register to access the Get started with Commercial Edition page, where you will be prompted to create an account.

../../_images/ce_create_account.png

Complete the following steps:

  1. Enter your email address and a secure password.
  2. Check the box next to Agree to agree to our Terms of Service.
  3. Check the Captcha box.
  4. Click Create My Account.

You will then be directed to the Create a profile page.

Creating a profile

../../_images/ce_create_profile.png

Fill out the Personal Information form, select whether you would like to opt in or opt out of marketing promotions or newsletters, and then click Save and Continue to proceed to the Purchase Commercial Edition page.

You will receive a verification email once you have created your profile.

Purchasing Commercial Edition

Complete the following steps:

  1. Select either a monthly or annual subscription.
  2. Enter your billing information.
  3. Check the box stating that you agree to the Anaconda End-User License Agreement.
  4. Click Purchase Now.

You will then be directed to the Purchase Summary page, which includes details on accessing Commercial Edition.

../../_images/ce_purchase_summ.png

You will receive two emails: one confirming your purchase and another containing your token.

Tip

The email containing your private access token also contains the .condarc configuration with your token already embedded, allowing you to see (and copy!) your personal .condarc configuration.

../../_images/ce_token_email.png

Installing Anaconda

If you already have Anaconda Individual Edition or miniconda installed, you’re all set to move forward!

If you have not installed Individual Edition or miniconda yet, please do so from the Individual Edition installation section before proceeding with authentication.

Installing conda token

After installing Anaconda Individual Edition or miniconda, you can install the conda token package. The conda token package is used to edit the .condarc file and secure your token.

Choose the installation method based on your operating system:

Windows

  1. Launch Anaconda Navigator from your Windows application library. Anaconda Navigator is a graphical inteface for Individual Edition.

  2. From Anaconda Navigator launch CMD.exe Prompt. This prompt will be associated with the Individual Edition package libraries.

    ../../_images/ce_cmd_prompt.png

  1. From your prompt, run the following to install the conda token package:

    conda install conda-token -n root
    
  2. Conda will solve the environment. You must enter “y” for yes to proceed with the installation.

OSX and Linux

  1. Launch Terminal. You should see (base) preceding the command line. This means you are in the base environment of Anaconda Individual Edition.

    ../../_images/ce_cmd_base.png

  1. From the terminal, run the following to install the conda token package:

    conda install conda-token -n root
    
  2. Conda will solve the environment. You must enter “y” for yes to proceed with the installation.

Authenticate to Commercial Edition

A private token will be sent to the email address you provided when you created your account. You will need this token to activate your account and gain access to repo.anaconda.cloud.

Warning

You must keep your token private.

You will need to use the terminal to authenticate to Anaconda Commercial Edition and configure access. In your terminal run the following command:

# Replace <TOKEN> with the token value you received in your email after purchasing a subscription.
conda token set <TOKEN>

Note

conda token will validate that your token works by checking that it can be used to connect to Anaconda Commercial Edition.

Once you have run conda token set <TOKEN>, you will be able to install packages from Anaconda Commercial Edition.

Run conda token set --help for more information and optional configuration parameters. The output will look like the following:

$ conda token set --help
usage: conda token set [-h]
                       [--include-archive-channels CHANNEL_NAME [CHANNEL_NAME ...]]
                       [--system | --env | --file FILE]
                       token

positional arguments:
  token                 Your token.

optional arguments:
  -h, --help            show this help message and exit
  --include-archive-channels CHANNEL_NAME [CHANNEL_NAME ...]
                        Add archived channels to default_channels. Available
                        channels are mro, mro-archive, free, and pro.

Config File Location Selection:
  Without one of these flags, the user config file at
  '/Users/me/.condarc' is used.

  --system              Write to the system .condarc file at
                        '/Users/me/Applications/miniconda3/.condarc'.
  --env                 Write to the active conda environment .condarc file
                        (/Users/me/Applications/miniconda3). If no
                        environment is active, write to the user config file
                        (/Users/me/.condarc).
  --file FILE           Write to the given file.

Verify your token configuration

To verify that your token was successfully installed, run the following in your terminal:

conda info

Your channel URLs should all point to repo.anaconda.cloud:

   active environment : base
   active env location : /Users/<USERNAME>/Applications/miniconda3
           shell level : 1
      user config file : /Users/<USERNAME>/.condarc
populated config files : /Users/<USERNAME>/.condarc
         conda version : 4.9.2
   conda-build version : 3.18.11
        python version : 3.7.7.final.0
      virtual packages : __osx=10.14.6=0
                         __unix=0=0
                         __archspec=1=x86_64
      base environment : /Users/<USERNAME>/Applications/miniconda3  (writable)
          channel URLs : https://repo.anaconda.cloud/repo/main/osx-64
                         https://repo.anaconda.cloud/repo/main/noarch
                         https://repo.anaconda.cloud/repo/r/osx-64
                         https://repo.anaconda.cloud/repo/r/noarch
                         https://repo.anaconda.cloud/repo/msys2/osx-64
                         https://repo.anaconda.cloud/repo/msys2/noarch
         package cache : /Users/<USERNAME>/Applications/miniconda3/pkgs
                         /Users/<USERNAME>/.conda/pkgs
      envs directories : /Users/<USERNAME>/Applications/miniconda3/envs
                         /Users/<USERNAME>/.conda/envs
              platform : osx-64
            user-agent : conda/4.9.2 requests/2.24.0 CPython/3.7.7 Darwin/18.7.0 OSX/10.14.6
               UID:GID : 502:20
            netrc file : None
          offline mode : False

Installing conda-forge (Optional)

You may wish to install packages from the conda-forge repository. To do so, run the following command:

conda config --add channels conda-forge

As before, run conda info to verify the change.

Using Anaconda behind a firewall or proxy (Optional)

If you need to use Anaconda behind a firewall or proxy, please follow the instructions in the Individual Edition Troubleshooting page to ensure proper configuration.

Finding, editing, and reviewing .condarc (Optional)

In some cases, you may need to edit the .condarc file directly in order to authenticate to Commercial Edition.

Warning

Putting your token in the .condarc file is not secure. Therefore, the conda token installation method above is the preferred workflow.

You can configure .condarc by editing the file in one of the paths listed in the next section or by running conda config.

Searching for .condarc

The .condarc file can be configured in a number of locations. The file can be edited with a text editor or through the use of conda config commands.

Windows system paths:
     'C:\ProgramData\conda\.condarc',
     'C:\ProgramData\conda\condarc',
     'C:\ProgramData\conda\condarc.d',

Linux and macOS system paths:
     '/etc/conda/.condarc',
     '/etc/conda/condarc',
     '/etc/conda/condarc.d/',
     '/var/lib/conda/.condarc',
     '/var/lib/conda/condarc',
     '/var/lib/conda/condarc.d/',

# Replace CONDA_ROOT with the path for your base conda or Anaconda install.
# Replace CONDA_PREFIX with the path to the current active environment.
# The tilde (~) means home directory on Linux, Mac and Windows.
Local paths on all platforms:
     '$CONDA_ROOT/.condarc',
     '$CONDA_ROOT/condarc',
     '$CONDA_ROOT/condarc.d/',
     '~/.conda/.condarc',
     '~/.conda/condarc',
     '~/.conda/condarc.d/',
     '~/.condarc',
     '$CONDA_PREFIX/.condarc',
     '$CONDA_PREFIX/condarc',
     '$CONDA_PREFIX/condarc.d/',
     '$CONDARC',
 )

If you run conda config commands they will write to ~/.condarc by default, but the location can be changed with the following arguments.

Setting up .condarc for Commercial Edition

Here are the recommended contents of the .condarc file:

restore_free_channel: false
default_channels:
# Replace <TOKEN> with your personal token.
  - https://repo.anaconda.cloud/t/<TOKEN>/repo/main
  - https://repo.anaconda.cloud/t/<TOKEN>/repo/msys2
  - https://repo.anaconda.cloud/t/<TOKEN>/repo/r

  # Uncomment these only if you need them
  # - https://repo.anaconda.cloud/t/<TOKEN>/repo/free
  # - https://repo.anaconda.cloud/t/<TOKEN>/repo/pro
  # - https://repo.anaconda.cloud/t/<TOKEN>/repo/mro-archive
  # - https://repo.anaconda.cloud/t/<TOKEN>/repo/mro

channels:
  - defaults

Default_channels is used here to ensure that conda will not pull any packages from repo.anaconda.com.

If you need to use the free channel, you must uncomment the line with your token but keep restore_free_channel set to false.

Adding conda channels

Warning

Do not use the anaconda channel. This would pull packages from anaconda.org rather than Commercial Edition (defaults).

After you’ve configured the default channels, you can continue to use channels from anaconda.org by listing the name of the channel under channels:. For example, you can add conda-forge after defaults in the channels list to access packages from conda-forge as well.

Some examples of additional channels to use:

Note

Conda will search for packages in the first channel listed when installing packages, then it will search in the second channel listed, and so on.

Learn more about using default repositories and managing channels in our Individual Edition documentation.

Configure .condarc using conda config commands

The following commands can be used to configure the .condarc file from any state to correctly authenticate to Commercial Edition:

# Replace <TOKEN> with your personal token.
> conda config --set restore_free_channel false
> conda config --prepend default_channels https://repo.anaconda.cloud/t/<TOKEN>/repo/main
> conda config --append default_channels https://repo.anaconda.cloud/t/<TOKEN>/repo/msys2
> conda config --append default_channels https://repo.anaconda.cloud/t/<TOKEN>/repo/r
> conda config --prepend channels defaults

by default, the conda config commands above will edit the condarc file in the home directory. Using the conda config file location flags below, you can change the path to the .condarc file you wish to edit.

Config File Location Selection:
Without one of these flags, the user config file at '/Users/<USERNAME>/.condarc' is used.

--system            Write to the system .condarc file at
                    '/Users/<USERNAME>/Applications/miniconda3/.condarc'.
--env               Write to the active conda environment .condarc file (/
                    Users/<USERNAME>/Applications/miniconda3).
                    If no environment is active, write to the user config
                    file (/Users/<USERNAME>/.condarc).
--file FILE         Write to the given file.

Where <USERNAME> is your Anaconda username.


The following commands can be run if you need these channels as well:

# Replace <TOKEN> with your personal token.
> conda config --append default_channels https://repo.anaconda.cloud/t/<TOKEN>/repo/free
> conda config --append default_channels https://repo.anaconda.cloud/t/<TOKEN>/repo/pro

Ensuring .condarc is configured correctly

In order to ensure that your .condarc file is configured correctly, either by running conda config or editing the file directly, run the command conda info in the terminal. As you can see in the example output below, the channel URLs specify repo.anaconda.cloud, not repo.anaconda.com.

   >conda info
    active environment : base
   active env location : /Users/<USERNAME>/Applications/miniconda3
           shell level : 1
      user config file : /Users/<USERNAME>/.condarc
populated config files : /Users/<USERNAME>/.condarc
         conda version : 4.8.4
   conda-build version : 3.18.11
        python version : 3.7.7.final.0
      virtual packages : __osx=10.14.6
      base environment : /Users/<USERNAME>/Applications/miniconda3  (writable)
          channel URLs : https://repo.anaconda.cloud/t/<TOKEN>/repo/main/osx-64
                         https://repo.anaconda.cloud/t/<TOKEN>/repo/main/noarch
                         https://repo.anaconda.cloud/t/<TOKEN>/repo/msys2/osx-64
                         https://repo.anaconda.cloud/t/<TOKEN>/repo/msys2/noarch
         package cache : /Users/<USERNAME>/Applications/miniconda3/pkgs
                         /Users/<USERNAME>/.conda/pkgs
      envs directories : /Users/<USERNAME>/Applications/miniconda3/envs
                         /Users/<USERNAME>/.conda/envs
              platform : osx-64
            user-agent : conda/4.8.4 requests/2.24.0 CPython/3.7.7 Darwin/18.7.0 OSX/10.14.6
               UID:GID : 502:20
            netrc file : None
          offline mode : False

Remove token and reset Conda configuration

You can remove your token and reset your Conda configuration to its default state by running the following:

conda token remove