You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1 line
120 KiB
1 line
120 KiB
1 year ago
|
{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stemmer","stopWordFilter","trimmer"],"fields":{"title":{"boost":1000.0},"text":{"boost":1.0},"tags":{"boost":1000000.0}}},"docs":[{"location":"","title":"Home","text":"<p> A modern, fully static, fast, secure fully proxied, highly customizable application dashboard with integrations for over 100 services and translations into multiple languages. Easily configured via YAML files or through docker label discovery. </p>"},{"location":"configs/","title":"Configuration","text":"<p>Homepage uses YAML for configuration, YAML stands for \"YAML Ain't Markup Language.\". It's a human-readable data serialization format that's a superset of JSON. Great for config files, easy to read and write. Supports complex data types like lists and objects. Indentation matters. If you already use Docker Compose, you already use YAML.</p> <p>Here are some tips when writing YAML:</p> <ol> <li>Use Indentation Carefully: YAML relies on indentation, not brackets.</li> <li>Avoid Tabs: Stick to spaces for indentation to avoid parsing errors. 2 spaces are common.</li> <li>Quote Strings: Use single or double quotes for strings with special characters, this is especially important for API keys.</li> <li>Key-Value Syntax: Use key: value format. Colon must be followed by a space.</li> <li>Validate: Always validate your YAML with a linter before deploying.</li> </ol> <p>You can find tons of online YAML validators, here's one: https://codebeautify.org/yaml-validator, heres another: https://jsonformatter.org/yaml-validator.</p>"},{"location":"configs/bookmarks/","title":"Bookmarks","text":"<p>Bookmarks function much the same as Services, in how groups and lists work. They're just much simpler, smaller, and contain no extra features other than being a link out.</p> <p>The design of homepage expects <code>abbr</code> to be 2 letters, but is not otherwise forced.</p> <p>You can also use an icon for bookmarks similar to the options for service icons. If both icon and abbreviation are supplied, the icon takes precedence.</p> <p>By default, the description will use the hostname of the link, but you can override it with a custom description.</p> <pre><code>- Developer:\n- Github:\n- abbr: GH\nhref: https://github.com/\n- Social:\n- Reddit:\n- icon: reddit.png\nhref: https://reddit.com/\ndescription: The front page of the internet\n- Entertainment:\n- YouTube:\n- abbr: YT\nhref: https://youtube.com/\n</code></pre> <p></p>"},{"location":"configs/custom-css-js/","title":"Custom CSS & JS","text":"<p>As of version v0.6.30 homepage supports adding your own custom css & javascript. Please do so at your own risk.</p> <p>To add custom css simply edit the <code>custom.css</code> file under your config directory, similarly for javascript you would edit <code>custom.js</code>. You can then target elements in homepage with various classes / ids to customize things to your liking.</p> <p>You can also set a specific <code>id</code> for a service or bookmark to target with your custom css or javascript, e.g.</p> <pre><code>Service:\nid: myserviceid\nicon: icon.png\n...\n</code></pre>"},{"location":"configs/docker/","title":"Docker","text":"<p>Docker instances are configured inside the <code>docker.yaml</code> file. Both IP:PORT and Socket connections are supported.</p> <p>For IP:PORT, simply make sure your Docker instance has been configured to accept API traffic over the HTTP API.</p> <pre><code>my-remote-docker:\nhost: 192.168.0.101\nport: 2375\n</code></pre>"},{"location":"configs/docker/#using-docker-tls","title":"Using Docker TLS","text":"<p>Since Docker supports connecting with TLS and client certificate authentication, you can include TLS details when connecting to the HTTP API. Further details of setting up Docker to accept TLS connections, and generation of the keys and certs can be found in the Docker documentation. The file entries are relative to the <code>config</code> directory (location of <code>docker.yaml</code> file).</p> <pre><code>my-remote-docker:\nhost: 192.168.0.101\nport: 275\ntls:\nkeyFil
|