README.md

homeoverview

homeoverview is a Website, that displays all of your locally host websites, to have an nice overview on them, it is easily configurable and it is build for using it with docker.

Install with Docker

# create volume and config
mkdir /docker/homeoverview/
cd /docker/homeoverview/
touch config.json

# edit the config
vim config.json # use the example config from below and edit it to your wishes

# start container
sudo docker run -d --name homeoverview -p 80:3000 -v /docker/homeoverview:/homeoverview/volume/ zgast/homeoverview:latest

example config

{
  
  "logo":{
     "customLogo":false,
     "logoURL":"https://www.crn.ru/upload/iblock/0ce/Synology_logo_Standard.png"
  },
  "sites":[
     {
        "name":"example",
        "url":"http://example.local/",
        "description":"",
        "logo":"https://www.crn.ru/upload/iblock/0ce/Synology_logo_Standard.png"
     },
     {
        "name":"example",
        "url":"http://example.local/",
        "description":"",
        "logo":"https://www.crn.ru/upload/iblock/0ce/Synology_logo_Standard.png"
     }
  ]
}

logo: you can enable customLogo with an true and the logo gets replaced with the URL from logoURL

sites: those are the cards and the websites, you can enter as much as you want, if you leave the description empty, it will be replaced with an example

Install without Docker

yarn

# clone repo
git clone https://github.com/zgast/homeoverview/
cd homeoverview
# edit the config
vim ./volume/config.json
# build and start it
yarn build
yarn start

npm

# clone repo
git clone https://github.com/zgast/homeoverview/
cd homeoverview
# edit the config
vim ./volume/config.json
# build and start it
npm run build
npm run start

Look