Skip to content
This repository has been archived by the owner on Nov 14, 2023. It is now read-only.

Commit

Permalink
Adjust Windows Installation Instructions to account for Nuclio issue#…
Browse files Browse the repository at this point in the history
…1821 (cvat-ai#5558)

In my understanding of nuclio/nuclio#1821, the
Nuctl (1.8.14) CLI is looking for a path that is only valid on a Linux
environment, which it does not find when running via Git Bash (even when
using the Windows version of Nuctl). However, installing CVAT onto a
Linux VM allows Nuctl to locate this path and operate normally. I
initially found this when setting up CVAT myself on Git Bash as per the
given instructions for Windows 10.

(I am still learning how to use GitHub as far as pull requests / forks /
etc work, sorry if this is not the right way to approach this change.
Please let me know if I've missed something important.)

### How has this been tested?
This is only a change to instructions, but I did test this on multiple
machines . As long as the machine is capable of running a Linux kernel
it shouldn't run into any issues.
  • Loading branch information
Bytestorm5 authored and mikhail-treskin committed Jul 1, 2023
1 parent 552a942 commit 6b37d43
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- \[SDK\] The `resource_type` args now have the default value of `local` in task creation functions.
The corresponding arguments are keyword-only now.
(<https://github.com/opencv/cvat/pull/5502>)
- Windows Installation Instructions adjusted to work around <https://github.com/nuclio/nuclio/issues/1821>

### Deprecated
- TDB
Expand Down
10 changes: 6 additions & 4 deletions site/content/en/docs/administration/basics/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,8 +127,7 @@ For access from China, read [sources for users from China](#sources-for-users-fr
## Windows 10

- Install WSL2 (Windows subsystem for Linux) refer to [this official guide](https://docs.microsoft.com/windows/wsl/install-win10).
WSL2 requires Windows 10, version 2004 or higher. Note: You may not have to install a Linux distribution unless
needed.
WSL2 requires Windows 10, version 2004 or higher. After installing WSL2, install a Linux Distribution of your choice.

- Download and install [Docker Desktop for Windows](https://desktop.docker.com/win/main/amd64/Docker%20Desktop%20Installer.exe).
Double-click `Docker for Windows Installer` to run the installer.
Expand All @@ -137,6 +136,9 @@ For access from China, read [sources for users from China](#sources-for-users-fr
[here](https://docs.docker.com/docker-for-windows/wsl/). Note: Check that you are specifically using WSL2 backend
for Docker.

- In Docker Desktop, go to `Settings >> Resources >> WSL Integration`, and
enable integration with the Linux Distribution that you chose.

- Download and install
[Git for Windows](https://github.com/git-for-windows/git/releases/download/v2.21.0.windows.1/Git-2.21.0-64-bit.exe).
When installing the package please keep all options by default.
Expand All @@ -145,7 +147,7 @@ For access from China, read [sources for users from China](#sources-for-users-fr
- Download and install [Google Chrome](https://www.google.com/chrome/). It is the only browser
which is supported by CVAT.

- Go to windows menu, find `Git Bash` application and run it. You should see a terminal window.
- Go to windows menu, find the Linux distribution you installed and run it. You should see a terminal window.

- Clone _CVAT_ source code from the
[GitHub repository](https://github.com/opencv/cvat).
Expand Down Expand Up @@ -183,7 +185,7 @@ For access from China, read [sources for users from China](#sources-for-users-fr
below:

```shell
winpty docker exec -it cvat_server bash -ic 'python3 ~/manage.py createsuperuser'
sudo docker exec -it cvat_server bash -ic 'python3 ~/manage.py createsuperuser'
```

If you don't have winpty installed or the above command does not work, you may also try the following:
Expand Down

0 comments on commit 6b37d43

Please sign in to comment.