Skip to content

Latest commit

 

History

History
75 lines (64 loc) · 4.5 KB

BUILDING.md

File metadata and controls

75 lines (64 loc) · 4.5 KB
Raw

WLinux Components

  • /create-targz-x64.sh - Builds the WLinux custom Linux distro in a WLinux or Debian environment.
  • Launcher project - Builds the actual executable that is run when a user launches the app.
  • DistroLauncher-Appx project - Builds the distro package with all the assets and other dependencies.

Read more about the components from the upstream template by Microsoft here.

Building Requirements

  1. Visual Studio Community 2017. (Free)
    • The "Universal Windows Platform development" Workload is required, along with the following Individual components:
      • C++ Universal Windows Platform tools
      • Windows 10 SDK (10.0.15063.0) for UWP: C#, VB, JS
  2. Developer Mode
    • Windows 10 must be in Developer mode, which can be enabled in Start -> Settings -> Update & Security -> For developers.
  3. Enable WSL
    • Enable by:
      • Pressing Windows+R, type C:\Windows\System32\OptionalFeatures.exe, click OK, find and check Windows Subsystem for Linux, click OK, and restart as required, or
      • Open PowerShell as Administrator, type Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux, and restart as required.

Build Process

  1. Open DistroLauncher.sln in Visual Studio Community 2017.

  2. Generate a test certificate:

    1. In the Solution Explorer, open DistroLauncher-Appx\MyDistro.appxmanifest
    2. Select the Packaging tab
    3. Select "Choose Certificate"
    4. Click the Configure Certificate drop down and select Create test certificate.

  3. Build install.tar.gz

    1. You will need access to an existing WLinux or Debian-based distro for this step. If you do not already have WLinux installed, I recommend the following steps:
      • Enable WSL on Windows if you have not already.
      • Install the Debian for WSL app from the Microsoft Store.
      • Run, let it finish installing, configure your username and password.
      • Then you will need to update apt, upgrade existing packages, and then install git:
        • $ sudo apt-get update ; sudo apt-get upgrade -y ; sudo apt-get install git -y
    2. With your WLinux (or configured/updated Debian) distro in place, execute the following:
      • $ git clone https://github.com/WhitewaterFoundry/WLinux.git
      • $ cd WLinux
      • $ chmod u+x create-targz-x64.sh
      • $ ./create-targz-x64.sh
    3. You should find an install.tar.gz in the /x64/ directory of your build directory. (When we get ARM64 support working there will also be an install.tar.gz in a /ARM64/ directory.)

  4. Build the solution to make sure you have everything you need. Fix any build dependencies you are missing.

  5. Build the Windows UWP package:

    1. Open a Developer Command Prompt for VS 2017 as an administrator and change directory to your build directory.
    2. Run build.bat

  6. If everything has gone correctly, you should find your app package in a subfolder under the AppPackages\DistroLauncher-Appx folder.

    1. First, install the certificate:
      1. Double-click on the security certificate file.
      2. Click the "Install Certificate" button.
      3. Select "Local Machine" for the store location.
      4. Select "Automatically select the certificate store based on the type of certificate", then click Next. (If you have any certificate issues, try specifying the Root Certificate Authority Trust here.)
      5. Proceed through the rest of the wizard, clicking Next, Finish, OK, and then OK.
    2. Once that's done, you should be able to double-click on the .appx package file and install it.

Command Line Usage

The launcher app provides the following functionality:

  • wlinux.exe

    • Launches the user's default shell in the user's home directory.

  • wlinux.exe install [--root]

    • Install the distribution and do not launch the shell when complete.
      • --root: Do not create a user account and leave the default user set to root.

  • wlinux.exe run <command line>

    • Run the provided command line in the current working directory. If no command line is provided, the default shell is launched.
    • Everything after run is passed to WslLaunchInteractive.

  • wlinux.exe config [setting [value]]

    • Configure settings for this distribution.
    • Settings:
      • --default-user <username>: Sets the default user to . This must be an existing user.

  • wlinux.exe help

    • Print usage information.