linkarium

Live Demo: https://udp1024.com

Linkarium is a simple web application that presents a webpage with tiles for other web applications. Each tile has an icon, name, description, and link, which can be defined in a data.json file.

This app may useful to people who want a simple web page to present links to applications of their choice.

tags: Bookmark Dashboard selfHosted Docker Homelab HTML CSS Javascript Python Golang

Features

• Dynamic Tiles: The tiles are dynamically generated from a data.json file. You can easily add, remove, or modify tiles by editing this file.
• Simple and Lightweight: Linkerium is designed to be simple and lightweight, making it easy to deploy and fast to load.

Installation option 1

1. SSH to your Docker host and navigate to your project directory:

   ssh your_username@your_docker_host
   cd /path/to/your/project/directory
   mkdir -p linkarium

2. Clone the Linkarium repository:

   git clone https://github.com/udp1024/linkerium.git

3. Navigate to the Linkarium directory:

   cd linkarium
   sudo chmod +x start-linkarium.sh

4. run the Docker image:

   ./start-linkarium.sh

You may need to adjust the paths i the start-linkarium.sh file to accomodate any differences in your environment. Now, you should be able to access Linkerium at http://your_docker_host:10080.

Optional configuration steps;

SSL

1. obtain the certificates you wish to use and add them to the web/ssl directory.
2. Edit config/linkarium.conf file to update the certificate and key file names.

Customize ports and IP

1. Edit the config/linkarium.conf file to modify the ports
2. Edit the start-linkarium.sh to reflect your changes there

Stop or Restart the server

docker stop Linkarium

note the capital L.

Start the server

cd linkarium
./start-linkarium.sh

Open Weather Map widget

Please sign-up for an API key at https://openweathermap.org/api plug the key in line-20 of Index.html to enjoy the widget on the home page

Usage

To add, remove, or modify tiles, edit the web/json/data.json file. Each object in the array should have the following properties:

• icon: The URL of the icon image.
• name: The name of the web application.
• description: A short description of the web application.
• link: The URL of the web application.

Here's an example:

[
    {
        "icon": "images/marky-logo-transp.png",
        "name": "Linkarium Repo",
        "description": "Repository of the source code",
        "link": "https://github.com/udp1024/linkarium"
    },
    // Add more objects as needed
]

Installation option 2

If you operate your own web server or have some other mechanism of serving web pages, you can copy the structure in 'web' directory to the root of web-site. Please make sure to include images, css, and json sub-directories.

Also read the note related to Open Weather Widget, above.