More documentation

README.md

@@ -26,4 +26,67 @@ services:
             SITENAME: 'Custom site name'
 
 ```
-    
+
+You can use the following environment variables to customise configure Jump...
+
+- `SITENAME` - Custom site name.
+- `NOINDEX` - Include a robots noindex meta tag in site header.
+- `CACHEBYPASS` - Bypass all caches, useful for testing changes.
+
+### Without Docker
+
+Clone the repo 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...
+
+```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`.
+
+## Configuration
+
+### Sites
+
+Edit the `/sites/sites.json` file to include your own services on the startpage...
+
+```json
+[
+    {
+        "name": "Bitwarden",
+        "url" : "https://bitwarden.example.com",
+        "nofollow": true,
+        "icon": "bitwarden.png"
+    },
+    {
+        "name": "Gitea",
+        "url" : "https://git.example.com"
+    },
+    {
+        "name": "Nextcloud",
+        "url" : "https://cloud.example.com",
+        "nofollow": true
+    },
+    {
+        "name": "Paperless",
+        "url" : "https://paperless.example.com",
+        "nofollow": true,
+        "icon": "paperless.jpg"
+    }
+]
+```
+
+Although `name` and `url` are mandatory, you do not need to provide `nofollow` and `icon`...
+
+#### Icons
+
+You can provide custom icons for your sites by placing them in the `/sites/icons/` directory and referencing the filename in `sites.json` using the `icon` option.
+
+#### nofollow
+
+Use the `nofollow` option to specify if site links should include `rel="nofollow"`.
+
+### Background Images
+
+To use your own background images just copy them to the `/assets/backgrounds/` directory.