From 594102398e6d574cbfd95e8f1a914cdd2342d110 Mon Sep 17 00:00:00 2001 From: Dale Davies Date: Wed, 20 Apr 2022 11:34:03 +0100 Subject: [PATCH] Update readme with corrections, clarifictions etc --- README.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index d0c3cdc..7ff0585 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ Jump is yet another self-hosted startpage for your server designed to be simple, Get the container image from Docker Hub (https://hub.docker.com/r/daledavies/jump). -The following will start Jump and serve the page at http://localhost:8123 with a custom site name, Open Weather Map support, and volumes to map Jump's "backgrounds" and "sites" directories to local directories on your machine... +The following will start Jump and serve the page at http://localhost:8123 with a custom site name, Open Weather Map support, and volumes to map Jump's "backgrounds" and "sites" directories to local directories on your machine (`OWMAPIKEY` and `LATLONG` values below are just for example)... ```yaml version: '3' @@ -59,22 +59,25 @@ You can use the following optional environment variables to configure/customise - `LATLONG` - A latitude and longitude for the default location (e.g. "51.509865,-0.118092"). - `METRICTEMP: 'true'` - Metric (C) or imperial (F) temperature units. +**NOTE:** The OWMAPIKEY and LATLONG config options must be defined together. + #### Volume Mapping You can map the "backgrounds" and "sites" directories to local directories as shown in the Docker Compose example above. Your local directories will be populated with Jump's default files when the container is next started unless the local directories already contain files, in which case the local files will be used by Jump instead. #### Docker -If you prefer `docker run` you can run the following command and that's it. +The same can be achieved just using Docker CLI... +```bash +docker run -d -p 8123:8080 \ +--volume :/backgrounds \ +--volume :/sites \ +--env SITENAME='Custom site name' \ +--env OWMAPIKEY='' \ +--env LATLONG='' \ +--name jump docker.io/daledavies/jump ``` -docker run -d --volume :/backgrounds \ ---volume :/sites -p 8123:8080 \ ---env SITENAME='Welcome' --env OWMAPIKEY='' \ ---env LATLONG='' --name jump docker.io/daledavies/jump -``` -**Podman Setup**: If you prefer podman over docker you can replace `docker` with `podman` in above command and it should bring up jump. - ### Without Docker