akloeckner/fbrinker-tileboard
Archived
1
0
Fork 0
forked from fbrinker/docker-tileboard-OUTDATED
Code Issues Pull Requests Projects Releases Wiki Activity
Docker Container for TileBoard: "A simple yet highly configurable Dashboard for HomeAssistant"
This repository has been archived on 2021-06-21. You can view files and clone it, but cannot push or open issues or pull requests.
44 Commits 4 Branches 0 Tags 74 KiB
Shell 60.5%
Dockerfile 39.5%
36b39b251d
Go to file
dev-docker 36b39b251d Create a merged branch to deploy
2021-06-21 13:54:37 +00:00
.drone.yml Rename master to main 2021-05-11 21:28:26 +02:00
.gitignore Recreate container build and tagging 2021-03-20 18:28:40 +01:00
build.sh remove superfluous outputs 2021-05-21 06:51:04 +00:00
check-master-for-changes.sh Fix script condition 2021-05-10 22:42:30 +02:00
Dockerfile feat(RELEASE): allow overriding build.sh 2021-05-20 20:19:36 +00:00
Dockerfile.nightly Create a merged branch to deploy 2021-05-21 06:51:22 +00:00
LICENSE.md Add license 2021-05-09 21:45:13 +00:00
README.md Move to Github & Github Drone 2021-05-10 22:42:37 +02:00

README.md

TileBoard Docker-Container

Build Status Docker Pulls

This is a very basic Docker container for TileBoard, "a simple yet highly configurable Dashboard for HomeAssistant".

It contains the sources and starts a simple Python3 webserver to serve TileBoard at port 8000.

Contribute

You can open any new issues here. The builds are automated on changes of the official TileBoard repository.

Have a look at the Dockerfile.

Usage

You have to mount your config.js file into the /tileboard directory of the Docker container. You can see an example config.js file in the official repository.

Versions / Tags

Besides the latest version, you can listen to updates for a specific version:

  • fbrinker/tileboard (same as :latest)
  • fbrinker/tileboard:latest
  • fbrinker/tileboard:2
  • fbrinker/tileboard:2.2
  • fbrinker/tileboard:2.2.0

Nightly/Dev-Builds

Additionally, there are nightly and dev builds as follows:

  • fbrinker/tileboard:nightly contains a nightly build of TileBoard's master branch. Use it to have the most bleeding edge changes, which have not made it into a release yet.
  • fbrinker/tileboard:dev bundles TileBoard's source code and runs yarn run dev inside the container. Use it to modify the source, check your changes into GitHub and propose a pull request to TileBoard. See the TileBoard contribution page for details.

Example

Here is an example, using Docker-Compose:

version: '3'
services:

  tileboard:
    image: fbrinker/tileboard
    volumes:
      - ./config.js:/tileboard/config.js
    ports:
      - "8234:8000"

After a docker-compose up -d, you can reach your TileBoard instance under http://[yourhost-or-ip]:8234.

Extended Example

I am using it in my docker-compose file like this, with my config.js, secrets and other customizations:

# Home Assistant TileBoard
tileboard:
  container_name: tileboard
  image: fbrinker/tileboard
  hostname: tileboard
  volumes:
    - ./tileboard/config/config.js:/tileboard/config.js
    - ./tileboard/config/secrets.js:/tileboard/includes/config/secrets.js
    - ./tileboard/config/pages:/tileboard/includes/pages
    - ./tileboard/styles/background.png:/tileboard/images/background.png
    - ./tileboard/styles/custom.css:/tileboard/styles/custom.css
  ports:
    - "8234:8000"
  restart: unless-stopped
  depends_on:
    - homeassistant

Note: You should never expose TileBoard to the web.