systemz/hometab

App for organizing nerd's home

HomeTab

Self hosted life/home assistant.
Designed to run on NAS Linux box with x64 CPU within secure network.

Detailed docs are WIP
If you have any questions, just create an issue, I'll be glad to help :)

Requirements

• x86-64 CPU (AMD/Intel)
• Linux (Windows support in the future)
• MariaDB / MySQL
• Redis

How to run

Docker

Basic example:

docker run -p "3000:3000" quay.io/systemz/hometab

You should configure DB credentials via ENV settings. All ENV variables can be found in internal/config/config.go

If configured properly you should be able to reach web interface

Dev setup

# backend
docker-compose up -d
./Taskfile.sh install-tools
./Taskfile.sh dev-backend
./Taskfile.sh dev-seed

# frontend
./Taskfile.sh dev-frontend

# android app
# open android dir with Android Studio

Notes

This is important. Project is in early stage. Due to security reasons, please don't expose HomeTab to public internet. Firewall or IPv4 NAT should be your good friend for now.

Repo structure

Directory structure mostly assembles this:

• https://github.com/golang-standards/project-layout

This repo is a merge of three, previously separate projects that were closed source:

• tasktab
• tasktab-android
• gotag

Due to high context switching mental cost during development, I merged them into one.
During merge I had an idea to share code with community and here we are :)

Stack

Golang backend + Vue.js/Vuetify (material design) frontend.
As an additional client, we have Android app too.

Android app

App doesn't use any Google dependent services. Should run on any custom ROM, with our without root.
Notifications are based on pretty good and free service https://pushy.me/.

Previously I wrote push notifications based on MQTT myself, it was working quite good. Should be findable by "RabbitMQ" in removed code. With this setup, whole app worked fully offline in LAN.

Android app is not available on Play store and probably never will.
Author want to spend more time on useful features for users than boxing with mostly nonsense store ToS changes and constantly changing app in strange ways.
Just ignore all google nagging popups about "security" (in reality it is about their market domination), download .apk and install it. Done.
I will try to put it on https://f-droid.org/ to make updates easier.

TODO

• few screens and webms from web gui and android app in readme
• integrate web templates within binary like migrations already are
• finish cmd/agent that will send events from user PCs to backend
• docker-compose for easier production setup
• doc pushy.me token requirement

License

MIT

hometab's Issues

Tasker integration

Triggering actions from Tasker to HomeTab or from HomeTab to Tasker can be useful later with reminders or smart home integration.

URLs to check:

• https://tasker.joaoapps.com/plugins.html
• https://www.twofortyfouram.com/developer/
• https://github.com/twofortyfouram/android-toast-setting-plugin-for-locale/blob/master/toastPluginSettingApp/src/main/java/com/twofortyfouram/locale/example/setting/toast/receiver/FireReceiver.java
• https://github.com/pilight/tasker-plugin/blob/master/source/AndroidManifest.xml

Image cropping

For sharing, it can be useful to crop image:

• https://vuejsexamples.com/a-beautiful-vue-component-for-image-cropping-and-uploading/

Make settings/new account button work

QR code scanning to login

Mobile app should be able to scan QR code with token to prevent user from copy-pasting or worse - typing manually.
Token should be pretty long to be secure but it's in reverse to being comfortable to user to type it.

Bulk DB ops when scanning images

Currently we add DB records one by one, which is sloooow.
We can stack up to 100 - 1000 records and then insert them all.

https://github.com/t-tiger/gorm-bulk-insert

Support http partial content for videos

Currently video files loaded directly after going to their full size url doesn't support rewind etc.
Workaround is F5 after loading to use browser cache set earlier with etag and cache expire headers.

Links:
https://stackoverflow.com/questions/36540610/how-to-serve-http-partial-content-with-go
https://www.sanarias.com/blog/115LearningHTTPcachinginGo

Unify color palette

First, check what colorful elements there are:
buttons, toolbars, checkboxes, dialog options...
Quite a few and all need one vision.

Then, choose the right colors from:
https://vuetifyjs.com/en/styles/colors/#material-colors

Lastly, maybe implement all colors as it was done here
https://github.com/SystemZ/HomeTab/blob/master/frontend/src/main.ts
for the buttons. Next color changes will be much easier :)

More options for counters

As with tags, counters need edit and delete options :)

Pantry

Pantry module would help stop wasting food and can be used to quickly generate menu from what is left in fridge, counters etc.

As a example, it should work like micro warehouse software, eg.

• https://play.google.com/store/apps/details?id=nl.industrialit.warehousemanagement

Barcode scanner could be used to quickly enter items into system after shopping.

Live "multiplayer" markdown editing

Let's call it nano google docs but for markdown.

Backend LAN discovery by mobile app

We can simplify connecting mobile app to backend by detecting backend instances on LAN.
After detection we can show list of available backends to use one click join.

Useful URLs:

• https://github.com/schollz/peerdiscovery
• https://github.com/grandcat/zeroconf
• https://github.com/ursiform/sleuth
• https://developer.android.com/training/connect-devices-wirelessly/nsd

Import images from 9gag

We can use this endpoint:

• https://9gag.com/v1/group-posts/group/default/type/trending

Show random files

We should be able to show some random files from collection

• https://stackoverflow.com/questions/1823306/mysql-alternatives-to-order-by-rand

News feed generator

For future RSS reader, we can generate feed with aggregated news source: https://newsapi.org/.
As a start, we can just create endpoint which will provide RSS/Atom feed of those news from API.
Next we can implement some filtering options via title or content.

Make settings/new project button work

Make public URLs for android app

Artifact builds aren't available to anonymous users on GitHub.
Probably we should just run rclone via CI on master branch to upload to some bucket with short commit in filename.

Write more backend tests

We need more Go tests.
This lib can be useful:

• https://github.com/stretchr/testify

Show random files without tags

Tagging files is much more fun when it's a form of roulette

Blog post helper

From my own experience, markdown plaintext files are the best solution for blog posts. It's resistant to standards changing and lacks vendor lock-in.
https://gohugo.io/ works nicely for generating blogs.

Unfortunately, creating posts when you have the idea is a chore.
Typing out creation date, uploading some images to buckets, resizing to thumbs, this takes some effort.
We can create some sort of temp storage when you can easily draft a post and then when convenient just export it or copy paste to "real" editor.

ProseMirror should be ideal for this, we have markdown support and image upload support almost out of the box:

• https://prosemirror.net/examples/markdown/
• https://prosemirror.net/examples/upload/

Alternatively: https://codemirror.net/6/

We can probably just fix out current note system and add uploading to object storage on backend.
Selecting what bucket we want to use and URL alias for them would be nice, then we can have nice links to images in posts.

Device endpoint doesn't show new devices

Device endpoint needs additional events in DB to correctly show device on Settings page. It should not. README command (dev-seed) doesn't provide enough data & there is no way to add data without manually inserting it into DB.

INSERT INTO `devices` (`id`, `user_id`, `name`, `token`, `token_push`, `created_at`, `updated_at`, `deleted_at`) VALUES
(1, 1, 'PhoneX', 'ea2f5fc2-8fc9-11eb-b2f9-2fb84f6e38f4', 'v609234pclq0mamocusx3a', '2021-03-28 13:30:17', '2021-03-28 13:30:17', NULL),
(2, 1, 'Zphone', '0bae9ada-8fcc-11eb-96a4-bf39709cff3e', 'wcqd3uqj8jmf7q1xwevfzx', '2021-03-28 13:30:17', '2021-03-28 13:30:17', NULL);


INSERT INTO `events` (`id`, `user_id`, `device_id`, `code`, `val_str`, `val_int`, `created_at`) VALUES
(1, 1, 1, 1, NULL, 69, '2021-03-28 13:39:41'),
(6, 1, 1, 2, NULL, NULL, '2021-03-28 13:39:41'),
(9, 1, 1, 1, NULL, 42, '2021-03-28 13:39:41'),
(10, 1, 1, 3, 'Never Gonna Give You Up', NULL, '2021-03-28 13:39:41'),
(11, 1, 1, 4, 'Rick Astley', NULL, '2021-03-28 13:39:41'),
(12, 1, 1, 5, NULL, NULL, '2021-03-28 13:39:41');

Those two inserts solve the problem.

Integrate git commit hash in app version

After migration from gitlab, we just need to set CI_COMMIT_SHORT_SHA in CI env somehow.
Github actions seems to have less envs than gitlab CI and have only long SHA in GITHUB_SHA

• https://docs.github.com/en/actions/reference/environment-variables
• https://docs.gitlab.com/ee/ci/variables/

We can also just set long SHA and just trim it in app :)

Don't show image tags on other pages

Currently right sidebar is shown on all pages.
We need it only on "Images" page.

Make settings/new device button work

Auto importing new images

We can add new memes or other images from sources that we can like or it's popular right now to some sort of queue to like/dislike

Related:
#37
#39

QR code generation for device tokens

We can simplify logging to mobile app by showing device token in form of QR code.
This should integrate nicely with peer discovery #1

Desktop app

We can choose most used functions related to tasks/counters and put them in small desktop app to trigger tasks from taskbar.
Native app with image viewer can be nice too.

Consider those libs:

• https://github.com/zserge/webview
• https://github.com/gotk3/gotk3

More options for tags

There is no option to edit or fully remove tags.

Show real Projects on Settings page

Currently there's mockup of projects data, so it should be swapped for getting it from backend.

Notes for the future:

• getProjects frontend method
• populate DB with Projects (see seed dir with devices)

Import images from 4channel

Related: #40

Last 10 counters list

Usually we use just use repeatedly just few of them, yet we must search for it constantly.
It would be nice to have quick links above datatable, just like google drive have tiles about main list of files, we just need names and tags in small tiles.

Backend should be already done or needs just misc adjustment.
We already have endpoint for last counters for android app:

HomeTab/internal/server/main.go

Line 99 in 414d5e1

r.HandleFunc("/api/v1/counter/{id}", ApiCounter)

HomeTab/internal/server/api_counter.go

Line 13 in 414d5e1

func ApiCounter(w http.ResponseWriter, r *http.Request) {

Compute 4channel compatible hash

We can easily identify identical files on imageboard to that we have already in library by calculating md5 and applying base64

• http://cloudway.io/post/base64-encoded-128-bit/

cat x.jpg |  openssl dgst -md5 -binary | openssl enc -base64

Image placeholders

Before large image loads from disk we can show some low res, low size preview loaded from DB
https://github.com/woltapp/blurhash

Better UI for settings page

Add new device/project buttons blend with toolbar, making them too hard to see.