Add description
This commit is contained in:
Florian Hoss
parent
c9fb684d0a
commit
8e18338577
3 changed files with 129 additions and 1 deletions
2
Jenkinsfile
vendored
2
Jenkinsfile
vendored
|
|
@ -17,7 +17,7 @@ pipeline {
|
|||
stage('Deploying') {
|
||||
steps {
|
||||
script {
|
||||
docker.withRegistry( 'https://ghcr.io', 'githubContainer' ) {
|
||||
docker.withRegistry( 'https://registry.hub.docker.com', 'dockerHub' ) {
|
||||
if (BRANCH_NAME == "main") {
|
||||
IMAGE.push("${VERSION}")
|
||||
IMAGE.push("latest")
|
||||
|
|
|
|||
21
LICENSE
Normal file
21
LICENSE
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
MIT License
|
||||
|
||||
Copyright (c) 2022 Florian Hoss
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
107
README.md
Normal file
107
README.md
Normal file
|
|
@ -0,0 +1,107 @@
|
|||
# GoDash
|
||||
|
||||
A blazing fast start-page for your services written in Go.
|
||||
|
||||
|
||||
|
||||
[](https://build.unjx.de/job/godash/job/main/)
|
||||
|
||||
[https://hub.docker.com/r/unjxde/godash](https://hub.docker.com/r/unjxde/godash)
|
||||
|
||||
## Dark Mode
|
||||
|
||||
<img style="border-radius:0.5rem" src="https://filedn.eu/lhdsENsife1QUzPddOpRjb5/godash/dark.png" alt="dark_mode" width="500"/>
|
||||
|
||||
## Light Mode
|
||||
|
||||
<img style="border-radius:0.5rem" src="https://filedn.eu/lhdsENsife1QUzPddOpRjb5/godash/light.png" alt="light_mode" width="500"/>
|
||||
|
||||
## Lighthouse speed test
|
||||
|
||||
Emulated Moto G4 with Lighthouse 9.6.6, using headless chromium 106.0.5249.103:
|
||||
|
||||
<img style="border-radius:0.5rem" src="https://filedn.eu/lhdsENsife1QUzPddOpRjb5/godash/lighthouse.png" alt="lighthouse" width="500"/>
|
||||
|
||||
## How to use
|
||||
|
||||
Use the docker-compose to spin up the service.
|
||||
The Weather is fetched over a [Current Weather Api Call](https://openweathermap.org/current) with environment variables for the needed parameters.
|
||||
If you don't want to see the weather, do not provide a key as environment variable.
|
||||
Please refer to the available options as shown in the docker-compose example.
|
||||
|
||||
### Example of the bookmarks.json
|
||||
|
||||
All Bookmarks are read from a file called `bookmarks.json` located inside the `./storage` folder.
|
||||
The application will create a default file at startup and will automatically look for changes inside the file.
|
||||
Changes are printed in stdout when running with `LOG_LEVEL=trace`.
|
||||
|
||||
You can specify an icon of a bookmark either by using a link or by using the name of the file located inside the `./storage/icons` folder that is mounted via the docker compose file.
|
||||
The name and related link can be provided as well.
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"NAME": "Github",
|
||||
"ICON": "https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png",
|
||||
"URL": "https://github.com"
|
||||
},
|
||||
{
|
||||
"NAME": "Jenkins",
|
||||
"ICON": "jenkins.webp",
|
||||
"URL": "https://www.jenkins.io/"
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
### Available environment variables with default values
|
||||
|
||||
```toml
|
||||
PORT = 4000
|
||||
ALLOWED_HOSTS = "http://localhost:4000"
|
||||
SWAGGER = false
|
||||
|
||||
LOG_LEVEL = "info"
|
||||
|
||||
LOCATION_LATITUDE = 48.780331609463815
|
||||
LOCATION_LONGITUDE = 9.177968320179422
|
||||
OPEN_WEATHER_KEY = ""
|
||||
OPEN_WEATHER_UNITS = "metric"
|
||||
OPEN_WEATHER_LANG = "en"
|
||||
```
|
||||
|
||||
## A docker-compose example:
|
||||
|
||||
```yaml
|
||||
version: '3.9'
|
||||
|
||||
services:
|
||||
|
||||
launchpad:
|
||||
image: unjxde/launchpad:latest
|
||||
container_name: launchpad
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
# https://docs.linuxserver.io/general/understanding-puid-and-pgid
|
||||
- PUID=1000
|
||||
- PGID=1000
|
||||
# can be multiple hosts, comma separated, no spaces
|
||||
- ALLOWED_HOSTS=https://home.example.com
|
||||
# available log-levels: trace,debug,info,warn,error,fatal,panic
|
||||
- LOG_LEVEL=info
|
||||
# create account here to get free key:
|
||||
# https://home.openweathermap.org/users/sign_up
|
||||
# remove to disable weather
|
||||
- OPEN_WEATHER_KEY=thisIsNoFunctioningKey
|
||||
# standard, metric or imperial
|
||||
- OPEN_WEATHER_UNITS=metric
|
||||
# https://openweathermap.org/current#multi
|
||||
- OPEN_WEATHER_LANG=en
|
||||
# location is needed for weather
|
||||
- LOCATION_LATITUDE=48.644929601442485
|
||||
- LOCATION_LONGITUDE=9.349618464869025
|
||||
volumes:
|
||||
# to mount the bookmarks.json and the icons folder on the system
|
||||
- ./storage:/app/storage
|
||||
ports:
|
||||
- "127.0.0.1:4000:4000"
|
||||
```
|
||||
Loading…
Add table
Reference in a new issue