### Using docker
```sh
-sudo docker run -p 8080:8080 -v /your/local/config.yml:/www/config.yml -v /your/local/assets/:/www/assets b4bz/homer:latest
+docker run -p 8080:8080 -v /your/local/config.yml:/www/config.yml -v /your/local/assets/:/www/assets b4bz/homer:latest
```
### Manually
```
Then your dashboard is ready to use in the `/dist` directory.
+The `dist` directory is meant to be served by an HTTP server, so **it will not work if you open dist/index.html directly over file:// protocol**.
+
Use it like any static HTML content (use a webserver or open the html index directly).
-## Developement
+## Development
```sh
# Using yarn (recommended)
npm run serve
```
-### themes
+### Themes
-Theme are meant to be simple customization (written in [scss](https://sass-lang.com/documentation/syntax)).
+Themes are meant to be simple customization (written in [scss](https://sass-lang.com/documentation/syntax)).
To addd a new theme, just add a file in the theme directory, and put all style in the `body #app.theme-<name>` scope. Then import it in the main style file.
```scss
## Configuration
-Title, icons, links, colors, and services can be configured in the `config.yml` file, using [yaml](http://yaml.org/) format.
+Title, icons, links, colors, and services can be configured in the `config.yml` file (located in project root directory once built, or in the `public/` directory in developement mode), using [yaml](http://yaml.org/) format.
```yaml
---
- name: "ansible"
icon: "fab fa-github"
url: "https://github.com/xxxxx/ansible/"
- target: "_blank" # optional html a tag target attribute
+ target: "_blank" # optional html tag target attribute
- name: "Wiki"
icon: "fas fa-book"
url: "https://wiki.xxxxxx.com/"
subtitle: "Continuous integration server"
tag: "CI"
url: "#"
- target: "_blank" # optional html a tag target attribute
+ target: "_blank" # optional html tag target attribute
- name: "RabbitMQ Management"
logo: "/assets/tools/rabbitmq.png"
subtitle: "Manage & monitor RabbitMQ server"