README.md

Sources, GitHub, GitLab and Mirroring and all that good stuff

Repositories on GitHub are now for issues only. I've set up my own installation of GitLab and moved all my repositories over to Git.Griefed.de. Make sure to check there first for the latest code before opening an issue on GitHub.

For questions, you can always join my Discord server and talk to me there.

---

docker-SUI

A startpage for your server and / or new tab page

[[TOC]]

---

Creates a Container which runs jeroenpardon's sui, with lsiobase/nginx as the base image, as seen on https://imgur.com/a/FDVRIyw.

The lsiobase/nginx image is a custom base image built with Alpine linux and S6 overlay. Using this image allows us to use the same user/group ids in the container as on the host, making file transfers much easier

Deployment

Tags	Description
latest	Using the latest tag will pull the latest image for linux/amd64,linux/arm/v7,linux/arm64.
develop	The latest image of, if existent, the in-dev version of this container. Use at your own risk!

Using GitHub Workflows, images for this container are multi-arch. Simply pulling :latest should retrieve the correct image for your architecture. Images are available for linux/amd64,linux/arm/v7,linux/arm64.

Pre-built images

Using docker-compose:

version: "2"
services:
  sui:
    image: griefed/sui:latest
    container_name: sui
    restart: unless-stopped
    environment:
      - TZ=Europe/Berlin # Timezone
      - PUID=1000 # User ID
      - PROTOCOL=https # The protocol used to access this container. Either HTTP or HTTPS.
      - PGID=1000 # Group ID
      - DOMAIN=www.example.com # The address of the device this container is running on. Can be an IP or sub.domain.tld.
    volumes:
      - /host/path/to/config:/config # Contains all application data and base-image config files
    ports:
      - 443:443/tcp # https
      - 80:80/tcp # http

Using CLI:

docker create \
  --name=sui \
  -e TZ=Europe/Berlin `# Timezone` \
  -e PUID=1000 `# User ID` \
  -e PROTOCOL=https `# The protocol used to access this container. Either HTTP or HTTPS.` \
  -e PGID=1000 `# Group ID` \
  -e DOMAIN=www.example.com `# The address of the device this container is running on. Can be an IP or sub.domain.tld.` \
  -v /host/path/to/config:/config `# Contains all application data and base-image config files` \
  -p 443:443/tcp `# https` \
  -p 80:80/tcp `# http` \
  --restart unless-stopped \
  griefed/sui:latest

Configuration

Configuration	Explanation
Restart policy	"no", always, on-failure, unless-stopped
config volume	Contains config files and logs.
data volume	Contains your/the containers important data.
TZ	Timezone
PUID	for UserID
PGID	for GroupID
DOMAIN	The address of the device this container is running on. Can be an IP or sub.domain.tld.
PROTOCOL	The protocol used to access this container. Either HTTP or HTTPS.
ports	The port where the service will be available at.

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"}
    ]
}

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"
            }
         ]
      },
      {  
         "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

User / Group Identifiers

When using volumes, permissions issues can arise between the host OS and the container. Linuxserver.io avoids this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id user as below:

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Building the image yourself

Use the Dockerfile to build the image yourself, in case you want to make any changes to it

Using docker-compose:

version: '3.6'
services:
  sui:
    container_name: sui
    build: ./docker-SUI/
    restart: unless-stopped
    volumes:
      - ./path/to/config/files:/config
    environment:
      - TZ=Europe/Berlin
      - PUID=1000  # User ID
      - PGID=1000  # Group ID
      - DOMAIN=www.example.com
      - PROTOCOL=https
    ports:
      - 8080:80
      - 443:443

1. Clone the repository: git clone https://github.com/Griefed/docker-SUI.git ./docker-SUI
2. Prepare docker-compose.yml file as seen above
3. docker-compose up -d --build sui
4. Visit IP.ADDRESS.OF.HOST:8080
5. ???
6. Profit!