Getting up and running - mwalters/homed GitHub Wiki

The easiest way to get up and running is with Docker.

Using docker-compose:

version: '2'
services:
  homed:
    image: mwalters/homed:latest
    container_name: homed
    ports:
      - 8020:5000
    volumes:
      - /local/directory:/config
    restart: unless-stopped

Using docker-run:

docker run -d \
  -p 8020:5000 \
  -v /local/directory:/config \
  --name homed \
  --restart=unless-stopped \
  mwalters/homed:latest

After initially running the container, you should be able to confirm it is running by visiting http://your-host:8020. In your /local/directory you should now see an app folder. Inside this folder is the configuration file and custom CSS/JS files for homed.

• yaml configuration file is located in app/homed.yaml (see Configuration for more information)
• Link images (e.g. icons for sites/services) can be added to app/assets/logos
• Custom CSS is located in app/assets/css/custom.css
• Custom JS is located in app/assets/js/custom.js