diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 0746863..e0063d5 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -14,5 +14,5 @@ Fixes # (issue) - [ ] I've read & comply with the [contributing guidelines](https://github.com/bastienwirtz/homer/blob/main/CONTRIBUTING.md) - [ ] I have tested my code for new features & regressions on both mobile & desktop devices, using the latest version of major browsers. -- [ ] I have made corresponding changes the documentation (README.md). +- [ ] I have made corresponding changes to the documentation (README.md). - [ ] I've checked my modifications for any breaking changes, especially in the `config.yml` file diff --git a/.github/workflows/integration.yml b/.github/workflows/integration.yml new file mode 100644 index 0000000..196113d --- /dev/null +++ b/.github/workflows/integration.yml @@ -0,0 +1,31 @@ +# This workflow will do a clean install of node dependencies, cache/restore them, build the source code and run tests across different versions of node +# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions + +name: Node.js CI + +on: + push: + branches: [ main ] + pull_request: + branches: [ main ] + +jobs: + build: + + runs-on: ubuntu-latest + + strategy: + matrix: + node-version: [16.x] + # See supported Node.js release schedule at https://nodejs.org/en/about/releases/ + + steps: + - uses: actions/checkout@v2 + - name: Use Node.js ${{ matrix.node-version }} + uses: actions/setup-node@v2 + with: + node-version: ${{ matrix.node-version }} + cache: 'yarn' + - run: yarn install + - run: yarn lint + diff --git a/.github/workflows/main.yml b/.github/workflows/release.yml similarity index 100% rename from .github/workflows/main.yml rename to .github/workflows/release.yml diff --git a/docs/configuration.md b/docs/configuration.md index e1630af..50b5bd5 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -24,6 +24,11 @@ footer: '

Created with ❤️ with " +``` + +⚠️🚧 `endpoint` & `useCredentials` new options are not yet supported by all custom services (but will be very soon). + ## PiHole Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard. @@ -13,12 +27,11 @@ Using the PiHole service you can display info about your local PiHole instance r The following configuration is available for the PiHole service. ```yaml - items: - - name: "Pi-hole" - logo: "assets/tools/sample.png" - # subtitle: "Network-wide Ad Blocking" # optional, if no subtitle is defined, PiHole statistics will be shown - url: "http://192.168.0.151/admin" - type: "PiHole" +- name: "Pi-hole" + logo: "assets/tools/sample.png" + # subtitle: "Network-wide Ad Blocking" # optional, if no subtitle is defined, PiHole statistics will be shown + url: "http://192.168.0.151/admin" + type: "PiHole" ``` ## OpenWeatherMap @@ -27,14 +40,13 @@ Using the OpenWeatherMap service you can display weather information about a giv The following configuration is available for the OpenWeatherMap service: ```yaml -items: - - name: "Weather" - location: "Amsterdam" # your location. - locationId: "2759794" # Optional: Specify OpenWeatherMap city ID for better accuracy - apiKey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api. - units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin. - background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none. - type: "OpenWeather" +- name: "Weather" + location: "Amsterdam" # your location. + locationId: "2759794" # Optional: Specify OpenWeatherMap city ID for better accuracy + apiKey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api. + units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin. + background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none. + type: "OpenWeather" ``` **Remarks:** @@ -46,8 +58,8 @@ This service displays News (grey), Warning (orange) or Error (red) notifications Two lines are needed in the config.yml : ```yaml -type: "Medusa" -apikey: "01234deb70424befb1f4ef6a23456789" + type: "Medusa" + apikey: "01234deb70424befb1f4ef6a23456789" ``` The url must be the root url of Medusa application. @@ -59,8 +71,8 @@ This service displays Activity (blue), Warning (orange) or Error (red) notificat Two lines are needed in the config.yml : ```yaml -type: "Radarr" or "Sonarr" -apikey: "01234deb70424befb1f4ef6a23456789" + type: "Radarr" or "Sonarr" + apikey: "01234deb70424befb1f4ef6a23456789" ``` The url must be the root url of Radarr/Sonarr application. @@ -75,10 +87,9 @@ For Paperless you need an API-Key which you have to store at the item in the fie For Ping you need to set the type to Ping and provide a url. ```yaml -items: - - name: "Awesome app" - type: Ping - logo: "assets/tools/sample.png" - subtitle: "Bookmark example" tag: "app" - url: "https://www.reddit.com/r/selfhosted/" +- name: "Awesome app" + type: Ping + logo: "assets/tools/sample.png" + subtitle: "Bookmark example" tag: "app" + url: "https://www.reddit.com/r/selfhosted/" ``` diff --git a/src/App.vue b/src/App.vue index 1f4f509..c263c8a 100644 --- a/src/App.vue +++ b/src/App.vue @@ -74,7 +74,8 @@ @@ -102,7 +103,8 @@ diff --git a/src/assets/defaults.yml b/src/assets/defaults.yml index 7d3a863..ed1fbc9 100644 --- a/src/assets/defaults.yml +++ b/src/assets/defaults.yml @@ -44,3 +44,6 @@ colors: message: ~ links: [] services: [] + + +proxy: ~ \ No newline at end of file diff --git a/src/components/Service.vue b/src/components/Service.vue index 39a9ac4..25b86d5 100644 --- a/src/components/Service.vue +++ b/src/components/Service.vue @@ -1,5 +1,5 @@