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

Change README and template according to different source repo and add...

Change README and template according to different source repo and add configuration advise from source repo
parent a31de170
No related branches found
No related tags found
No related merge requests found
export GITHUB_REPONAME='docker-SUI'
export GITHUB_REPONAME='docker-SUI/tree/lsiobase/nginx-dashboard'
export GITHUB_USERNAME='Griefed'
export GITHUB_REPONAME_HEADER='https://i.griefed.de/images/2020/11/18/docker-SUI_header.png'
export GITHUB_REPONAME_SCREENSHOT='https://i.griefed.de/images/2020/11/18/docker-SUI_screenshot.png'
export DOCKERHUB_REPONAME='sui'
export DOCKERHUB_REPONAME='sui-dashboard'
export DOCKERHUB_TAG='latest'
export DOCKERHUB_USERNAME='griefed'
export DESCRIPTION='A startpage for your server and / or new tab page'
export CREATOR_USERNAME='jeroenpardon'
export CREATOR_REPONAME='sui'
export DESCRIPTION='A startpage for your server and / or new tab page as well as a status display for configured apps'
export CREATOR_USERNAME1='jeroenpardon'
export CREATOR_REPONAME1='sui'
export CREATOR_USERNAME2='ThreadR-r'
export CREATOR_REPONAME2='sui-dashboard-status'
export EXAMPLE_SITE_LINK='https://imgur.com/a/FDVRIyw'
export CONTAINER_PORT='80'
export CONTAINER_PORT2='443:443'
......
......@@ -17,7 +17,7 @@ $DESCRIPTION
---
Creates a Container which runs [$CREATOR_USERNAME's](https://github.com/$CREATOR_USERNAME) [$CREATOR_REPONAME](https://github.com/$CREATOR_USERNAME/$CREATOR_REPONAME), with [$BASE_IMAGE](https://hub.docker.com/r/$BASE_IMAGE) as the base image, as seen on $EXAMPLE_SITE_LINK.
Creates a Container which runs [$CREATOR_USERNAME2's](https://github.com/$CREATOR_USERNAME2) [$CREATOR_REPONAME2](https://github.com/$CREATOR_USERNAME2/$CREATOR_REPONAME2), a fork of [$CREATOR_USERNAME1's](https://github.com/$CREATOR_USERNAME1) [$CREATOR_REPONAME1](https://github.com/$CREATOR_USERNAME1/$CREATOR_REPONAME1) with [$BASE_IMAGE](https://hub.docker.com/r/$BASE_IMAGE) as the base image.
The [$BASE_IMAGE](https://hub.docker.com/r/$BASE_IMAGE) 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
......@@ -66,6 +66,62 @@ DOMAIN | The address of the device this container is running on. Can be an IP or
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","hostname":"sub1.example.com","port":80,"href":"https://sub1.example.com" ,"icon":"icon-name"},
{"name":"Name of app 2","hostname":"sub2.example.com""port":8080,"href":"https://sub1.example.com" ,"icon":"icon-name"}
]
}
Please note:
- No `,` at the end of the last app's line
- Find the names of icons to use at [Material Design Icons](https://materialdesignicons.com/)
### 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 `,` 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](https://www.linuxserver.io/) avoids this issue by allowing you to specify the user `PUID` and group `PGID`.
......
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