1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
## SUI
*a startpage for your server and / or new tab page*
### Deploy with Docker compose
#### 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-compose](https://docs.docker.com/compose/install/)
#### Install:
- `git clone` this repository
- Build and bring up with `docker-compose up -d`
- The page should be available at `http://localhost:4000`
To run at a different port open edit docker-compose.yml:
ports:
- 4000:80
### Customization
#### Changing color themes
- Click the options button on the left bottom
#### 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
#### Color themes
These can be added or customized in the themer.js file. When changing the name of a theme or adding one, make sure to edit this section in index.html accordingly:
```
<section class="themes">
```
I might add a simpler way to edit themes at some point, but adding the current ones should be pretty straight forward.
|
