a startpage for your server and / or new tab page
Find a file
2021-12-05 02:19:39 +01:00
assets Merge pull request #24 from simonporte/master 2021-12-05 02:19:39 +01:00
apps.json Added optional target attributes to handlbars template an apps/links collection 2021-07-12 08:59:43 +02:00
docker-compose.yml Update docker-compose.yml 2020-10-05 15:19:57 +01:00
Dockerfile Remove need of NGINX and root 2020-05-08 12:08:49 -05:00
index.html Merge pull request #24 from simonporte/master 2021-12-05 02:19:39 +01:00
LICENSE Create LICENSE 2019-04-05 05:02:53 +02:00
links.json Added optional target attributes to handlbars template an apps/links collection 2021-07-12 08:59:43 +02:00
providers.json fix: correct link parameter 2020-07-29 18:42:53 -06:00
README.md updated readme.md to reflect changes on target attribute 2021-07-12 09:14:21 +02:00

SUI

a startpage for your server and / or new tab page

screenshot

More screenshots

Deploy with Docker compose

Prerequisites:

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

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.