mirror of
https://github.com/gethomepage/homepage.git
synced 2025-07-09 03:04:18 -04:00
Updated Configuration (markdown)
parent
5d5841c2d6
commit
b6e0b65cec
@ -1,34 +0,0 @@
|
||||
# Docker
|
||||
|
||||
Docker instances are configured inside the `docker.yaml` file. Both IP:PORT and Socket connections are supported.
|
||||
|
||||
For IP:PORT, simply make sure your Docker instance [has been configured](https://gist.github.com/styblope/dc55e0ad2a9848f2cc3307d4819d819f) to accept API traffic over the HTTP API.
|
||||
|
||||
```yaml
|
||||
my-remote-docker:
|
||||
host: 192.168.0.101
|
||||
port: 2375
|
||||
```
|
||||
|
||||
For Sockets, make sure that you're passing the local socket into the Docker container (if you're running inside of Docker).
|
||||
|
||||
```yaml
|
||||
my-local-docker:
|
||||
socket: /var/run/docker.sock
|
||||
```
|
||||
|
||||
and inside of your Docker Compose:
|
||||
|
||||
```yaml
|
||||
homepage:
|
||||
image: ghcr.io/benphelps/homepage:main
|
||||
container_name: homepage
|
||||
volumes:
|
||||
- /path/to/config:/app/config
|
||||
- /var/run/docker.sock:/var/run/docker.sock # This passes your local docker socket to the container
|
||||
ports:
|
||||
- 3003:3000
|
||||
restart: unless-stopped
|
||||
```
|
||||
|
||||
of if you're using `docker run`, add `-v /var/run/docker.sock:/var/run/docker.sock`
|
20
Weather.md
Normal file
20
Weather.md
Normal file
@ -0,0 +1,20 @@
|
||||
# Configuration
|
||||
|
||||
The weather widget uses the weatherapi.com API, so you will need to register and grab your API key (free tier is more than enough).
|
||||
|
||||
The widget is configured inside of the `widgets.yaml` file.
|
||||
|
||||
```yaml
|
||||
- weather:
|
||||
latitude: 49.947279
|
||||
longitude: 24.223126
|
||||
units: metric
|
||||
apiKey: yourweatherapidotcomkey
|
||||
cache: 5
|
||||
```
|
||||
|
||||
`latitude` and `longitude` are for the location you'd like the weather report to be for.
|
||||
|
||||
`units` can be either `metric` for celsius or `imperial` for fahrenheit.
|
||||
|
||||
`cache` is how long, in minutes, to cache the API response for. This allows you to stay well within the free tier API limits.
|
Loading…
x
Reference in New Issue
Block a user