Skip to content
Another web application bookmark dashboard, with fun features.
CSS Python HTML JavaScript Other
Branch: master
Clone or download

Latest commit

Latest commit a01a7b9 Apr 6, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Create FUNDING.yml Mar 19, 2020
dashmachine updated weather.py Apr 5, 2020
migrations This should fix the alembic issue, unfortunately this will require th… Mar 19, 2020
template_apps Add Synology Download Station app template Apr 4, 2020
.dockerignore Rework Dockerfile to be production ready Feb 9, 2020
.gitattributes first commit Jan 6, 2020
.gitignore fixed gitnore /images/icons Jan 31, 2020
Dockerfile edit Dockerfile to fix https://git.wolf-house.net/ross/DashMachine/is… Feb 11, 2020
License.md
README.md - added 'weather' data source and custom card Apr 5, 2020
default_config.ini
pull_request_template.md - fixed lack of feedback on login screen Mar 8, 2020
readme_cards.md
readme_data_sources.md - reduced the size of app cards, moving description to a pop-open Mar 27, 2020
readme_settings.md - reduced the size of app cards, moving description to a pop-open Mar 27, 2020
requirements.txt v0.5 Mar 20, 2020
run.py fixed error with python version using the wrong path for the user dat… Mar 28, 2020
screenshot1.png 0.5 ready for master Mar 28, 2020
screenshot2.png 0.5 ready for master Mar 28, 2020
screenshot3.png 0.5 ready for master Mar 28, 2020
screenshot4.png 0.5 ready for master Mar 28, 2020
update_message.md
wsgi.py fixed wsgi.py to match run.py Mar 20, 2020

README.md

DashMachine

Another web application bookmark dashboard, with fun features.

Before Installing

Please read the latest update post: https://www.reddit.com/r/DashMachine/comments/fqk8gl/version_05/

screenshot

screenshot

screenshot

screenshot

Features

  • creates a dashboard to view web pages
  • uses a single .ini file for configuration
  • dark mode/light mode and accent colors
  • custom backgrounds and icons
  • web interface to edit the config file and add image files
  • ability to open web pages in current tab, new tab or iframe
  • hideable sidebar with dragable reveal button
  • user login system
  • 'app templates' which are sample config entries for popular self hosted apps
  • powerful plugin system for adding data from various sources to display on cards
  • multiple card types including collections and custom cards
  • multiple users, access groups, access settings
  • tagging system

Installation

Docker

docker create \
  --name=dashmachine \
  -p 5000:5000 \
  -v path/to/data:/dashmachine/dashmachine/user_data \
  --restart unless-stopped \
  rmountjoy/dashmachine:latest

To run in a subfolder, use a CONTEXT_PATH environment variable. For example, to run at localhost:5000/dash:

docker create \
  --name=dashmachine \
  -p 5000:5000 \
  -e CONTEXT_PATH=/dash
  -v path/to/data:/dashmachine/dashmachine/user_data \
  --restart unless-stopped \
  rmountjoy/dashmachine:latest

Synology

Check out this awesome guide: https://nashosted.com/manage-your-self-hosted-applications-using-dashmachine/

Python

Instructions are for linux.

virtualenv --python=python3 DashMachineEnv
cd DashMachineEnv && source bin/activate
git clone https://github.com/rmountjoy92/DashMachine.git
cd DashMachine && pip install -r requirements.txt
python3 run.py

Then open a web browser and go to localhost:5000

Default user/password

User: admin
Password: admin

Updating

For python, use git. For docker, just pull the latest image and recreate the container.

Configuration

The user data folder is located at DashMachine/dashmachine/user_data. This is where the config.ini, custom backgrounds/icons, and the database file live. A reference for what can go into the config.ini file can be found on the settings page of the dashmachine by clicking the info icon next to 'Config'.

Note

If you change the config.ini file, you either have to restart the container (or python script) or click the 'save' button in the config section of settings for the config to be applied. Pictures added to the backgrounds/icons folders are available immediately.

Want to contribute?

Please use the pull request template at: https://github.com/rmountjoy92/DashMachine/blob/master/pull_request_template.md

See this link for how to create a pull request: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request

Subreddit

https://www.reddit.com/r/DashMachine

Want to buy me a coffee?

recurring: Donate using Liberapay

recurring or one-time: https://www.bountysource.com/teams/dashmachine-app

Want a feature to be added faster?

Open a bounty on https://www.bountysource.com/

Bountysource faq: https://github.com/bountysource/core/wiki/Frequently-Asked-Questions

Tech used

  • Flask
  • SQLalchemy w/ SQLite
  • Jinja2
  • Materialize css
  • JavaScript/jQuery/jQueryUI

FAQs

  1. application does not work in iframe see https://github.com/rmountjoy92/DashMachine/issues/6
You can’t perform that action at this time.