mwalters / homed

Light-weight, easily configurable, dockerized homepage

homed

• GitHub Repo
• Docker Hub

homed is a light-weight customizable portal primarily intended for the "self-hosted" crowd with built-in support for local authentication services (e.g. Authelia). The user configures options and which links to display using a yaml file, and also has ability to include custom CSS and JavaScript. All resources are hosted locally. Access to links is controlled via groups passed in by the authentication service using the Remote-Groups request header (which Authelia supports).

Light Mode:

Dark Mode:

Weather:

• Displays current local radar and refreshes every 5 minutes
• 12-hour forecast
• 5-day forecast

Features

• Auth integration (e.g. Authelia)
• Ability to provide custom CSS and JavaScript
• Simple yaml configuration file
• FontAwesome icon support
• Light/Dark mode
• Status check for services

Documentation

Please visit the wiki

Versioning

Semver will be followed. For version x.y.z

• x Major version release, breaking changes
• y Minor version release, no breaking changes, added features
• z Bug release, no breaking changes, no new features

homed's Issues

Support Light/Dark Mode

Add toggle for light/dark mode

Split up code user has access to and what they don't

In creation of Dark Mode (#2) I am realizing that the upgrade path will be pretty difficult because of how the image puts the used code into place. Users will need to delete their current code in order for the new code to be used.

This has to do with the image copying the initial code into the user mounted volume and likely puts too much onus on the average user to have to delete it in order to pick up updates.

Multiple things should likely be done:

1. Stop copying all of the app files and assets over to the user volume.
2. Offer a custom.css and custom.js for the user to make adjustments they'd like in. It should contain only their changes, never core-app items and be stored on the user volume (/config in the container).
3. Look at Making the HTML utilize modules of some sort is likely going to be needed.

Need to think some more on this one and how best to tackle it. Open to ideas ... it's a pickle if giving the user direct access to the HTML is going to be kept as a feature.

Exception when no auth configured

There is an exception when you try to access the page without configuring auth/user

Traceback (most recent call last):
  File "/usr/local/lib/python3.8/site-packages/flask/app.py", line 2073, in wsgi_app
    response = self.full_dispatch_request()
  File "/usr/local/lib/python3.8/site-packages/flask/app.py", line 1518, in full_dispatch_request
    rv = self.handle_user_exception(e)
  File "/usr/local/lib/python3.8/site-packages/flask/app.py", line 1516, in full_dispatch_request
    rv = self.dispatch_request()
  File "/usr/local/lib/python3.8/site-packages/flask/app.py", line 1502, in dispatch_request
    return self.ensure_sync(self.view_functions[rule.endpoint])(**req.view_args)
  File "/app/homed.py", line 25, in display_home
    app.logger.info("user={user}, path=/".format(user=user["username"]))
KeyError: 'username'

Very cool project otherwise, keep up the good work!

Fix code scanning alert - Reflected server-side cross-site scripting

Tracking issue for:

• https://github.com/mwalters/homed/security/code-scanning/1