Homepage - ajgillis04/GillisDockerDepot GitHub Wiki

Homepage Setup Guide

Introduction

Homepage is a modern, fully static, fast, secure, fully proxied, highly customizable application dashboard with integrations for over 100 services and translations into multiple languages.

Prerequisites

  • Docker installed
  • Homepage container running in your Docker stack

Configuration Steps

Step 1: Accessing the Homepage UI

  1. Open your browser and navigate to http://<your-ip-address>:3000.

Step 2: Adding Applications

  1. Remove default groups by editing services.yaml

     - My First Group:
       - My First Service:
         href: http://localhost/
         description: Homepage is awesome
    
     - My Second Group:
      - My Second Service:
         href: http://localhost/
         description: Homepage is the best
    
     - My Third Group:
      - My Third Service:
         href: http://localhost/
         description: Homepage is 😎
    
  2. Locate and open the widgets.yaml file within the /app/config directory.

  3. Edit the widgets.yaml file to include your applications. Example:

     - search:
         provider: google
         target: _blank
  4. Save the widgets.yaml file.

  5. Edit the docker.yaml file to link containers with homepage

     docker:
       - name: "<NAS Name"
         socket: /var/run/docker.sock
  6. Save the docker.yaml file.

  7. Restart the Homepage container to apply changes:

    docker-compose -f docker-compose-server<num>.yaml restart homepage

    homepage dash

Step 2: Additional Applications

  1. You can add more applications with the other .yaml's in app/config
  • Edit the services.yaml for applications outside of your docker network
  • bookmarks.yaml - is for the page footer
  • kubernetes.yaml - use this if you have Kubernetes set up.

Notes

  • Ensure all paths and environment variables are updated in the homepage.yaml file.
  • Regularly backup your config directory to save your settings.

Troubleshooting

  • Common Issues: List common issues and solutions.
  • Logs: Check Homepage logs for error messages.
  • Support: Link to the Homepage community and support resources.
⚠️ **GitHub.com Fallback** ⚠️