What is jump?

Jump puts your homelab links on one page and keeps watching them for you. Written in PHP, it deliberately ships without user accounts or an admin screen: you describe sites in a sites.json file (or let it read containers from your Docker host through labels) and tune everything else with environment variables or config.php. Sites can carry descriptions, tags, custom icons from the Dashboard Icons set or an automatic favicon, plus per-site status-check options such as an alternate check URL, GET instead of HEAD, extra allowed status codes and skipping SSL verification. Availability is polled continuously so the page works as a live status board, and a keyboard-invoked search box queries names, tags and URLs against your own list of search engines. Optional extras include local time and weather from Open Weather Map, a clock, greetings, random Unsplash backgrounds or your own images, several layouts and eight translations. Run it via Docker Compose, docker run, the community Helm chart, or by copying the jumpapp folder onto a PHP web server; the container listens on 8080. Latest tagged release is v1.4.1 from April 2024.

Should you self-host jump?

jump scores 50/100 on selfhost.directory (how scoring works) and ranks #17 of 44 in Dashboard. It has 604 GitHub stars.

There was no stable release in the past 12 months, so check the repository's recent activity before you rely on it.

Setup is easy: most people get it running in one sitting. An official Docker image is available. It is MIT-licensed and written mostly in PHP.

Its closest alternative on selfhost.directory is Homepage by gethomepage (84/100, 33 416 stars). It scores higher overall, so compare the two before you pick. See jump vs Homepage by gethomepage side by side.

Features

Clock and greeting display
Custom icons and automatic favicons
Fast search with keyboard shortcut
Local time and weather display
Multi-language UI
Multiple layout options
No user accounts or admin interface
Random Unsplash backgrounds
Real-time site status monitoring
Search-engine hiding (noindex)
Tag-based categorisation across pages

How to configure jump

ALTBGPROVIDERAn alternative background provider url.
An alternative background provider url.
ALTLAYOUTfalseDisplay list of sites using an alternative layout.
Display list of sites using an alternative layout.
values: true/false
AMPMCLOCKfalseShow 12 hour clock format.
Show 12 hour clock format.
values: true/false
BGBLURBackground image blur percentage (e.g. 50).
Background image blur percentage (e.g. 50).
BGBRIGHTBackground image brightness percentage (e.g. 90).
Background image brightness percentage (e.g. 90).
CACHEBYPASSfalseBypass all caches, useful for testing changes.
Bypass all caches, useful for testing changes.
values: true/false
CHECKSTATUStrueEnable/disable checking site availability status.
Enable/disable checking site availability status.
values: true/false
CUSTOMGREETINGShow a custom greeting message instead.
Show a custom greeting message instead.
CUSTOMWIDTHSet a custom max width in px for the page container/site list.
Set a custom max width in px for the page container/site list.
DEBUGfalseEnable debug mode.
Enable debug mode.
values: true/false
DISABLEIPV6falseDisable IPV6 if required.
Disable IPV6 if required.
values: true/false
DOCKERONLYSITESfalseSet to true if you want to only use docker integration and not define a sites.json.
Set to true if you want to only use docker integration and not define a sites.json.
values: true/false
DOCKERPROXYURLDocker proxy URL, for Docker integration with a proxy (e.g. "dockerproxy:2375"). Mutually exclusive with DOCKERSOCKET.
Docker proxy URL, for Docker integration with a proxy (e.g. "dockerproxy:2375"). Mutually exclusive with DOCKERSOCKET.
DOCKERSOCKETMounted docker socket location, for Docker integration without a proxy (e.g "/var/run/docker.sock"). Mutually exclusive with DOCKERPROXYURL.
Mounted docker socket location, for Docker integration without a proxy (e.g "/var/run/docker.sock"). Mutually exclusive with DOCKERPROXYURL.
LANGUAGEenSet to your chosen language code (cs, de, es, it, nl, pt, ru, ua).
Set to your chosen language code (cs, de, es, it, nl, pt, ru, ua).
values: cs, de, es, it, nl, pt, ru, ua
LATLONGA latitude and longitude for the default location (e.g. "51.509865,-0.118092").
A latitude and longitude for the default location (e.g. "51.509865,-0.118092").
METRICTEMPtrueMetric (C) or imperial (F) temperature units.
Metric (C) or imperial (F) temperature units.
values: true/false
NOINDEXtrueInclude a robots noindex meta tag in site header.
Include a robots noindex meta tag in site header.
values: true/false
OWMAPIKEYAn API key for Open Weather Map, LATLONG must also be defined.
An API key for Open Weather Map, LATLONG must also be defined.
SHOWCLOCKtrueShow the clock.
Show the clock.
values: true/false
SHOWGREETINGtrueIf false show the label "#home" instead of "good morning/evening".
If false show the label "#home" instead of "good morning/evening".
values: true/false
SHOWSEARCHtrueShow the search button, enable/disable search.
Show the search button, enable/disable search.
values: true/false
SITENAMECustom site name.
Custom site name.
STATUSCACHEDuration in minutes to cache site availability status.
Duration in minutes to cache site availability status.
UNSPLASHAPIKEYAn API key for Unsplash, enables fetching random background images from Unsplash.
An API key for Unsplash, enables fetching random background images from Unsplash.
UNSPLASHCOLLECTIONSList of Unsplash collection ID's (separated by commas) to select random images from.
List of Unsplash collection ID's (separated by commas) to select random images from.
WWWURLUseful if Jump is hosted in a sub-directory (e.g. "/startpage").
Useful if Jump is hosted in a sub-directory (e.g. "/startpage").