Moving certain documents to the dotnet/core repo (#3660)
* Moving certain documents to the dotnet/core repo Moving the following documents to the dotnet/core repo, to make maintenance easier and also to keep all of the various support documents for .NET Core all-up in the same place. The documents changed: * supported-os-matrix.md * known-issues.md * cli-prerequisites.md Also editing the README.md document to point to the new repo and its documents where needed.
This commit is contained in:
Zlatko Knezevic
GitHub
parent
c160c8256a
commit
7f9c510247
4 changed files with 4 additions and 201 deletions
|
|
@ -1,51 +1,4 @@
|
|||
CLI native prerequisites
|
||||
=========================
|
||||
|
||||
This document outlines the dependencies needed to run .NET Core CLI tools. Most of these dependencies are also .NET Core's general dependencies, so installing them will make sure that you can run applications written for .NET Core in general.
|
||||
|
||||
## Windows dependencies
|
||||
On Windows, the only dependency is the VC++ Redistributable. Depending on the version of Windows you are running on, the versions are changing.
|
||||
|
||||
> **Note:** these dependencies are chained in the installer, you only need to install them manually if you are using
|
||||
> the installer script (`dotnet-install.sh` or `dotnet-install.ps1`).
|
||||
|
||||
* Windows 10
|
||||
* [Visual C++ Redistributable for Visual Studio 2015](https://www.microsoft.com/en-us/download/details.aspx?id=48145)
|
||||
* Pre-Windows 10
|
||||
* Please make sure that your Windows installation is up-to-date and includes hotfix [KB2533623] (https://support.microsoft.com/en-us/kb/2533623) installed through Windows Update.
|
||||
* [Visual C++ Redistributable for Visual Studio 2012 Update 4](https://www.microsoft.com/en-us/download/confirmation.aspx?id=30679)
|
||||
|
||||
## Ubuntu
|
||||
Ubuntu distributions require the following libraries installed:
|
||||
|
||||
- libunwind8
|
||||
- libunwind8-dev
|
||||
- gettext
|
||||
- libicu-dev
|
||||
- liblttng-ust-dev
|
||||
- libcurl4-openssl-dev
|
||||
- libssl-dev
|
||||
- uuid-dev
|
||||
- unzip
|
||||
|
||||
|
||||
## CentOS
|
||||
CentOS distributions require the following libraries installed:
|
||||
|
||||
* deltarpm
|
||||
* epel-release
|
||||
* unzip
|
||||
* libunwind
|
||||
* gettext
|
||||
* libcurl-devel
|
||||
* openssl-devel
|
||||
* zlib
|
||||
* libicu-devel
|
||||
|
||||
## OS X
|
||||
OS X requires the following libraries and versions installed:
|
||||
|
||||
* libssl 1.1
|
||||
|
||||
## Installing the dependencies
|
||||
Please follow the recommended practices of each operating system in question. For Linux, we recommend using your package manager such as `apt-get` for Ubuntu and `yum` for CentOS. For OS X and upgrading the libssl, we recommend using [Homebrew](https://brew.sh/); if you do use it, do not forget the link phase you need to do at the end of install (`brew link openssl --force`).
|
||||
This document now lives in the [.NET Core native pre-requisities document](https://github.com/dotnet/core/blob/master/Documentation/prereqs.md) in the dotnet/core repository.
|
||||
|
|
|
|||
|
|
@ -1,123 +1,4 @@
|
|||
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](https://brew.sh), [MacPorts](https://www.macports.org/) 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:
|
||||
|
||||
```console
|
||||
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:
|
||||
|
||||
```console
|
||||
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 you’re using Nano Server Technical Preview 5 with .NET Core CLI, you will need to copy all DLL files from c:\windows\system32\forwarders to c:\windows\system32, due to a bug that has since been fixed in later releases.
|
||||
|
||||
If you use “dotnet publish”, make sure to copy all DLL files from c:\windows\system32\forwarders to your publish directory as well.
|
||||
|
||||
If your Nano Server Technical Preview 5 build is updated or serviced, please make sure to repeat this process, in case any of the DLLs 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](https://github.com/robbyrussell/oh-my-zsh/pull/4925) 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:
|
||||
|
||||
```console
|
||||
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.
|
||||
|
||||
## 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
|
||||
<?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>
|
||||
```
|
||||
|
||||
## `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:**
|
||||
|
||||
* [#1732](https://github.com/dotnet/cli/issues/1732)
|
||||
|
||||
**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:**
|
||||
|
||||
* [#535](https://github.com/dotnet/cli/issues/535)
|
||||
|
||||
**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
|
||||
<?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](http://superuser.com/questions/36567/how-do-i-uninstall-any-apple-pkg-package-file).
|
||||
|
||||
# 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](https://github.com/dotnet/cli/issues).
|
||||
This document now lives in the [known issues document](https://github.com/dotnet/core/blob/master/cli/known-issues.md) in the dotnet/core repository.
|
||||
|
|
|
|||
|
|
@ -1,35 +1,4 @@
|
|||
Supported OS Matrix for CLI
|
||||
===========================
|
||||
|
||||
This document outlines the supported operating systems for the CLI. "Supported" is defined as a system on which we test
|
||||
the CLI and on which we will make sure CLI works out-of-the-box (OOB).
|
||||
|
||||
This list is not a statement on the current state of things, but a statement of the end-goal. This means that at this time
|
||||
CLI could work less than perfect on some of these systems, which is just a point-in-time thing in the development process.
|
||||
|
||||
If your wanted system is not on this list, that doesn't mean that CLI will not work on it. It just means that we haven't
|
||||
tested it out and we cannot guarantee that it will Just Work(tm).
|
||||
|
||||
## Windows
|
||||
The following versions of Windows are supported:
|
||||
|
||||
- Windows Server 2012 R2 (Full and Server Core)
|
||||
- Windows Server 2012 SP1 (Full and Server Core)
|
||||
- Windows Server 2008 R2 SP1 (Full and Server Core)
|
||||
- Windows Server 2016 (Full, Server Core, and Nano)
|
||||
- Windows 7 SP1
|
||||
- Win 8.1
|
||||
- Win 10
|
||||
|
||||
## Linux (x64 only)
|
||||
The following versions of Linux are supported:
|
||||
|
||||
- Debian 8.2
|
||||
- Ubuntu 14.04 LTS
|
||||
- CentOS 7.1
|
||||
- Red Hat Enterprise Linux 7.2
|
||||
|
||||
## OS X (x64 only)
|
||||
The following versions of OS X are supported:
|
||||
|
||||
- OS X 10.11+ (El Capitan)
|
||||
The supported matrix now lives in the [roadmap document](https://github.com/dotnet/core/blob/master/roadmap.md) in the dotnet/core repository.
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ There have been some changes in the schedule for .NET Core and .NET Core CLI too
|
|||
|
||||
Found an issue?
|
||||
---------------
|
||||
You can consult the [known issues page](Documentation/known-issues.md) to find out the current issues and
|
||||
You can consult the [known issues page](https://github.com/dotnet/core/blob/master/cli/known-issues.md) to find out the current issues and
|
||||
to see the workarounds.
|
||||
|
||||
If you don't find your issue, please file one! However, given that this is a very high-frequency repo, we've setup some [basic guidelines](Documentation/issue-filing-guide.md) to help you. Please consult those first.
|
||||
|
|
|
|||
Loading…
Reference in a new issue