Skip to content

Commit

Permalink
fix
Browse files Browse the repository at this point in the history
  • Loading branch information
jramsgz committed Oct 21, 2024
1 parent 2dc1915 commit f817269
Show file tree
Hide file tree
Showing 65 changed files with 0 additions and 20,049 deletions.
4 changes: 0 additions & 4 deletions .github/DISCUSSION_TEMPLATE/support.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,6 @@ body:
id: troubleshooting
attributes:
label: Troubleshooting
<<<<<<< HEAD
description: Please include output from your [troubleshooting tests](https://gethomepage.dev/latest/more/troubleshooting/#service-widget-errors), if relevant.
=======
description: Please include output from your [troubleshooting tests](https://gethomepage.dev/more/troubleshooting/#service-widget-errors), if relevant.
>>>>>>> 2245cdda55bb775cc880d50d543dac87fdffbd85
validations:
required: true
7 changes: 0 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,7 @@ With features like quick search, bookmarks, weather support, a wide range of int

## Docker Integration

<<<<<<< HEAD
Homepage has built-in support for Docker, and can automatically discover and add services to the homepage based on labels. See the [Docker Service Discovery](https://gethomepage.dev/latest/configs/docker/#automatic-service-discovery) page for more information.
=======
Homepage has built-in support for Docker, and can automatically discover and add services to the homepage based on labels. See the [Docker Service Discovery](https://gethomepage.dev/configs/docker/#automatic-service-discovery) page for more information.
>>>>>>> 2245cdda55bb775cc880d50d543dac87fdffbd85

## Service Widgets

Expand Down Expand Up @@ -172,13 +168,10 @@ mkdocs serve # or build, to build the static site

If you have any questions, suggestions, or general issues, please start a discussion on the [Discussions](https://github.com/gethomepage/homepage/discussions) page.

<<<<<<< HEAD
=======
## Troubleshooting

In addition to the docs, the [troubleshooting guide](https://gethomepage.dev/troubleshooting/) can help reveal many basic config or network issues. If you're having a problem, it's a good place to start.

>>>>>>> 2245cdda55bb775cc880d50d543dac87fdffbd85
## Contributing & Contributors

Contributions are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.
Expand Down
4 changes: 0 additions & 4 deletions docs/configs/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -379,12 +379,8 @@ There are a few optional settings for the Quick Launch feature:

- `searchDescriptions`: which lets you control whether item descriptions are included in searches. This is false by default. When enabled, results that match the item name will be placed above those that only match the description.
- `hideInternetSearch`: disable automatically including the currently-selected web search (e.g. from the widget) as a Quick Launch option. This is false by default, enabling the feature.
<<<<<<< HEAD
- `showSearchSuggestions`: shows search suggestions for the internet search. This value will be inherited from the search widget if it is not specified. If it is not specified there either, it will default to false.
=======
- `showSearchSuggestions`: show search suggestions for the internet search. If this is not specified then the setting will be inherited from the search widget. If it is not specified there either, it will default to false. For custom providers the `suggestionUrl` needs to be set in order for this to work.
- `provider`: search engine provider. If none is specified it will try to use the provider set for the Search Widget, if neither are present then internet search will be disabled.
>>>>>>> 2245cdda55bb775cc880d50d543dac87fdffbd85
- `hideVisitURL`: disable detecting and offering an option to open URLs. This is false by default, enabling the feature.

```yaml
Expand Down
3 changes: 0 additions & 3 deletions docs/overrides/main.html
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
{% extends "base.html" %}

<<<<<<< HEAD
=======
{% block header %}
<div id="blur-overlay" class="blur-overlay"></div>
{% include "partials/header.html" %}
{% endblock %}

>>>>>>> 2245cdda55bb775cc880d50d543dac87fdffbd85
{% block site_nav %}
<!-- Navigation -->
{% if nav %}
Expand Down
7 changes: 0 additions & 7 deletions docs/troubleshooting/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,6 @@ hide:
- navigation
---

<<<<<<< HEAD:docs/more/troubleshooting.md
## Introducing the Homepage AI Bot

Thanks to the generous folks at [Glime](https://glimelab.ai), Homepage is now equipped with a pretty clever AI-powered bot. The bot has full knowledge of our docs, GitHub issues and discussions and is great at answering specific questions about setting up your Homepage. To use the bot, just hit the 'Ask AI' button on any page in our docs, [open a GitHub discussion](https://github.com/gethomepage/homepage/discussions) or check out the [#ai-support channel on Discord](https://discord.com/channels/1019316731635834932/1177885603552038993)!

=======
>>>>>>> 2245cdda55bb775cc880d50d543dac87fdffbd85:docs/troubleshooting/index.md
## General Troubleshooting Tips

- For API errors, clicking the "API Error Information" button in the widget will usually show some helpful information as to whether the issue is reaching the service host, an authentication issue, etc.
Expand Down
3 changes: 0 additions & 3 deletions docs/widgets/authoring/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,7 @@ self-hosted / open-source alternative, we ask that any widgets, etc. are develop
To ensure cohesiveness of various widgets, the following should be used as a guide for developing new widgets:

- Please only submit widgets that have been requested and have at least 10 'up-votes'. The purpose of this requirement is to avoid the addition (and maintenance) of service widgets that might only benefit a small number of users.
<<<<<<< HEAD:docs/more/development.md
=======
- Note that we reserve the right to decline widgets for projects that are very young (eg < ~1y) or those with a small reach (eg low GitHub stars). Again, this is in an effort to keep overall widget maintenance under control.
>>>>>>> 2245cdda55bb775cc880d50d543dac87fdffbd85:docs/widgets/authoring/getting-started.md
- Widgets should be only one row of blocks
- Widgets should be no more than 4 blocks wide and generally conform to the styling / design choices of other widgets
- Minimize the number of API calls
Expand Down
8 changes: 0 additions & 8 deletions docs/widgets/services/customapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,6 @@ widget:
time: other key
color: theme # optional - defaults to "". Allowed values: `["theme", "adaptive", "black", "white"]`.
format: date # optional
<<<<<<< HEAD
```

Supported formats for the values are `text`, `number`, `float`, `percent`, `bytes`, `bitrate`, `date` and `relativeDate`.

The `dateStyle` and `timeStyle` options of the `date` format are passed directly to [Intl.DateTimeFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat) and the `style` and `numeric` options of `relativeDate` are passed to [Intl.RelativeTimeFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/RelativeTimeFormat/RelativeTimeFormat).
=======
- field: key
label: Number of things in array
format: size
Expand All @@ -74,7 +67,6 @@ Supported formats for the values are `text`, `number`, `float`, `percent`, `byte
The `dateStyle` and `timeStyle` options of the `date` format are passed directly to [Intl.DateTimeFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat) and the `style` and `numeric` options of `relativeDate` are passed to [Intl.RelativeTimeFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/RelativeTimeFormat/RelativeTimeFormat).

The `size` format will return the length of the array or string, or the number of keys in an object. This is then formatted as `number`.
>>>>>>> 2245cdda55bb775cc880d50d543dac87fdffbd85

## Example

Expand Down
3 changes: 0 additions & 3 deletions docs/widgets/services/esphome.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,5 @@ To group both `offline` and `unknown` devices together, users should use the `of
widget:
type: esphome
url: http://esphome.host.or.ip:port
<<<<<<< HEAD
=======
key: myesphomecookie # only if auth enabled, get the value from a request from the frontend e.g. `authenticated=myesphomecookie`
>>>>>>> 2245cdda55bb775cc880d50d543dac87fdffbd85
```
3 changes: 0 additions & 3 deletions docs/widgets/services/immich.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,11 @@ description: Immich Widget Configuration

Learn more about [Immich](https://github.com/immich-app/immich).

<<<<<<< HEAD
=======
| Immich Version | Homepage Widget Version |
| -------------- | ----------------------- |
| < v1.118 | 1 (default) |
| >= v1.118 | 2 |

>>>>>>> 2245cdda55bb775cc880d50d543dac87fdffbd85
Find your API key under `Account Settings > API Keys`.

Allowed fields: `["users" ,"photos", "videos", "storage"]`.
Expand Down
6 changes: 0 additions & 6 deletions docs/widgets/services/netalertx.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,11 @@ _Note that the project was renamed from PiAlert to NetAlertX._

Allowed fields: `["total", "connected", "new_devices", "down_alerts"]`.

<<<<<<< HEAD
=======
If you have enabled a password on your NetAlertX instance, you will need to provide the `SYNC_api_token` as the `key` in your config.

>>>>>>> 2245cdda55bb775cc880d50d543dac87fdffbd85
```yaml
widget:
type: netalertx
url: http://ip:port
<<<<<<< HEAD
=======
key: netalertxsyncapitoken # optional, only if password is enabled
>>>>>>> 2245cdda55bb775cc880d50d543dac87fdffbd85
```
13 changes: 0 additions & 13 deletions docs/widgets/services/pfsense.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,7 @@ This widget requires the installation of the [pfsense-api](https://github.com/ja

Once pfSense API is installed, you can set the API to be read-only in System > API > Settings.

<<<<<<< HEAD
There are two currently supported authentication modes: 'Local Database' and 'API Token'. For 'Local Database', use `username` and `password` with the credentials of an admin user. For 'API Token', utilize the `headers` parameter with `client_token` and `client_id` obtained from pfSense as shown below. Do not use both headers and username / password.
=======
There are two currently supported authentication modes: 'Local Database' and 'API Key' (v2) / 'API Token' (v1). For 'Local Database', use `username` and `password` with the credentials of an admin user. The specifics of using the API key / token depend on the version of the pfSense API, see the config examples below. Do not use both headers and username / password.
>>>>>>> 2245cdda55bb775cc880d50d543dac87fdffbd85

The interface to monitor is defined by updating the `wan` parameter. It should be referenced as it is shown under Interfaces > Assignments in pfSense.

Expand All @@ -27,14 +23,6 @@ For version 2:
widget:
type: pfsense
url: http://pfsense.host.or.ip:port
<<<<<<< HEAD
username: user # optional, or API token
password: pass # optional, or API token
headers: # optional, or username/password
Authorization: client_id client_token
wan: igb0
fields: ["load", "memory", "temp", "wanStatus"] # optional
=======
username: user # optional, or API key
password: pass # optional, or API key
headers: # optional, or username/password
Expand All @@ -50,5 +38,4 @@ For version 1:
headers: # optional, or username/password
Authorization: client_id client_token # obtained from pfSense API
version: 1
>>>>>>> 2245cdda55bb775cc880d50d543dac87fdffbd85
```
4 changes: 0 additions & 4 deletions docs/widgets/services/photoprism.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,9 @@ title: PhotoPrism
description: PhotoPrism Widget Configuration
---

<<<<<<< HEAD
Learn more about [PhotoPrism](https://github.com/photoprism/photoprism)..
=======
Learn more about [PhotoPrism](https://github.com/photoprism/photoprism).

Authentication is possible via [app passwords](https://docs.photoprism.app/user-guide/settings/account/#apps-and-devices) or username/password.
>>>>>>> 2245cdda55bb775cc880d50d543dac87fdffbd85

Allowed fields: `["albums", "photos", "videos", "people"]`.

Expand Down
10 changes: 0 additions & 10 deletions docs/widgets/services/pihole.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,6 @@ description: PiHole Widget Configuration
---

Learn more about [PiHole](https://github.com/pi-hole/pi-hole).
<<<<<<< HEAD

As of v2022.12 [PiHole requires the use of an API key](https://pi-hole.net/blog/2022/11/17/upcoming-changes-authentication-for-more-api-endpoints-required/#page-content) if an admin password is set. Older versions do not require any authentication even if the admin uses a password.
=======
>>>>>>> 2245cdda55bb775cc880d50d543dac87fdffbd85

Allowed fields: `["queries", "blocked", "blocked_percent", "gravity"]`.

Expand All @@ -21,8 +16,3 @@ widget:
version: 6 # required if running v6 or higher, defaults to 5
key: yourpiholeapikey # optional
```
<<<<<<< HEAD
_Added in v0.1.0, updated in v0.8.9_
=======
>>>>>>> 2245cdda55bb775cc880d50d543dac87fdffbd85
8 changes: 0 additions & 8 deletions docs/widgets/services/romm.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,13 @@ title: Romm
description: Romm Widget Configuration
---

<<<<<<< HEAD
Allowed fields: `["platforms", "totalRoms"]`.
=======
Allowed fields: `["platforms", "totalRoms", "saves", "states", "screenshots", "totalfilesize"]`.
If more than (4) fields are provided, only the first (4) will be used.
>>>>>>> 2245cdda55bb775cc880d50d543dac87fdffbd85

```yaml
widget:
type: romm
url: http://romm.host.or.ip
username: username # optional
password: password # optional
<<<<<<< HEAD
=======
fields: ["platforms", "totalRoms", "saves", "states"] # optional - default fields shown
>>>>>>> 2245cdda55bb775cc880d50d543dac87fdffbd85
```
4 changes: 0 additions & 4 deletions docs/widgets/services/tubearchivist.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,7 @@ description: Tube Archivist Widget Configuration

Learn more about [Tube Archivist](https://github.com/tubearchivist/tubearchivist).

<<<<<<< HEAD
Requires API key.
=======
You must be running at least version 0.4.4
>>>>>>> 2245cdda55bb775cc880d50d543dac87fdffbd85

Allowed fields: `["downloads", "videos", "channels", "playlists"]`.

Expand Down
6 changes: 0 additions & 6 deletions docs/widgets/services/unifi-controller.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,11 @@ You can display general connectivity status from your Unifi (Network) Controller

An optional 'site' parameter can be supplied, if it is not the widget will use the default site for the controller.

<<<<<<< HEAD
Allowed fields: `["uptime", "wan", "lan", "lan_users", "lan_devices", "wlan", "wlan_users", "wlan_devices"]` (maximum of four).

Note that fields unsupported by the unifi device will not be shown.
=======
Allowed fields: `["uptime", "wan", "lan", "lan_users", "lan_devices", "wlan", "wlan_users", "wlan_devices"]` (maximum of four). Fields unsupported by the unifi device will not be shown.

!!! hint

If you enter e.g. incorrect credentials and receive an "API Error", you may need to recreate the container to clear the cache.
>>>>>>> 2245cdda55bb775cc880d50d543dac87fdffbd85

```yaml
widget:
Expand Down
4 changes: 0 additions & 4 deletions docs/widgets/services/watchtower.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,7 @@ description: Watchtower Widget Configuration

Learn more about [Watchtower](https://github.com/containrrr/watchtower).

<<<<<<< HEAD
To use this widget, Watchtower needs to be configured to to [enable metrics](https://containrrr.dev/watchtower/metrics/).
=======
To use this widget, Watchtower needs to be configured to [enable metrics](https://containrrr.dev/watchtower/metrics/).
>>>>>>> 2245cdda55bb775cc880d50d543dac87fdffbd85

Allowed fields: `["containers_scanned", "containers_updated", "containers_failed"]`.

Expand Down
Loading

0 comments on commit f817269

Please sign in to comment.