X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fconfiguration.md;h=e43a8b811ef20efba13516229a2d6535c7d6af68;hb=acd6a8911be0804374b5600f2125e97eb178bfa5;hp=681d62a3ece637cc6290779aec94f4a5527f082b;hpb=86f4680a5bc3b4cdfd865ff90d435fa7ad2d5376;p=github%2Fbastienwirtz%2Fhomer.git diff --git a/docs/configuration.md b/docs/configuration.md index 681d62a..e43a8b8 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1,13 +1,13 @@ -## Configuration +# Configuration Title, icons, links, colors, and services can be configured in the `config.yml` file (located in `/assets` directory once built, or in the `public/assets` directory in development mode), using [yaml](http://yaml.org/) format. ```yaml --- # Homepage configuration -# See https://fontawesome.com/icons for icons options +# See https://fontawesome.com/v5/search for icons options -# Optional: Use external configuration file. +# Optional: Use external configuration file. # Using this will ignore remaining config in this file # externalConfig: https://example.com/server-luci/config.yaml @@ -19,10 +19,23 @@ logo: "assets/logo.png" # icon: "fas fa-skull-crossbones" header: true # Set to false to hide the header +# Optional: Different hotkey for search, defaults to "/" +# hotkey: +# search: "Shift" footer: '

Created with ❤️ with bulma, vuejs & font awesome // Fork me on

' # set false if you want to hide it. columns: "3" # "auto" or number (must be a factor of 12: 1, 2, 3, 4, 6, 12) -connectivityCheck: true # whether you want to display a message when the apps are not accessible anymore (VPN disconnected for example) +connectivityCheck: true # whether you want to display a message when the apps are not accessible anymore (VPN disconnected for example). + # You should set it to true when using an authentication proxy, it also reloads the page when a redirection is detected when checking connectivity. + +# Optional: Proxy / hosting option +proxy: + useCredentials: false # send cookies & authorization headers when fetching service specific data. Set to `true` if you use an authentication proxy. Can be overrided on service level. + +# Set the default layout and color scheme +defaults: + layout: columns # Either 'columns', or 'list' + colorTheme: auto # One of 'auto', 'light', or 'dark' # Optional theming theme: default # 'default' or one of the themes available in 'src/assets/themes'. @@ -47,6 +60,7 @@ colors: text-title: "#303030" text-subtitle: "#424242" card-shadow: rgba(0, 0, 0, 0.1) + link: "#3273dc" link-hover: "#363636" background-image: "assets/your/light/bg.png" dark: @@ -60,12 +74,24 @@ colors: text-title: "#fafafa" text-subtitle: "#f5f5f5" card-shadow: rgba(0, 0, 0, 0.4) + link: "#3273dc" link-hover: "#ffdd57" background-image: "assets/your/dark/bg.png" # Optional message message: # url: "https://" # Can fetch information from an endpoint to override value below. + # mapping: # allows to map fields from the remote format to the one expected by Homer + # title: 'id' # use value from field 'id' as title + # content: 'value' # value from field 'value' as content + # refreshInterval: 10000 # Optional: time interval to refresh message + # + # Real example using chucknorris.io for showing Chuck Norris facts as messages: + # url: https://api.chucknorris.io/jokes/random + # mapping: + # title: 'id' + # content: 'value' + # refreshInterval: 10000 style: "is-warning" title: "Optional message!" icon: "fa fa-exclamation-triangle" @@ -81,6 +107,11 @@ links: - name: "link 2" icon: "fas fa-book" url: "https://github.com/bastienwirtz/homer" + # this will link to a second homer page that will load config from page2.yml and keep default config values as in config.yml file + # see url field and assets/page.yml used in this example: + - name: "Second Page" + icon: "fas fa-file-alt" + url: "#page2" # Services # First level array represents a group. @@ -88,6 +119,8 @@ links: services: - name: "Application" icon: "fas fa-code-branch" + # A path to an image can also be provided. Note that icon take precedence if both icon and logo are set. + # logo: "path/to/logo" items: - name: "Awesome app" logo: "assets/tools/sample.png" @@ -95,6 +128,7 @@ services: # icon: "fab fa-jenkins" subtitle: "Bookmark example" tag: "app" + keywords: "self hosted reddit" # optional keyword used for searching purpose url: "https://www.reddit.com/r/selfhosted/" target: "_blank" # optional html tag target attribute - name: "Another one" @@ -109,7 +143,7 @@ services: items: - name: "Pi-hole" logo: "assets/tools/sample.png" - subtitle: "Network-wide Ad Blocking" + # subtitle: "Network-wide Ad Blocking" # optional, if no subtitle is defined, PiHole statistics will be shown tag: "other" url: "http://192.168.0.151/admin" type: "PiHole" # optional, loads a specific component that provides extra features. MUST MATCH a file name (without file extension) available in `src/components/services` @@ -118,7 +152,9 @@ services: # background: red # optional color for card to set color directly without custom stylesheet ``` -If you choose to fetch message information from an endpoint, the output format should be: +View **[Custom Services](customservices.md)** for details about all available custom services (like `PiHole`) and how to configure them. + +If you choose to fetch message information from an endpoint, the output format should be as follows (or you can [custom map fields as shown in tips-and-tricks](./tips-and-tricks.md#mapping-fields)): ```json { @@ -131,7 +167,7 @@ If you choose to fetch message information from an endpoint, the output format s `null` value or missing keys will be ignored and value from the `config.yml` will be used if available. Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar). -### Style Options +## Style Options Homer uses [bulma CSS](https://bulma.io/), which provides a [modifiers syntax](https://bulma.io/documentation/modifiers/syntax/). You'll notice in the config there is a `tagstyle` option. It can be set to any of the bulma modifiers. You'll probably want to use one of these 4 main colors: @@ -142,10 +178,19 @@ Homer uses [bulma CSS](https://bulma.io/), which provides a [modifiers syntax](h You can read the [bulma modifiers page](https://bulma.io/documentation/modifiers/syntax/) for other options regarding size, style, or state. -### PWA Icons +## Theming & customization -In order to easily generate all required icon preset for the PWA to work, a tool like [vue-pwa-asset-generator](https://www.npmjs.com/package/vue-pwa-asset-generator) can be used: +See `colors` settings in the configuration example above. +Favicon et application icon (pwa) are located in the `assets/icons` directory and can be replaced by any image you want (just keep the same name & size). +The `/assets/manifest.json` can also be edited to change the app (pwa) name, description and other settings. -```bash -npx vue-pwa-asset-generator -a {your_512x512_source_png} -o {your_output_folder} -``` +### Community theme + +- [Dracula theme](https://draculatheme.com/homer) by [@Tuetenk0pp](https://github.com/Tuetenk0pp) +- [Homer Theme v2](https://github.com/walkxcode/homer-theme) by [walkxcode](https://github.com/walkxcode) +- [Catppuccin theme](https://github.com/mrpbennett/catppucin-homer) by [@mrpbenett](https://github.com/mrpbennett) + + +## PWA Icons + +See icons documentation [here](https://github.com/bastienwirtz/homer/blob/main/public/assets/icons/README.md).