Windows
Minimum System Requirements
- At least 3GB free space for neurodesktop base image
- Docker requirements. Details found under https://docs.docker.com/get-docker/
- If installing docker using WSL, atleast 20GB space recommended for WSL with Ubuntu
Quickstart
1. Install Docker
Install Docker from here: https://docs.docker.com/get-docker/
2. Run Neurodesktop
Use one of the following options to run Neurodesktop:
Option 1: NeuroDesktop.exe
Download and run the following executable. Be aware: 1) The exe file can trigger your anti virus programs and we are working on this. 2) This exe will always download the latest version of neurodesk. For full reproducibility and control please choose Option 2 :) https://github.com/NeuroDesk/neurodesktop/raw/main/Windows_run_Neurodesk/NeuroDesktop.exe
Option 2: Using Terminal
- Open a terminal (e.g. Powershell), and type the folowing command to automatically download the neurodesktop container and run it
docker run --shm-size=1gb -it --privileged --name neurodesktop -v C:/neurodesktop-storage:/neurodesktop-storage -p 8080:8080 -h neurodesktop-20221216 vnmd/neurodesktop:20221216
Once neurodesktop is downloaded i.e.
guacd[77]: INFO: Listening on host 127.0.0.1, port 4822
is displayed in terminal, leave the terminal open and neurodesktop running (i.e., do not press CTRL+C)Open a browser and go to:
http://localhost:8080/#/?username=user&password=password
Note
We do not recommend the use of the Firefox browser for accessing Neurodesktop on Windows 10, as firefox is not able to access localhost where neurodesk is running.Press on “Desktop Auto-Resolution” under “ALL CONNECTIONS”
If it is the first time you use Neruodesktop, wait until the desktop appears (it may take a few seconds). Otherwise, it should appear instantaneously.
Neurodesk is ready to use! Click “What’s next?” on the left of this page for further instructions.
For an optimal experience, switch your browser to full-screen mode by following the instructions for your browser here: https://www.thewindowsclub.com/open-chrome-edge-or-firefox-browser-in-full-screen-mode
Deleting neurodesktop:
When done processing your data it is important to stop and remove the container - otherwise the next start or container update will give an error ("… The container name “/neurodesktop” is already in use…")
Note
Notice that any data that were saved outside of /neurodesktop-storage would be lost. Please make sure to move all your data to that folder before deleting neurodesktop.Click on the terminal from which you ran neurodesktop
Press control-C
Type:
docker stop neurodesktop
- Type:
docker rm neurodesktop
Using an RDP Client
Startup Neurodesktop using the following command:
docker run --shm-size=1gb -it --privileged --name neurodesktop -v C:/neurodesktop-storage:/neurodesktop-storage -p 3390:3389 -p 8080:8080 -h neurodesktop-20221216 vnmd/neurodesktop:20221216
Open Windows Remote Desktop Connection and connect to Computer localhost:3390
as shown below.
Resolution and multi-monitor settings can be set from the Display tab.
Once ready, click Connect. This will take you to the following prompt
Use the following details to login
Session: Xorg
username: user
password: password
Using VNC
To enable VNC and disable RDP, startup Neurodesktop using the following command:
docker run --shm-size=1gb -it --privileged --name neurodesktop -v C:/neurodesktop-storage:/neurodesktop-storage -p 8080:8080 -h neurodesktop-20221216 vnmd/neurodesktop:20221216 --vnc
VNC allows for multiple desktop connections to same instance
Note: Neurodesktop VNC on the browser currently does not support auto-resolution
Using a VNC Client
Startup Neurodesktop using the following command:
docker run --shm-size=1gb -it --privileged --name neurodesktop -v C:/neurodesktop-storage:/neurodesktop-storage -p 5901:5901 -p 8080:8080 -h neurodesktop-20221216 vnmd/neurodesktop:20221216 --vnc
Download the Tiger VNC client (vncviewer64-1.12.0.exe
) from https://sourceforge.net/projects/tigervnc/files/stable/1.12.0/
Run the VNC Client and connect to localhost::5901
Enter password
and click Ok.