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

Update README with config information and new header

parent efee21ac
No related branches found
No related tags found
No related merge requests found
[![docker-SUI](https://i.griefed.de/images/2020/11/18/docker-SUI_header.png)](https://github.com/Griefed/docker-SUI)
[![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)
---
......@@ -66,6 +66,64 @@ 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","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](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 `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](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