Homeserver Hub

simple-homeserver-hub, a simple VueJS and TailwindCSS application designed to serve as a central hub for managing your homeserver applications.

Overview

It provides a user-friendly interface to easily navigate and access various applications on your homeserver. It displays a grid of application cards, each featuring an image and a title. That's all! Everything can be modify using a json file.

Installation

To get started with it, follow these steps:

1. Clone the Repository:

   git clone https://github.com/yamouri/simple-homeserver-hub.git

2. Edit apps.json:

   To customize the applications displayed in the hub, edit the apps.json file located in the root directory of the project. This file contains a list of applications, each represented as a JSON object with the following properties:

   • title: The name of the application as it will appear on the hub.
   • link: The URL that the application card will link to when clicked.
   • image: The path to the image file that will be displayed on the card. Try to stay on a 1:1 ratio.

   Here's an example of how to format each entry in apps.json:

   [
     {
       "title": "My Website 1",
       "link": "https://fedoraproject.org",
       "image": "img/image1.jpg"
     },
     {
       "title": "My second title",
       "link": "https://archlinux.org/",
       "image": "img/image2.jpg"
     }
   ]

3. Deploy in your server:

   Follow the installation of Apache, Nginx, NodeJs or any solution. The project was tested only on Apache. Drag and drop your files in your server and it's ready.

   Docker Installation

   To simplify the deployment of your application, you can use Docker:

   Install with

   docker-compose up -d

   Check if your container is running

   docker ps