taler-windows

Windows packaging
Log | Files | Refs

readme.txt (2951B)

      1 # GNU Taler Merchant Windows Installer
      2 
      3 This document clearly explains the purpose and function of each file included in the installation folder for the GNU Taler Merchant backend for Windows using WSL (Windows Subsystem for Linux).
      4 
      5 ---
      6 
      7 ## File Structure:
      8 
      9 ### Main Scripts
     10 
     11 * **`taler-installer-taler.nsi`**
     12 
     13   * NSIS (Nullsoft Scriptable Install System) script.
     14   * Manages the graphical installation interface for users (folder selection, domain configuration, reverse proxy, and external database).
     15 
     16 * **`setup-wsl-debian.bat`**
     17 
     18   * Main batch script launched by the NSIS script.
     19   * Automates the installation and initial configuration of WSL (Debian or Ubuntu), copies, and executes Bash scripts in WSL.
     20   * Initiates various installation steps, including enabling WSL features, installing the Linux distribution, and configuring the proxy.
     21 
     22 ### Bash Scripts for WSL
     23 
     24 * **`install-taler-from-apt.sh`**
     25 
     26   * Bash script executed within WSL.
     27   * Installs GNU Taler Merchant and its dependencies via the APT package manager.
     28   * Generates necessary configurations and starts related services.
     29 
     30 * **`test-db.sh`**
     31 
     32   * Bash script executed within WSL.
     33   * Checks if a user-provided external PostgreSQL URL is accessible and valid.
     34 
     35 * **`set-db.sh`**
     36 
     37   * Bash script executed within WSL.
     38   * Updates the Taler Merchant backend configuration with the validated external PostgreSQL URL.
     39 
     40 ### Additional Files
     41 
     42 * **`run-admin.bat`**
     43 
     44   * Batch script for executing specific administrative commands in WSL, if needed.
     45 
     46 * **`test-if.bat`**
     47 
     48   * Simple batch script used for testing specific conditions (used for debugging and script tests).
     49 
     50 ### Graphical Resources and Icons
     51 
     52 * **`logo-header.ico`**
     53 
     54   * Main icon displayed in the NSIS installer.
     55 
     56 * **`logo-header.bmp`**
     57 
     58   * Image used in the header of installation windows.
     59 
     60 * **`logo-welcome.bmp`**
     61 
     62   * Image displayed on the welcome page of the NSIS installer.
     63 
     64 ### Other Files
     65 
     66 * **`.gitignore`**
     67 
     68   * Git configuration file to ignore unnecessary files in the repository.
     69 
     70 * **`taler-installer.exe`**
     71 
     72   * Executable generated by NSIS, allowing simplified installation of GNU Taler Merchant on Windows.
     73 
     74 ---
     75 
     76 ## General Instructions:
     77 
     78 * Start the installation using `taler-installer.exe`.
     79 * Follow the steps provided in the NSIS interface.
     80 * The installer writes `C:\Users\Public\install.log`: the Windows-side timeline of
     81   the run -- the answers given in the wizard, the exit code of every step, the
     82   result of the final reverse-proxy probe, and the verdict. It never contains the
     83   database password.
     84 * The scripts it drives keep their own, more detailed logs:
     85   `C:\Users\Public\taler-bat.log` (`setup-wsl-debian.bat`),
     86   `C:\Users\Public\taler-sh.log` (`install-taler-from-apt.sh`),
     87   `C:\Users\Public\install-bat.log` (copied out of WSL at step 7), and
     88   `/home/taleruser/taler-installer/install-sh.log` plus `test-db.log` inside WSL.
     89   `install.log` ends with a list of these paths.
     90