jeroenpardon/sui

SUI

a startpage for your server and / or new tab page

More screenshots

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.

jeroenpardon / sui

SUI