====== Installing RePoSyD on Windows ======

  - Install Node.js and YARN.
  - Install the RePoSyD Command Line Interface (CLI) from the RePoSyD registry.
  - Use the RePoSyD CLI to install the RePoSyD services on your computer.
  -Run RePoSyD as a Service or from the Command Line.

===== Node.js ======

==== Step 1: Download Node.js installer ====

Open your favorite web browser, navigate to [[https://nodejs.org/download/release/v16.20.1]] and download the Installer for the 64-bit version of Node.js ([[https://nodejs.org/download/release/v16.20.1/node-v16.20.1-x64.msi]]). Alternative you can use the ZIP-version ([[https://nodejs.org/download/release/v16.20.1/node-v16.20.1-win-x64.zip|node-v16.20.1-win-x64.zip]]) for the installation.

==== Step 2: Installing Node.js ====

Once the download is completed, open the installer to start the installation.
<imgcaption nodejs01|Node.js Installer>{{ :manual:installation:node_installer_01.png?400 |}}</imgcaption>

Click on <button type="default" size="xs">Next</button> until you reach the step "Tools for Native Modules". Click on the checkbox to enable the installation of additional build tools.
<imgcaption nodej02s|>{{ :manual:installation:node_installer_02.png?400 |Step "Tools for Native Modules}}</imgcaption>

<WRAP center round important 60%>**Automatically install necessary tools**

The installation of RePoSyD will fail, if this option is not activated!
</WRAP>

==== Step 3: Verify the installation ====

After completion of the installer, open a command prompt (or PowerShell) and enter the following:

<cli prompt="C:\> ">
C:\> node -v
</cli>
The system should display the Node.js version installed on your system.

<cli prompt="C:\> ">
C:\> node -v
v16.20.1
</cli>

===== YARN (Package Manager) =====

==== Step 1: Installing YARN as a global Node.js package  ====

Open a command prompt (or PowerShell), and enter the following:

<cli prompt="C:\> ">
C:\> npm install -g yarn
</cli>

<fs large>Installing YARN behind a Proxy Server</fs>

If RePoSyD is installed in a corporate environment, you may need to configure NPM to provide authentication for the proxy server. Open a command shell and enter the following commands to configure NPM to use an HTTP and/or HTTPS proxy. 

<cli prompt="$ ">
$ npm config set proxy http://username:password@host:port
$ npm config set https-proxy http://username:password@host:port
</cli>

Or add the settings directly to your <fc #cd5c5c>~/.npmrc</fc> file:
<code>
proxy=http://username:password@host:port
https-proxy=http://username:password@host:port
</code>

==== Step 2: Verify the install  ====

After completion of the installer, enter the following:

<cli prompt="C:\> ">
C:\> yarn -v
</cli>
The system should display the YARN version installed on your system.

<cli prompt="C:\> ">
C:\> yarn -v
v1.22.19
</cli>

===== RePoSyD CLI (Command Line Interface) =====

==== Step 1: Installing as a global Node.js package ====

Open a command prompt (or PowerShell), and enter the following:
<cli prompt="C:\> ">
C:\> yarn config set registry https://pkg.reposyd.de/registry 
yarn config v1.22.19
success Set "registry" to "https://pkg.reposyd.de/registry".
Done in 0.04s.

C:\> yarn global add @reposyd/cli
yarn global v1.22.19
[1/4] Resolving packages...
...
[4/4] Building fresh packages...
success Installed "@reposyd/cli@1.5.1" with binaries:
      - reposyd
Done in 42.99s.

</cli>

The installation of @reposyd\cli as a global package may fail, if you are using nvm to manage your Node.js versions. In this case use npm for the installation.

<cli prompt="$ ">
$ npm config set registry https://pkg.reposyd.de/registry 

$ npm i -g @reposyd/cli
</cli>

<fs large>Installing @reposyd/cli behind a Proxy Server</fs>

If RePoSyD is installed in a corporate environment, you may need to configure YARN to provide authentication for the proxy server. Open a command shell and enter the following commands to configure NPM to use an HTTP and/or HTTPS proxy. 

<cli prompt="$ ">
$ yarn config set proxy http://username:password@host:port
$ yarn config set https-proxy http://username:password@host:port
</cli>

Or add the settings directly to your <fc #cd5c5c>~/.yarnrc</fc> file:
<code>
proxy=http://username:password@host:port
https-proxy=http://username:password@host:port
</code>
==== Step 2: Verify Installation ====

<cli prompt="C:\> ">
C:\> reposyd -V
2.0.0

C:\>
</cli>


===== RePoSyD Services =====

==== Installation ====

Open a command prompt and run the following command:

<cli prompt="C:\> ">
C:\> reposyd install c:\temp\reposyd
info: root folder 'c:/temp/reposyd' created.
info: intalling RePoSyD packages...
info: RePoSyD packages installation completed
info: creating RePoSyD configuration file...
info: initializing repository...
info: initialization completed
url      sqlite:c:/temp/reposyd/database?database=reposyd.sqlite
schema   0.34.0
account  admin
password gukidaka
uuid     {e6700c3e-f17f-455f-a6a0-92d45dadd3ab}
</cli>

<WRAP center round important 60%>**Automatically Generated Password**

Do not forget to write down the automatically generated password.
</WRAP>

If you don't want to use an autogenerated password, you specify your own password using the CLI option --password.

<cli prompt="C:\> ">
C:\> reposyd install c:\temp\reposyd --password <mypassword>
</cli>

For more information, see [[manual:cli:start|RePoSyD CLI]].
==== Folder Structure ====

The following folder structure is created for running the RePoSyD Services: 

^Folder ^^^ Content ^
|**<root>**  |||Root folder of the installation.|
|  |app ||Contains the files of the RePoSyD Web Application |
| |config ||Configuration files, e.g. RePoSyD API config. |
| |data || |
| | |backup | |Location of backup files. |
| | |database |Location of the database files. |
| | |log |Log files |
| | |templates |Templates for email generation.|
| |service ||Contains the files for running the RePoSyD REST API and Win/Mac service|
 
===== RePoSyD Web Application =====

==== Manual Installation ====

The RePoSyD web application is normally installed during the installation of the RePoSyD REST API. To install the application manually, open a command prompt and run the following command:

<cli prompt="C:\> ">
C:\> reposyd app install c:\inetpub\wwwroot
info: RePoSyD App installation completed

C:\>
</cli>

==== Microsoft IIS (Web Server) Configuration ====

RePoSyD requires the installation of the following IIS server functions:

  * [[https://www.iis.net/downloads/microsoft/application-request-routing|Application Request Routing]]

The following URL rewrite rules need to be set up for RePoSyD:

^ URL ^ Pattern ^ Target ^ ^
| %%http(s)://<servername>/api%% | %%^%%api/(.*) | %%http://127.0.0.1:3000/{R:1}%% | The request is redirected to RePoSyD and /api is removed from the URL. A query string remains unchanged (option //append query string// enabled) |
| %%http(s)://servername>/auth%% | %%^%%auth/(.*) | %%http://127.0.0.1:3000/auth/{R:1}%% | The request is redirect to RePoSyD and remains unchanged (option //append query string// enabled). |

==== nginx Configuration ====

<code>
location /api/ {
	proxy_pass http://127.0.0.1:32769;
	rewrite ^/api/?(.*) /$1 break;
}
location /auth {
	proxy_pass http://127.0.0.1:32769;
	proxy_set_header Host            $host:$server_port;
	proxy_set_header X-Forwarded-For $remote_addr;
	proxy_set_header X-Forwarded-Proto $scheme;
}
</code>