Skip to content

Commit 8219c1c

Browse files
committed
Update readme for static apps
1 parent b3651b7 commit 8219c1c

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Features include:
1313
- Basic UI for dashboard based on plain HTML, CSS and a sprinkling of VueJS
1414
- Automated, regular removal/refresh of entries older that X minutes
1515
- Configuration through environment variables or config.yml file
16+
- Possibility to add statically defined applications through config file
1617
- Swagger docs for REST API (see http://localhost:8080/static/docs)
1718
- Distroless container image
1819
- Multi-architecture container image
@@ -27,7 +28,8 @@ Keep in mind that this is intended for local usage, so there are no provisions f
2728
- the REST API, see http://localhost:8080/static/docs/ for details.
2829
3) Go to http://localhost:8080/ to view the dashboard. (or whatever URL you host it on)
2930

30-
An example docker-compose.yml file is included in the root of this git repository. The example assumes you use Traefik and something like https://github.com/tecnativa/docker-socket-proxy so adjust where needed for your situation.
31+
An example docker-compose.yml file is included in the root of this git repository. The example assumes you use Traefik
32+
and something like https://github.com/tecnativa/docker-socket-proxy so adjust where needed for your situation.
3133

3234
## Configuration
3335

@@ -47,6 +49,8 @@ The defaults of HomeDash are sane, though open. (see the table)
4749
- Place the `config.yml` file next to the binary
4850
- Edit where needed.
4951

52+
If desired, add one or more statically define applications through the `config.yml` file. See the example file for details.
53+
5054
**Note:** though you *can* set CORS settings it is probably not advisable to do so unless you know what you're doing.
5155

5256
### Environment variables

0 commit comments

Comments
 (0)