beenull/sui
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

updated readme.md to reflect changes on target attribute

Browse source
This commit is contained in:
Marcus Kimpenhaus 2021-07-12 09:14:21 +02:00
parent c53f3adff5
commit 93b20aa5df
1 changed files with 15 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -9,13 +9,13 @@
#### Prerequisites: #### Prerequisites:
- Docker: [Linux](https://docs.docker.com/install/linux/docker-ce/debian/), [Mac](https://hub.docker.com/editions/community/docker-ce-desktop-mac), [Windows](https://hub.docker.com/editions/community/docker-ce-desktop-windows) - Docker: [Linux](https://docs.docker.com/install/linux/docker-ce/debian/), [Mac](https://hub.docker.com/editions/community/docker-ce-desktop-mac), [Windows](https://hub.docker.com/editions/community/docker-ce-desktop-windows)
- [Docker-compose](https://docs.docker.com/compose/install/) - [Docker-compose](https://docs.docker.com/compose/install/)
#### Install: #### Install:
- `git clone` this repository - `git clone` this repository
- Build and bring up with `docker-compose up -d` - Build and bring up with `docker-compose up -d`
- The page should be available at `http://localhost:4000` - The page should be available at `http://localhost:4000`
To run at a different port open edit docker-compose.yml: To run at a different port open edit docker-compose.yml:
@ -33,7 +33,7 @@ Add your apps by editing apps.json:
{ {
"apps" : [ "apps" : [
{"name":"Name of app 1","url":"sub1.example.com","icon":"icon-name"}, {"name":"Name of app 1","url":"sub1.example.com","icon":"icon-name"},
{"name":"Name of app 2","url":"sub2.example.com","icon":"icon-name"} {"name":"Name of app 2","url":"sub2.example.com","icon":"icon-name","target":"optionals"}
] ]
} }
@ -47,29 +47,30 @@ Please note:
Add your bookmarks by editing links.json: Add your bookmarks by editing links.json:
``` ```
{ {
"bookmarks":[ "bookmarks":[
{ {
"category":"Category1", "category":"Category1",
"links":[ "links":[
{ {
"name":"Link1", "name":"Link1",
"url":"http://example.com" "url":"http://example.com"
}, },
{ {
"name":"Link2", "name":"Link2",
"url":"http://example.com" "url":"http://example.com",
"target":"optionals"
} }
] ]
}, },
{ {
"category":"Category2", "category":"Category2",
"links":[ "links":[
{ {
"name":"Link1", "name":"Link1",
"url":"http://example.com" "url":"http://example.com"
}, },
{ {
"name":"Link2", "name":"Link2",
"url":"http://example.com" "url":"http://example.com"
} }