Top Related Projects
A self-hosted, ad-free, privacy-respecting metasearch engine
Flame is self-hosted startpage for your server. Easily manage your apps and bookmarks with built-in editors.
A very simple static homepage for your server.
🚀 A self-hostable personal dashboard built for you. Includes status-checking, widgets, themes, icon packs, a UI editor and tons more!
A highly customizable homepage (or startpage / application dashboard) with Docker and service API integrations.
Quick Overview
Sui is a simple, customizable web-based startpage for your browser. It provides a clean interface with quick access to your favorite websites, search functionality, and a weather widget. The project is designed to be easily customizable and self-hosted.
Pros
- Easy to set up and customize
- Clean and minimalist design
- Supports multiple search engines
- Includes a weather widget
Cons
- Limited advanced features compared to some other startpage solutions
- Requires self-hosting, which may be challenging for non-technical users
- Weather widget requires an API key from OpenWeatherMap
Getting Started
-
Clone the repository:
git clone https://github.com/jeroenpardon/sui.git
-
Customize the
config.json
file to add your favorite websites and adjust settings. -
(Optional) Get an API key from OpenWeatherMap and add it to the
config.json
file for the weather widget. -
Host the files on a web server or use a local file in your browser.
-
Set the hosted
index.html
as your browser's homepage or new tab page.
Competitor Comparisons
A self-hosted, ad-free, privacy-respecting metasearch engine
Pros of Whoogle-search
- Offers a privacy-focused Google search experience without ads or tracking
- Provides customizable search settings and appearance options
- Can be self-hosted for complete control over data and privacy
Cons of Whoogle-search
- Requires more technical setup and maintenance compared to SUI
- May have slower search performance due to proxying requests through a server
- Limited to Google search functionality, while SUI can integrate multiple services
Code comparison
Whoogle-search (Python):
@app.route('/search', methods=['GET'])
def search():
config = request.args.to_dict()
query = config.get('q')
return show_results(query, config)
SUI (JavaScript):
const searchApps = () => {
const searchTerm = searchInput.value.toLowerCase();
const filteredApps = apps.filter(app =>
app.name.toLowerCase().includes(searchTerm)
);
renderApps(filteredApps);
};
Both projects handle search functionality, but Whoogle-search focuses on proxying Google searches, while SUI implements a local search for configured apps and bookmarks.
Flame is self-hosted startpage for your server. Easily manage your apps and bookmarks with built-in editors.
Pros of Flame
- More feature-rich with built-in weather, system monitoring, and Docker integration
- Supports user authentication and multi-user setups
- Offers a more modern and polished user interface
Cons of Flame
- Requires more system resources due to additional features
- Setup process is more complex compared to SUI
- Less customizable in terms of appearance and layout
Code Comparison
SUI (HTML structure):
<div class="container">
<div class="category">
<h2>Category Name</h2>
<div class="bookmarks">
<!-- Bookmark items -->
</div>
</div>
</div>
Flame (React component):
const Category = ({ name, items }) => (
<div className="category">
<h2>{name}</h2>
<div className="items">
{items.map(item => <Item key={item.id} {...item} />)}
</div>
</div>
);
Both projects aim to provide a customizable startpage for web browsers, but they differ in their approach and feature set. SUI focuses on simplicity and ease of use, while Flame offers a more comprehensive solution with additional functionality. The code comparison shows that SUI uses plain HTML structure, whereas Flame utilizes React components for a more dynamic and modular approach to rendering the user interface.
A very simple static homepage for your server.
Pros of Homer
- More actively maintained with frequent updates
- Supports multiple themes and customization options
- Includes a built-in search functionality
Cons of Homer
- Requires more configuration and setup compared to SUI
- Less minimalistic design, which may not suit all users
- Slightly steeper learning curve for beginners
Code Comparison
Homer configuration (YAML):
---
title: "Dashboard"
subtitle: "Homer"
logo: "assets/logo.png"
header: true
footer: '<p>Created with <a href="https://github.com/bastienwirtz/homer">Homer</a></p>'
services:
- name: "Category 1"
icon: "fas fa-cloud"
items:
- name: "Service 1"
logo: "assets/tools/sample.png"
url: "https://example.com"
SUI configuration (JSON):
{
"name": "Dashboard",
"categories": [
{
"name": "Category 1",
"items": [
{
"name": "Service 1",
"url": "https://example.com",
"icon": "fas fa-cloud"
}
]
}
]
}
Both Homer and SUI are popular dashboard solutions for self-hosted services. Homer offers more features and customization options, while SUI provides a simpler, more minimalistic approach. The choice between the two depends on the user's specific needs and preferences.
🚀 A self-hostable personal dashboard built for you. Includes status-checking, widgets, themes, icon packs, a UI editor and tons more!
Pros of Dashy
- More feature-rich with extensive customization options
- Active development with frequent updates and community contributions
- Built-in authentication and multi-user support
Cons of Dashy
- Higher complexity and steeper learning curve
- Requires more system resources due to additional features
Code Comparison
Dashy (Vue.js component):
<template>
<div class="item-icon">
<img v-if="icon" :src="icon" :alt="title" />
<FontAwesomeIcon v-else :icon="['fas', 'cube']" />
</div>
</template>
SUI (HTML structure):
<div id="apps" class="apps">
<div class="app">
<a class="applink" href="">
<img src="" />
</a>
</div>
</div>
Summary
Dashy offers a more comprehensive solution with advanced features and customization options, making it suitable for complex setups and multi-user environments. However, this comes at the cost of increased complexity and resource usage.
SUI, on the other hand, provides a simpler, lightweight alternative that's easier to set up and maintain. It's ideal for users who prefer a minimalist approach and don't require advanced features.
Both projects serve as personal startpages or application dashboards, but cater to different user needs and preferences.
A highly customizable homepage (or startpage / application dashboard) with Docker and service API integrations.
Pros of Homepage
- More active development with frequent updates and bug fixes
- Extensive customization options and widget support
- Docker support for easier deployment
Cons of Homepage
- Steeper learning curve due to more complex configuration
- Requires more system resources to run
Code Comparison
SUI:
<div class="container">
<div class="row">
<div class="col-md-4 col-sm-6">
<div class="serviceBox">
<h3>Service Title</h3>
<p>Service description goes here.</p>
</div>
</div>
</div>
</div>
Homepage:
- Resources:
- My Home Server:
- Plex:
icon: plex
href: http://plex.example.com
- Sonarr:
icon: sonarr
href: http://sonarr.example.com
Summary
Both SUI and Homepage are dashboard solutions for self-hosted services. SUI offers a simpler, more lightweight approach with a focus on ease of use. Homepage provides more features and customization options but requires more setup time and resources. SUI uses HTML/CSS for layout, while Homepage relies on YAML configuration. Choose SUI for a quick, straightforward dashboard, or Homepage for a feature-rich, highly customizable solution.
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual CopilotREADME
SUI
a startpage for your server and / or new tab page
Deploy with Docker compose
Prerequisites:
- Docker: Linux, Mac, Windows
- Docker-compose
Install:
git clone
this repository- Build and bring up with
docker-compose up -d
- The page should be available at
http://localhost:4000
To run at a different port open edit docker-compose.yml:
ports:
- 4000:80
Install pull from git variant:
- refreshs source code every 5 minutes from master branch you provided - convenience feature for lacy devs
git clone
this repository- build image
docker build -f DockerfilePullFromGit -t sui:latest .
- run image with
docker run -e GITURL='https://x:ghp_x@github.com/jeroenpardon/sui.git' -p 8081:80 sui:latest
- can be run also with a private repository by setting username:api-key@ in the url (see above example). Otherwise remove this part of the url.
Customization
Changing color themes
- Click the options button on the left bottom
Apps
Add your apps by editing apps.json:
{
"apps" : [
{"name":"Name of app 1","url":"sub1.example.com","icon":"icon-name"},
{"name":"Name of app 2","url":"sub2.example.com","icon":"icon-name","target":"optionals"}
]
}
Please note:
- No
http://
in the URL - No
,
at the end of the last app's line - Find the names of icons to use at Material Design Icons
Bookmarks
Add your bookmarks by editing links.json:
{
"bookmarks":[
{
"category":"Category1",
"links":[
{
"name":"Link1",
"url":"http://example.com"
},
{
"name":"Link2",
"url":"http://example.com",
"target":"optionals"
}
]
},
{
"category":"Category2",
"links":[
{
"name":"Link1",
"url":"http://example.com"
},
{
"name":"Link2",
"url":"http://example.com"
}
]
}
]
}
Add names for the categories you wish to define and add the bookmarks for each category.
Please note:
- No
http://
in the URL - No
,
at the end of the last bookmark in a category and at the end of the last category
Color themes
These can be added or customized in the themer.js file. When changing the name of a theme or adding one, make sure to edit this section in index.html accordingly:
<section class="themes">
I might add a simpler way to edit themes at some point, but adding the current ones should be pretty straight forward.
Top Related Projects
A self-hosted, ad-free, privacy-respecting metasearch engine
Flame is self-hosted startpage for your server. Easily manage your apps and bookmarks with built-in editors.
A very simple static homepage for your server.
🚀 A self-hostable personal dashboard built for you. Includes status-checking, widgets, themes, icon packs, a UI editor and tons more!
A highly customizable homepage (or startpage / application dashboard) with Docker and service API integrations.
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual Copilot