A dynamically-populated homepage that uses Starbase 80's config-template rendering, in combination with consul-template's dynamic service rendering, to create live dashboards for users.
Go to file
Jordan Roher c2a96dfe46 Improved readme
Updated variable replacement
2023-04-21 13:34:14 -07:00
.vscode Odd exclusion 2023-04-19 15:01:08 -07:00
src Improved readme 2023-04-21 13:34:14 -07:00
.dockerignore Removed baked-in images 2023-04-20 15:47:29 -07:00
.gitignore Improved readme 2023-04-21 13:34:14 -07:00
compose.yml Removed baked-in images 2023-04-20 15:47:29 -07:00
config.json.sample Working on getting the dockerfile right 2023-04-20 16:42:30 -07:00
docker-entrypoint.sh Improved readme 2023-04-21 13:34:14 -07:00
dockerfile Using logo now 2023-04-20 21:44:37 -07:00
index.html Working on getting the dockerfile right 2023-04-20 16:42:30 -07:00
license Updated readme 2023-04-21 07:56:51 -07:00
package-lock.json Improved readme 2023-04-21 13:34:14 -07:00
package.json Updated readme 2023-04-21 07:56:51 -07:00
postcss.config.js Vite + Tailwind 2023-04-19 14:40:25 -07:00
preview.jpg Fixed base image 2023-04-20 15:59:51 -07:00
readme.md Improved readme 2023-04-21 13:34:14 -07:00
tailwind.config.js Icon background colors 2023-04-19 18:10:21 -07:00
tsconfig.json No more fake services 2023-04-19 19:31:29 -07:00
tsconfig.node.json Vite + Tailwind 2023-04-19 14:40:25 -07:00
vite.config.ts Removed baked-in images 2023-04-20 15:47:29 -07:00

Starbase 80

DR T'ANA: (to Mariner) "You wanna goof around? Go work on Starbase 80!"
JET: "Damn, Starbase 80?!"
via @EnterpriseExtra

About

A nice looking homepage for Docker containers or any services and links.

No actual integration with Docker. Loads instantly. No dark theme.

If you make a change to the config JSON, restart this container and refresh.

Inspired by Ben Phelps' Homepage and Umbrel.

Icons

Use your own

Create a volume or bind mount to a subfolder of /app/public and specify a relative path.

# Your folder
compose.yml
- icons
  - jellyfin.jpg
  - ghost.jpg

# Bind mount
./icons:/app/public/icons

# Specify an icon in config.json
"icon": "/icons/jellyfin.jpg"

Dashboard icons

Use Dashboard icons by specifying a name without any prefix.

# Specify an icon in config.json
"icon": "jellyfin"

Material design

Use any Material Design icon by prefixing the name with mdi-.

# Specify an icon in config.json
"icon": "mdi-cloud"

Docker compose

services:
    homepage:
        image: jordanroher/starbase-80
        ports:
            - 4173:4173
        environment:
            - TITLE=Starbase 80 # defaults to "My Website"
            - LOGO=/starbase80.jpg # defaults to /logo.png
        volumes:
            - ./config.json:/app/src/config.json # required
            - ./public/favicon.ico:/app/public/favicon.ico # optional
            - ./public/logo.png:/app/public/logo.png # optional, or you can reference something in /icons
            - ./public/icons:/app/public/icons # or wherever, JSON icon paths are relative to /app/public

config.json format

Categories

Can have as many categories as you like.

  • category: Title, optional, displays above services
  • services: Array of services

Service

  • name: Name, required
  • uri: Hyperlink, required
  • description: 2-3 words, optional
  • icon: relative URI, absolute URI, service name (Dashboard icon) or mdi-service name (Material Design icon)

Template

[
	{
		"category": "Category name",
		"services": [
			{
				"name": "My App",
				"uri": "https://website.com",
				"description": "Fun site",
				"icon": "/icons/myapp.png"
			}
		]
	}
]

Example

[
	{
		"category": "Services",
		"services": [
			{
				"name": "Archivebox",
				"uri": "https://archivebox.mywebsite.com",
				"description": "Backup webpages",
				"icon": "/icons/archivebox.jpg"
			},
			{
				"name": "Authelia",
				"uri": "https://auth.mywebsite.com",
				"description": "Authentication",
				"icon": "/icons/authelia.png"
			},
			{
				"name": "Calibre",
				"uri": "https://calibre.mywebsite.com",
				"description": "eBook library",
				"icon": "/icons/calibre.png"
			}
		]
	},
	{
		"category": "Devices",
		"services": [
			{
				"name": "Router",
				"uri": "http://192.168.1.1/",
				"description": "Netgear Orbi",
				"icon": "/icons/router.png"
			},
			{
				"name": "Home Assistant",
				"uri": "http://homeassistant.local:8123/",
				"description": "Home automation",
				"icon": "/icons/home-assistant.svg"
			},
			{
				"name": "Synology",
				"uri": "http://synology:5000",
				"description": "Network storage",
				"icon": "/icons/synology.png"
			}
		]
	}
]