dotnet-core/cli/known-issues.md
2016-06-26 18:34:59 -07:00

9.4 KiB
Raw Blame History

Known issues & workarounds

OpenSSL dependency on OS X

OS X "El Capitan" (10.11) comes with 0.9.8 version of OpenSSL. .NET Core depends on versions >= 1.0.1 of OpenSSL. You can update the version by using Homebrew, MacPorts or manually. The important bit is that you need to have the required OpenSSL version on the path when you work with .NET Core.

With Homebrew, you can run the following commands to get this done:

brew update
brew install openssl
brew link --force openssl

Homebrew may also show the following warning:

Apple has deprecated use of OpenSSL in favor of its own TLS and crypto libraries

This warning is meant for the software that uses OpenSSL (in this case, .NET Core) and not for the end-user that is installing said software. Homebrew installation doesn't touch either the existing Apple crypto libraries or existing OpenSSL 0.9.8 version, so there is no impact on any software that uses either one of those crypto solutions and is already installed.

MacPorts doesn't have the concept of linking, so it is reccomended that you uninstall 0.9.8 version of OpenSSL using the following command:

sudo port upgrade openssl
sudo port -f uninstall openssl @0.9.8

You can verify whether you have the right version using the openssl version command from the Terminal.

Running .NET Core CLI on Nano Server

If youre using Nano Server Technical Preview 5 with .NET Core CLI, due to a bug in the Nano Server product, you will need to copy binaries from c:\windows\system32\forwarders. The destination depends on the type of deployment that you are choosing for your application.

For portable applications, the forwarders need to be copied to the shared runtime location. The shared runtime can be found wherever you installed .NET Core (by default, it is C:\Program Files\dotnet) under the following path: shared\Microsoft.NETCore.App\<version>\.

For self-contained applications, the forwarders need to be copied over into the application folder, that is, wherever you put the published output.

This process will ensure that the dotnet host finds the appropriate APIs it needs. If your Nano Server Technical Preview 5 build is updated or serviced, please make sure to repeat this process, in case any of the forwarders have been updated as well.

Apologies for any inconvenience. Again, this has been fixed in later releases.

Users of zsh (z shell) don't get dotnet on the path after install

There is a known issue in oh-my-zsh installer that interferes with how path_helper works on OS X systems. In short, the said installer creates a .zshrc file which contains the exploded path at the time of installation. This clobbers any dynamically generated path, such as the one generated by path_helper.

There is an outstanding PR on the oh-my-zsh repo for this.

Workaround 1: symlink the dotnet binary in the installation directory to a place in the global path, e.g. /usr/local/bin. The command you can use is:

ln -s /usr/local/share/dotnet/dotnet /usr/local/bin

Workaround 2: edit your .zshrc and/or .zshprofile files to add the /usr/local/share/dotnet to the $PATH.

Breaking change in Preview 2 apt-get packages that impacts Preview 1 packages

We made a breaking change in the way we package Preview 2 Ubuntu packages that also affects Preview 1 packages. The core of the change is that the host policy is now not packaged together with the host, but separately. This means that when you install Preview 1 packages from our Ubuntu apt-get feed, you will run into the following error message when trying to run any dotnet command:

Failed to resolve library symbol hostfxr_main, error: dotnet: undefined symbol: hostfxr_main Segmentation fault (core dumped)

Issues tracking this:

Affects: the Preview 1 apt-get packages

Workaround: there are two main workarounds:

  1. Use the dotnet-install.sh script to install the bits you need; ater you install them, do not forget to put them in the $PATH either by symlinking the dotnet binary in a global place (e.g. /usr/local/bin) or by adding the install directory to the $PATH.
  2. Install the Preview 2 of tooling and then use the sudo apt-get install dotnet-sharedframework-microsoft.netcore.app-1.0.0-rc2-3002702 commands to install the Preview 1 shared framework so that you apps can continue to work.

app.config file needs to be checked out before publishing

If you have an app.config file in source control that places locks on local files (such as TFS), you will recieve the following error during publishing:

Failed to make the following project runnable: <project name> reason: Access to the path <path> is denied.

To resolve this, checkout the app.config file from the source control prior to publishing.

dotnet restore in the root of the file system fails

If you run dotnet restore in the root of the file system (/ in Linux/macOS or C:\ in Windows) it may fail even if you have the project.json file in the root. By default, running the command without specifying the project file will result in the command trying to locate any project files in all subdirectories in the file system. That will fail for certain paths due to security.

Workaround: point dotnet restore towards the actual project file using the -p switch.

More information: https://github.com/NuGet/Home/issues/3038

On dev builds of the tools, restoring default project from dotnet new fails

When using non-release versions of the CLI, dotnet restore will fail to restore Microsoft.NETCore.App because for that particular version it exists on a NuGet feed that is not configured on the machine. This behavior is by design and does not happen with public releases (such as RC2).

Workaround: create a NuGet.config file in the project directory which contains the following:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <packageSources>
    <!--To inherit the global NuGet package sources remove the <clear/> line below -->
    <clear />
    <add key="dotnet-core" value="https://dotnet.myget.org/F/dotnet-core/api/v3/index.json" />
    <add key="api.nuget.org" value="https://api.nuget.org/v3/index.json" />
  </packageSources>
</configuration>

Running dotnet on Debian distributions causes a segmentation fault

If a Debian machine is set in a certain way it may cause the native host (dotnet) to produce a segmentation fault. The culprit is the failed installation of the libicu dependency due to mirror package repository setup. If you fail to set up mirror package repositories, apt-get may not be able to resolve the dependency and the host will fail at runtime.

Affects: the native host

Workaround: make sure that all of the native pre-requisites are installed correctly. You can usually do this by running apt-get package manager.

dotnet restore times out on Win7 x64

If you have any virtualization software (so far we've confirmed VMWare and Virtual Box) and you try to use the CLI on a Win7 SP1 x64 machine, dotnet restore will be really slow and will eventually time out without doing much restoring. The issue is in the virtual networking adapters that usually get installed with said software.

Issues tracking this:

Affects: dotnet restore

Workaround: disable the virtual network interface and do the restore.

Resolving the Standard library packages

The StdLib package is on a MyGet feed. In order to restore it, a MyGet feed needs to be added to the NuGet feeds, either locally per application or in a central location.

Issues tracking this:

Affects: dotnet restore

Workaround: update to the latest bits and run dotnet new in an empty directory. This will now drop a nuget.config file that you can use in other applications.

If you cannot update, you can use the following nuget.config:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <packageSources>
    <!--To inherit the global NuGet package sources remove the <clear/> line below -->
    <clear />
    <add key="dotnet-core" value="https://dotnet.myget.org/F/dotnet-core/api/v3/index.json" />
    <add key="api.nuget.org" value="https://api.nuget.org/v3/index.json" />
  </packageSources>
</configuration>

Uninstalling/reinstalling the PKG on OS X

OS X doesn't really have an uninstall capacity for PKGs like Windows has for MSIs. There is, however, a way to remove the bits as well as the "recipe" for dotnet. More information can be found on this SuperUser question.

What is this document about?

This document outlines the known issues and workarounds for the current state of the CLI tools. Issues will also have a workaround and affects sections if necessary. You can use this page to get information and get unblocked.

What is a "known issue"?

A "known issue" is a major issue that block users in doing their everyday tasks and that affect all or most of the commands in the CLI tools. If you want to report or see minor issues, you can use the issues list.