https://github.com/roydejong/wslhostsupdater

Windows service that automatically manages hosts entries for your Windows Subsystem for Linux (WSL) instance.
https://github.com/roydejong/wslhostsupdater

hosts service windows wsl wsl-ubuntu wsl2

Last synced: 6 days ago
JSON representation

Windows service that automatically manages hosts entries for your Windows Subsystem for Linux (WSL) instance.

• Host: GitHub
• URL: https://github.com/roydejong/wslhostsupdater
• Owner: roydejong
• License: mit
• Created: 2022-03-01T15:23:09.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-01-25T12:05:59.000Z (almost 2 years ago)
• Last Synced: 2024-10-24T12:12:41.073Z (2 months ago)
• Topics: hosts, service, windows, wsl, wsl-ubuntu, wsl2
• Language: C#
• Homepage:
• Size: 98.6 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# WSL Hosts Updater

**Windows service that automatically manages `hosts` entries for your Windows Subsystem for Linux (WSL) instance.**

## Features

- Lightweight Windows service

- Periodically checks your default WSL instance's status and IP

- Automatically updates `hosts` entries with the instance's IP address

- Keeps your hosts file clean and only ever adds one line per host

## Installation

✅ [**Download the latest build from GitHub**](https://github.com/roydejong/WSLHostsUpdater/releases/latest) (or build from source if you prefer)

You can either run the program manually, or install it as a Windows Service. Either way, you'll need administrator permissions so the `hosts` file can be edited.

### Service installation

Place the files in a permanent directory, then use `sc` on the command line to install the Windows service:

```

sc.exe create "WSLHostsUpdater" binpath="\WSLHostsUpdater.exe" start=delayed-auto obj= password=

```

After this, you'll be able to see and manage the service from the Windows Services view. Warnings and errors will appear in the event viewer with `WSLHostsUpdater` as source.

## Configuration

You can modify `appsettings.json` (must be in the same directory as the executable) to configure some aspects of the service:

```json

{

  "Logging": {

    "LogLevel": {

      "Default": "Information",

      "Microsoft.Hosting.Lifetime": "Information"

    }

  },

  "Service": {

    "CheckWslRunning": true,

    "UpdateInterval": 30000,

    "Hostnames": ["host1.com", "host2.com"]

  }

}

```

| Key               | Description                                                          | Default                       |

|-------------------|----------------------------------------------------------------------|-------------------------------|

| `CheckWslRunning` | If true, check if WSL is running first before attempting to refresh. | `true`                        |

| `UpdateInterval`  | The amount of time in milliseconds between refreshes.                | `30000` (30 seconds)          |

| `Hostnames`       | Array of host names to update in the `hosts` file.                   | `["wsl.local", "ubuntu.wsl"]` |

🕑 The configuration file is hot reloaded automatically, so you can add hostnames whenever you like without having to restart the service.