You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/sphinx-guides/source/developers/dev-environment.rst
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ After cloning the `dataverse repo <https://github.com/IQSS/dataverse>`_, run thi
18
18
19
19
``mvn -Pct clean package docker:run``
20
20
21
-
(Note that if you are Windows, you must run the command above in `WSL <https://learn.microsoft.com/windows/wsl>`_ rather than cmd.exe.)
21
+
(Note that if you are Windows, you must run the command above in `WSL <https://learn.microsoft.com/windows/wsl>`_ rather than cmd.exe. See :doc:`windows`.)
Copy file name to clipboardExpand all lines: doc/sphinx-guides/source/developers/windows.rst
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,20 +2,21 @@
2
2
Windows Development
3
3
===================
4
4
5
-
5
+
.. contents:: |toctitle|
6
+
:local:
6
7
7
8
Running Dataverse in Windows WSL
8
9
--------------------------------
9
10
10
11
The simplest method to run Dataverse in Windows 10 and 11 is using Docker and Windows Subsystem for Linux (WSL) - specifically WSL 2.
11
-
Once Docker and WSL are installed, you can follow the :ref:`Quickstart instructions <container-dev-quickstart>`.
12
+
Once Docker and WSL are installed, you can follow the :ref:`quickstart instructions <container-dev-quickstart>`.
12
13
13
14
Please note: these instructions have not been extensively tested. They have been found to work with the Ubuntu-24.04 distribution for WSL. If you find any problems, please open an issue at https://github.com/IQSS/dataverse/issues and/or submit a PR to update this guide.
14
15
15
16
Install Docker Desktop
16
17
~~~~~~~~~~~~~~~~~~~~~~
17
18
18
-
Follwow the directions at https://www.docker.com/ to install Docker Desktop on Windows. If prompted, turn on WSL 2 during installation.
19
+
Follow the directions at https://www.docker.com to install Docker Desktop on Windows. If prompted, turn on WSL 2 during installation.
19
20
20
21
Settings you may need in Docker Desktop:
21
22
@@ -29,7 +30,7 @@ Install WSL
29
30
~~~~~~~~~~~
30
31
If you install Docker Desktop, you should already have WSL installed. If not, or if you wish to add an additional Linux distribution, open PowerShell.
31
32
32
-
If wsl itself is not installed run:
33
+
If WSL itself is not installed run:
33
34
34
35
.. code-block:: powershell
35
36
@@ -61,20 +62,19 @@ You will be asked to create an initial Linux user.
61
62
Install Dataverse
62
63
~~~~~~~~~~~~~~~~~
63
64
64
-
Open a Linux terminal (e.g. use Windows Terminal and open a tab for the Linux distribution you selected). Then install Dataverse in WSL following the ``Quickstart`` instructions in :doc:`dev-environment`. You should then have a working Dataverse instance.
65
+
Open a Linux terminal (e.g. use Windows Terminal and open a tab for the Linux distribution you selected). Then install Dataverse in WSL following the :ref:`quickstart instructions <container-dev-quickstart>`. You should then have a working Dataverse instance.
65
66
66
67
IDEs for Dataverse in Windows
67
68
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
68
69
69
70
You can use your favorite editor or IDE to edit Dataverse project files. Files in WSL are accessible from Windows for editing using the path ``\\wsl.localhost``. Your Linux distribution files should also be visible in File Explorer under the This PC/Linux entry.
70
71
FYI: For the best performance, it is recommended, with WSL 2, to store Dataverse files in the WSL/Linux file system and to access them from there with your Windows-based IDE (versus storing Dataverse files in your Windows file system and trying to run maven and build from Linux - access to /mnt/c files using WSL 2 is slow).
71
72
72
-
73
73
pgAdmin in Windows for Dataverse
74
74
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
75
75
76
76
You can access the Dataverse database from Windows.
77
77
78
78
Install pgAdmin from https://www.pgadmin.org/download/pgadmin-4-windows/
79
79
80
-
In pgAdmin, register a server using ``127.0.0.1`` with port ``5432``, database ``dvndb``, and, by default, username ``dataverse`` password ``secret``. Now you will be able to access, monitor, and update the Dataverse database.
80
+
In pgAdmin, register a server using ``127.0.0.1`` with port ``5432``. For the database name, username, and password, see :ref:`db-name-creds`. Now you will be able to access, monitor, and update the Dataverse database.
0 commit comments