forked from fbrinker/docker-tileboard-OUTDATED
71 lines
2.3 KiB
Markdown
71 lines
2.3 KiB
Markdown
# TileBoard Docker-Container
|
|
|
|
[](https://drone.f-brinker.de/fbrinker/docker-tileboard)
|
|
[](https://hub.docker.com/r/fbrinker/tileboard)
|
|
|
|
This is a very basic Docker container for [TileBoard](https://github.com/resoai/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](https://git.f-brinker.de/fbrinker/docker-tileboard/issues).
|
|
**The builds are automated** on changes of the official TileBoard repository.
|
|
|
|
Have a look at the [Dockerfile](https://git.f-brinker.de/fbrinker/docker-tileboard).
|
|
|
|
## 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](https://github.com/resoai/TileBoard/blob/master/config.example.js).
|
|
|
|
## 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
|
|
|
|
## Example
|
|
|
|
Here is an example, using Docker-Compose:
|
|
|
|
```yaml
|
|
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:
|
|
|
|
```yaml
|
|
# 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. |