\n \nminiboard

\nLightweight dashboard with tabs, uptime monitoring and notifications.
\nCan be configured through GUI or yaml file. \n\n- [Quick start](https://github.com/aceberg/miniboard#quick-start)\n- [Install binary](docs/INSTALL-BIN.md)\n- [Usage](https://github.com/aceberg/miniboard#usage)\n- [Config](https://github.com/aceberg/miniboard#config)\n- [Options](https://github.com/aceberg/miniboard#options)\n- [Local network only](https://github.com/aceberg/miniboard#local-network-only) \n- [Thanks](https://github.com/aceberg/miniboard#thanks)\n\n![screenshot](https://raw.githubusercontent.com/aceberg/miniboard/main/assets/Screenshot%202023-06-25%20at%2022-55-05%20MiniBoard%20-%20Docker.png)\n

More Themes

\n\n## Quick start\n\n```sh\ndocker run --name miniboard \\\n-e \"TZ=$YOURTIMEZONE\" \\\n-v ~/.dockerdata/miniboard:/data/miniboard \\\n-v /var/run/docker.sock:/var/run/docker.sock \\ # Only needed to create panel from Docker containers (On Edit panels page)\n-p 8849:8849 \\\naceberg/miniboard\n```\nOr use [docker-compose.yml](docker-compose.yml) \nThere is also [binary installation](docs/INSTALL-BIN.md) available.\n\n\n## Usage\nAll configuration can be done both with GUI or config file. To start with GUI first create new panel, then create new tab with this panel. Then you can add as many hosts (to panels), panels and tabs as you want. \n
\nAlso, you can start with example [board.yaml](configs/board.yaml) file. All fields are commented there.\n \n\n## Config\nConfiguration can be done through config file or environment variables\n\n\n| Variable | Description | Default |\n| -------- | ----------- | ------- |\n| AUTH | Enable Session-Cookie authentication | false |\n| AUTH_EXPIRE | Session expiration time. A number and suffix: **m, h, d** or **M**. | 7d |\n| AUTH_USER | Username | \"\" |\n| AUTH_PASSWORD | Encrypted password (bcrypt). [How to encrypt password with bcrypt?](docs/BCRYPT.md) | \"\" |\n| HOST | Listen address | 0.0.0.0 |\n| PORT | Port for web GUI | 8849 |\n| THEME | Any theme name from https://bootswatch.com in lowcase | flatly |\n| COLOR | Background color: light or dark | dark |\n| COLORON | Online host color | #89ff89 |\n| COLOROFF | Offline host color | #ff3232 |\n| BTNWIDTH | Adjust buttons to theme | 180px |\n| WEBREFRESH | Refresh interval for Tabs and Uptime pages (seconds) | 60 |\n| DBTRIMDAYS | Remove old records from DB after | 30 |\n| TZ | Time zone (for uptime monitor) | \"\" |\n\n## Options\n| Key | Description | Default | \n| -------- | ----------- | ------- | \n| -b | Path to board file | /data/miniboard/board.yaml |\n| -c | Path to config file | /data/miniboard/config.yaml |\n| -d | Path to SQLite DB file | /data/miniboard/uptime.db |\n| -n | Path to node modules (see below) | \"\" |\n\n## Local network only\nBy default, this app pulls themes, icons and fonts from the internet. But, in some cases, it may be useful to have an independent from global network setup. I created a separate [image](https://github.com/aceberg/my-dockerfiles/tree/main/node-bootstrap) with all necessary modules and fonts. \nIf you want to use local icons, download them and mount icon folder (`~/.dockerdata/icons` in this example) to `/app/icons`. Then you can open it in browser and copy each icon link to miniboard.\n```sh\ndocker run --name node-bootstrap \\\n -v ~/.dockerdata/icons:/app/icons \\ # For local icons\n -p 8850:8850 \\\n aceberg/node-bootstrap\n```\n```sh\ndocker run --name miniboard \\\n -v ~/.dockerdata/miniboard:/data/miniboard \\\n -p 8849:8849 \\\n aceberg/miniboard -n \"http://$YOUR_IP:8850\"\n```\nOr use [docker-compose](docker-compose-local.yml)\n\n## Thanks\n- All go packages listed in [dependencies](https://github.com/aceberg/miniboard/network/dependencies)\n- Favicon and logo: [Skateboard icons created by Freepik - Flaticon](https://www.flaticon.com/free-icons/skateboard)\n- [Bootstrap](https://getbootstrap.com/)\n- Themes: [Free themes for Bootstrap](https://bootswatch.com)","has_starred","hub_user","immutable_tags_settings",{"_178":11,"_179":180},"enabled","rules",[181],".*","is_automated","permissions",{"_185":17,"_186":11,"_187":11},"read","write","admin","user","storage_size",702402860,"isOrg","reponame","tag","canDeleteTags","isHubSbxKitsEnabled","currentTab","tagAttestations","displaySecurityMetadata","showSbxLogoOverride","routes/_layout.layers.$namespace.$reponame.$tag.(images).($imageUrlDigest)._index",{"_23":24,"_139":-7,"_137":-7,"_138":-7,"_25":202,"_31":65,"_210":211,"_217":11},{"_27":28,"_29":30,"_31":32,"_33":34,"_35":36,"_37":203,"_82":83,"_84":30,"_85":86,"_87":88,"_89":90,"_91":92,"_93":80,"_94":83,"_95":55,"_96":17},[204,205,206,207,208,209],{"_40":41,"_31":42,"_43":44,"_45":46,"_47":48,"_49":50,"_51":44,"_52":-5,"_53":34,"_54":55,"_56":-5},{"_40":58,"_31":59,"_43":44,"_45":60,"_47":61,"_49":50,"_51":44,"_52":-5,"_53":62,"_54":55,"_56":-5},{"_40":64,"_31":65,"_43":44,"_45":66,"_47":48,"_49":50,"_51":44,"_52":-5,"_53":67,"_54":55,"_56":68},{"_40":70,"_31":71,"_43":44,"_45":72,"_47":48,"_49":70,"_51":44,"_52":-5,"_53":73,"_54":55,"_56":-5},{"_40":70,"_31":75,"_43":44,"_45":76,"_47":48,"_49":70,"_51":44,"_52":-5,"_53":77,"_54":55,"_56":-5},{"_40":70,"_31":79,"_43":44,"_45":80,"_47":61,"_49":70,"_51":44,"_52":-5,"_53":81,"_54":55,"_56":-5},"imageWithLayers",{"_40":64,"_31":65,"_43":44,"_45":66,"_47":48,"_100":212,"_49":50,"_51":44,"_52":-5,"_53":67,"_54":55,"_56":68},[213,214,215,216],{"_31":103,"_53":104,"_105":106},{"_31":108,"_53":109,"_105":110},{"_31":123,"_53":124,"_105":114},{"_53":116,"_105":117,"_31":44},"hasPermissionToViewRepoSettings","actionData","errors"]

aceberg/miniboard:1.0.0