Dockery/Jump
1
0
Fork 0
mirror of https://github.com/daledavies/jump.git synced 2026-05-07 03:37:26 +02:00
Code Issues Packages Projects Releases Activity

Improve documentation in readme

Browse Source
This commit is contained in:
Dale Davies
2022-02-10 19:43:34 +00:00
parent 59123bc394
commit e5719ac8c5
1 changed files with 26 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@@ -10,9 +10,9 @@ Jump is yet another self-hosted startpage for your server designed to be simple,
### Docker
You can pull the [daledavies/jump](https://hub.docker.com/r/daledavies/jump) image direct from Docker Hub and use the Docker CLI command, but my personal preference is Docker Compose.
Get the official 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, mapping the backgrounds and sites directory locally...
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...
```yaml
version: '3'
@@ -31,29 +31,29 @@ services:
```
You can use the following environment variables to configure/customise Jump...
You can use the following optional environment variables to configure/customise Jump...
- `SITENAME` - Custom site name.
- `NOINDEX` - Include a robots noindex meta tag in site header.
- `CACHEBYPASS` - Bypass all caches, useful for testing changes.
- `NOINDEX: 'true'` - Include a robots noindex meta tag in site header
- `CACHEBYPASS: 'true'` - Bypass all caches, useful for testing changes.
- `OWMAPIKEY` - An API key for Open Weather Map, LATLONG (below) must also be defined.
- `LATLONG` - A latitude and longitude for the default location (e.g. "51.509865,-0.118092").
#### Volume Mapping
You can map the "backgrounds" and "sites" directories as shown in the Docker Compose example above. After configuring volumes, the directories mapped on your host will be populated with Jump's default files when the container is next started. If the local directories contain files then they will persist going forward.
You can map the "backgrounds" and "sites" directories as shown in the Docker Compose example above. Your host 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.
### Without Docker
Clone this git repo and copy everything within the `jumpapp` directory to your server, edit `config.php` accordingly.
Clone this repository and copy everything within the `jumpapp` directory to your server, edit `config.php` accordingly.
Then from within the web root directory on your server, install dependencies via composer...
Install dependencies via composer by running the following command within the web root...
```bash
composer install --no-dev
```
Make sure you have created a cache directory and given the web user permission to read and write, the cache directory should match your `config.php` entry for `cachedir`.
Make sure you have created a cache directory and given the web user permission to write to it, the cache directory should match your `config.php` entry for `cachedir`.
## Configuration
@@ -61,7 +61,7 @@ Make sure you have created a cache directory and given the web user permission t
You can configure Jump to get local time and weather updates by adding an Open Weather Map API key to `config.php` or passing the `OWPAPIKEY ` environment variable to the docker container (as described above).
You will also need to provide a default `LATLONG` string, Jump will use this (e.g. "51.509865,-0.118092") until you press the location button and allow permission to get your location via the web browser.
You will also need to provide a default `LATLONG` string (e.g. "51.509865,-0.118092"), Jump will use this until you press the location button and allow permission to get your location from the web browser.
### Sites
@@ -93,7 +93,8 @@ Edit the `/sites/sites.json` file to include your own sites on the startpage...
]
```
Although `name` and `url` are mandatory, you do not need to provide `nofollow` and `icon`.
* `name` and `url` are mandatory.
* `nofollow` and `icon` are optional.
#### Icons
@@ -106,3 +107,17 @@ Use the `nofollow` option to include `rel="nofollow"` on specific site links.
### Background Images
To use your own background images just copy them to the `/backgrounds/` directory, Jump will pick up on them automatically.
## Development
Patches, improvements and feature requests are welcomed although I want to avoid anything that requires a database, admin interface or user accounts.
For development you will need to install composer dependencies by running `composer install` from within the `jumpapp` directory.
Javascript is bundled using Webpack, so you will need to have installed Node.js. Then within the root project directory (the same level as webpack.config.js) you should run `npm install`.
Before starting development you can run `npm run dev`, this will watch for changes to files within the `/assets/js/src/`directory and bundle them on the fly. The javascript bundle (`index.bundle.js`) created in development mode will not be minified and will contain source maps for debugging.
You can test a production build using `npm run build`, this will bundle and minify the javascript source files without source maps.
Please do not commit javascript bundles, only commit the patched source files.