mirror of
https://github.com/gethomepage/homepage.git
synced 2025-12-07 09:35:54 -08:00
Merge branch 'dev' into feature-highlight
This commit is contained in:
@@ -178,3 +178,32 @@ See [ClusterRole and ClusterRoleBinding](../installation/k8s.md#clusterrole-and-
|
||||
## Caveats
|
||||
|
||||
Similarly to Docker service discovery, there currently is no rigid ordering to discovered services and discovered services will be displayed above those specified in the `services.yaml`.
|
||||
|
||||
## Adding extra configuration files
|
||||
|
||||
Some Homepage features (for example, [Proxmox](../configs/proxmox.md)) require additional configuration files such as `proxmox.yaml`.
|
||||
When running Homepage on Kubernetes, these files must be provided via a `ConfigMap` and mounted into the container at `/app/config`.
|
||||
|
||||
### ConfigMap example
|
||||
|
||||
```yaml
|
||||
apiVersion: v1
|
||||
kind: ConfigMap
|
||||
metadata:
|
||||
name: homepage
|
||||
data:
|
||||
proxmox.yaml: |
|
||||
pve:
|
||||
url: https://proxmox.host.or.ip:8006
|
||||
token: username@pam!Token ID
|
||||
secret: secret
|
||||
```
|
||||
|
||||
Mount the file into `/app/config` by updating the `Deployment`:
|
||||
|
||||
```yaml
|
||||
volumeMounts:
|
||||
- mountPath: /app/config/proxmox.yaml
|
||||
name: homepage-config
|
||||
subPath: proxmox.yaml
|
||||
```
|
||||
|
||||
@@ -4,10 +4,10 @@ description: Proxmox Configuration
|
||||
---
|
||||
|
||||
The Proxmox connection is configured in the `proxmox.yaml` file. See [Create token](#create-token) section below for details on how to generate the required API token.
|
||||
You can configure multiple nodes - be sure to use the exact `proxmoxNode` identifier!
|
||||
To configure multiple nodes, ensure the key name in the `proxmox.yaml` matches the `proxmoxNode` field used in your service configuration.
|
||||
|
||||
```yaml
|
||||
pve:
|
||||
pve: # must match your actual Proxmox node name
|
||||
url: https://proxmox.host.or.ip:8006
|
||||
token: username@pam!Token ID
|
||||
secret: secret
|
||||
|
||||
@@ -16,4 +16,5 @@ widget:
|
||||
username: username
|
||||
password: password
|
||||
enableLeechProgress: true # optional, defaults to false
|
||||
enableLeechSize: true # optional, defaults to false
|
||||
```
|
||||
|
||||
28
docs/widgets/services/yourspotify.md
Normal file
28
docs/widgets/services/yourspotify.md
Normal file
@@ -0,0 +1,28 @@
|
||||
---
|
||||
title: Your Spotify
|
||||
description: Your Spotify Widget Configuration
|
||||
---
|
||||
|
||||
Learn more about [Your Spotify](https://github.com/Yooooomi/your_spotify).
|
||||
|
||||
Find your API key under `Settings > Account > Public token`, click `Generate` if not yet generated, copy key after
|
||||
`?token=`.
|
||||
|
||||
Allowed fields: `["songs", "time", "artists"]`.
|
||||
|
||||
```yaml
|
||||
widget:
|
||||
type: yourspotify
|
||||
url: http://your-spotify-server.host.or.ip # if using lsio image, add /api/
|
||||
key: apikeyapikeyapikeyapikeyapikey
|
||||
interval: month # optional, defaults to week
|
||||
```
|
||||
|
||||
#### Interval
|
||||
|
||||
Allowed values for `interval`: `day`, `week`, `month`, `year`, `all`.
|
||||
|
||||
!!! note
|
||||
|
||||
`interval` is different from predefined intervals you see in `Your Spotify`'s UI.
|
||||
For example, `This week` in UI means _from the start of this week_, here `week` means _past 7 days_.
|
||||
Reference in New Issue
Block a user