Skip to content
Snippets Groups Projects
Commit 341be450 authored by Griefed's avatar Griefed :joystick:
Browse files

Update README.md

parent 195263f8
No related branches found
No related tags found
No related merge requests found
[![docker-SUI](https://i.griefed.de/images/2020/11/19/docker-SUI_Dashboard_header.png)](https://github.com/Griefed/docker-SUI/tree/lsiobase/nginx-dashboard) [![docker-SUI/tree/lsiobase/nginx-dashboard](https://i.griefed.de/images/2020/11/19/docker-SUI_Dashboard_header.png)](https://github.com/Griefed/docker-SUI/tree/lsiobase/nginx-dashboard)
--- ---
[![Docker Pulls](https://img.shields.io/docker/pulls/griefed/sui?style=flat-square)](https://hub.docker.com/repository/docker/griefed/sui) [![Docker Pulls](https://img.shields.io/docker/pulls/griefed/sui-dashboard?style=flat-square)](https://hub.docker.com/repository/docker/griefed/sui-dashboard)
[![Docker Image Size (latest by date)](https://img.shields.io/docker/image-size/griefed/sui?label=Image%20size&sort=date&style=flat-square)](https://hub.docker.com/repository/docker/griefed/sui) [![Docker Image Size (latest by date)](https://img.shields.io/docker/image-size/griefed/sui-dashboard?label=Image%20size&sort=date&style=flat-square)](https://hub.docker.com/repository/docker/griefed/sui-dashboard)
[![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/griefed/sui?label=Docker%20build&style=flat-square)](https://hub.docker.com/repository/docker/griefed/sui) [![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/griefed/sui-dashboard?label=Docker%20build&style=flat-square)](https://hub.docker.com/repository/docker/griefed/sui-dashboard)
[![Docker Cloud Automated build](https://img.shields.io/docker/cloud/automated/griefed/sui?label=Docker%20build&style=flat-square)](https://hub.docker.com/repository/docker/griefed/sui) [![Docker Cloud Automated build](https://img.shields.io/docker/cloud/automated/griefed/sui-dashboard?label=Docker%20build&style=flat-square)](https://hub.docker.com/repository/docker/griefed/sui-dashboard)
[![GitHub Repo stars](https://img.shields.io/github/stars/Griefed/docker-SUI?label=GitHub%20Stars&style=social)](https://github.com/Griefed/docker-SUI) [![GitHub Repo stars](https://img.shields.io/github/stars/Griefed/docker-SUI/tree/lsiobase/nginx-dashboard?label=GitHub%20Stars&style=social)](https://github.com/Griefed/docker-SUI/tree/lsiobase/nginx-dashboard)
[![GitHub forks](https://img.shields.io/github/forks/Griefed/docker-SUI?label=GitHub%20Forks&style=social)](https://github.com/Griefed/docker-SUI) [![GitHub forks](https://img.shields.io/github/forks/Griefed/docker-SUI/tree/lsiobase/nginx-dashboard?label=GitHub%20Forks&style=social)](https://github.com/Griefed/docker-SUI/tree/lsiobase/nginx-dashboard)
docker-SUI docker-SUI/tree/lsiobase/nginx-dashboard
A startpage for your server and / or new tab page A startpage for your server and / or new tab page as well as a status display for configured apps
[![sui](https://i.griefed.de/images/2020/11/18/docker-SUI_screenshot.png)](https://github.com/jeroenpardon/sui) [![](https://i.griefed.de/images/2020/11/18/docker-SUI_screenshot.png)](https://github.com//)
--- ---
Creates a Container which runs [jeroenpardon's](https://github.com/jeroenpardon) [sui](https://github.com/jeroenpardon/sui), with [lsiobase/nginx](https://hub.docker.com/r/lsiobase/nginx) as the base image, as seen on https://imgur.com/a/FDVRIyw. Creates a Container which runs [ThreadR-r's](https://github.com/ThreadR-r) [sui-dashboard-status](https://github.com/ThreadR-r/sui-dashboard-status), a fork of [jeroenpardon's](https://github.com/jeroenpardon) [sui](https://github.com/jeroenpardon/sui) with [lsiobase/nginx](https://hub.docker.com/r/lsiobase/nginx) as the base image.
The [lsiobase/nginx](https://hub.docker.com/r/lsiobase/nginx) image is a custom base image built with [Alpine linux](https://alpinelinux.org/) and [S6 overlay](https://github.com/just-containers/s6-overlay). The [lsiobase/nginx](https://hub.docker.com/r/lsiobase/nginx) image is a custom base image built with [Alpine linux](https://alpinelinux.org/) and [S6 overlay](https://github.com/just-containers/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 Using this image allows us to use the same user/group ids in the container as on the host, making file transfers much easier
...@@ -29,9 +29,9 @@ Using this image allows us to use the same user/group ids in the container as on ...@@ -29,9 +29,9 @@ Using this image allows us to use the same user/group ids in the container as on
```docker-compose.yml ```docker-compose.yml
version: '3.6' version: '3.6'
services: services:
sui: sui-dashboard:
container_name: sui container_name: sui-dashboard
image: griefed/sui image: griefed/sui-dashboard
restart: unless-stopped restart: unless-stopped
volumes: volumes:
- ./path/to/config:/config - ./path/to/config:/config
...@@ -50,7 +50,7 @@ services: ...@@ -50,7 +50,7 @@ services:
To run this container on a Raspberry Pi, use the `arm`-tag. I've tested it on a Raspberry Pi 3B. To run this container on a Raspberry Pi, use the `arm`-tag. I've tested it on a Raspberry Pi 3B.
`griefed/sui:arm` `griefed/sui-dashboard:arm`
## Configuration ## Configuration
...@@ -120,7 +120,6 @@ Add names for the categories you wish to define and add the bookmarks for each c ...@@ -120,7 +120,6 @@ Add names for the categories you wish to define and add the bookmarks for each c
Please note: 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 - No `,` at the end of the last bookmark in a category and at the end of the last category
## User / Group Identifiers ## User / Group Identifiers
...@@ -138,16 +137,16 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel ...@@ -138,16 +137,16 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
### Building the image yourself ### Building the image yourself
Use the [Dockerfile](https://github.com/Griefed/docker-SUI/Dockerfile) to build the image yourself, in case you want to make any changes to it Use the [Dockerfile](https://github.com/Griefed/docker-SUI/tree/lsiobase/nginx-dashboard/Dockerfile) to build the image yourself, in case you want to make any changes to it
#### docker-compose.yml #### docker-compose.yml
```docker-compose.yml ```docker-compose.yml
version: '3.6' version: '3.6'
services: services:
sui: sui-dashboard:
container_name: sui container_name: sui-dashboard
build: ./docker-SUI/ build: ./docker-SUI/tree/lsiobase/nginx-dashboard/
restart: unless-stopped restart: unless-stopped
volumes: volumes:
- ./path/to/config/files:/config - ./path/to/config/files:/config
...@@ -162,9 +161,9 @@ services: ...@@ -162,9 +161,9 @@ services:
- 443:443 - 443:443
``` ```
1. Clone the repository: `git clone https://github.com/Griefed/docker-SUI.git ./docker-SUI` 1. Clone the repository: `git clone https://github.com/Griefed/docker-SUI/tree/lsiobase/nginx-dashboard.git ./docker-SUI/tree/lsiobase/nginx-dashboard`
1. Prepare docker-compose.yml file as seen above 1. Prepare docker-compose.yml file as seen above
1. `docker-compose up -d --build sui` 1. `docker-compose up -d --build sui-dashboard`
1. Visit IP.ADDRESS.OF.HOST:8080 1. Visit IP.ADDRESS.OF.HOST:8080
1. ??? 1. ???
1. Profit! 1. Profit!
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment