Homelab for workgroups

I wanted a 'homepage' for various self-hosted services. There were a bunch of existing offerings, but I was missing some personality and whimsy from them.

Not being a designer myself, I decided to make my own but copy from a favourite windows era.

Screenshot

Note: this screenshot has a network neighbourhood, which is unreleased because I don't know yet what to do with the icons.

Getting started

Node.js

# Clone this repo
git clone git@github.com:evert/hl4wg.git

# Go into the repository
cd hl4wg

# Install dependencies
npm install

# Run
npm start

docker-compose

TODO

Changing icons, adding menu items, etc

This tool will by default load in the 'menu.json' file in the data/ directory.

This is a menu file, that roughly has this structure:

{
  "title": "Homelab for Workgroups",

  "items": [
    {
      "title": "Jellyfin",
      "icon": "/image/icons/homelab/jellyfin.png",
      "href": "https://jellyfin.example.com/"
    }

}

Take a look at the supplied icons on Github in the frontend/image/icons directory. You can add your own icons, host them anywhere including on this service.

Providing an icon is optional. If it's omitted we will try to lowercase the title and see if an icon with that name exists in frontend/image/icons/homelab/[name.png].

Can you implement x / x doesn't work

If something doesn't work or seems missing it's probably because I didn't build it! A bunch of features are non-funtional and just decorative for now.

I'd love to know what people would like to see, so please just open issues to request features or contribute using a pull request!

Requesting icons

I just added the icons for things I use, but I'm happy to add more. I have a crappy script that takes an existing icon and makes it look worse. Just open an issue with what you need!

New hand-made icons are also very welcome. My script just re-uses existing icons.

Credits

• Microsoft for the inspiration and memories
• Windows 3.1 System Font reproduction by BroDadi
• MS Sans-serif raster reproduction by CTFonts
• Windows 3.1 icon collection by mRB0