{"id":13564302,"url":"https://github.com/qdm12/welcome","last_synced_at":"2025-06-29T23:37:45.504Z","repository":{"id":108550607,"uuid":"206639499","full_name":"qdm12/welcome","owner":"qdm12","description":"Golang static binary I use on my servers when I login","archived":false,"fork":false,"pushed_at":"2023-05-11T20:46:26.000Z","size":176,"stargazers_count":6,"open_issues_count":5,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-05-07T06:04:11.699Z","etag":null,"topics":["golang-application","login-script","zfs"],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/qdm12.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2019-09-05T19:15:52.000Z","updated_at":"2023-09-08T13:08:33.000Z","dependencies_parsed_at":"2024-01-16T18:57:56.759Z","dependency_job_id":"33f47d99-cd5a-458f-bf6f-c771f01b70b9","html_url":"https://github.com/qdm12/welcome","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/qdm12/welcome","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qdm12%2Fwelcome","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qdm12%2Fwelcome/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qdm12%2Fwelcome/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qdm12%2Fwelcome/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qdm12","download_url":"https://codeload.github.com/qdm12/welcome/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qdm12%2Fwelcome/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262685443,"owners_count":23348420,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["golang-application","login-script","zfs"],"created_at":"2024-08-01T13:01:29.450Z","updated_at":"2025-06-29T23:37:45.479Z","avatar_url":"https://github.com/qdm12.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# Welcome\n\n```\n| |  | |    | |\n| |  | | ___| | ___ ___  _ __ ___   ___\n| |/\\| |/ _ \\ |/ __/ _ \\| '_ ` _ \\ / _ \\\n\\  /\\  /  __/ | (_| (_) | | | | | |  __/\n \\/  \\/ \\___|_|\\___\\___/|_| |_| |_|\\___|\n```\n\nThis is a Golang static binary I use on my servers when I login.\n\n## Features\n\nIt checks and displays several things\n\n1. Your hostname as *ASCII art* (random font by default)\n1. The date and time\n1. The server uptime\n1. The total RAM and CPU % usage\n1. For all ZFS volumes (if any)\n    - Capacity left in %\n    - Health status\n    - Data data errors\n1. Usage % of other partitions\n1. Docker (if installed)\n    - Docker version\n    - Docker compose version (only with `--compose` as it takes one second)\n    - Number of containers running\n    - Unhealthy and restarting containers as warnings\n1. Network information\n    - hostname\n    - Main LAN IP address\n    - Public IP address (only with `--network` flag as it takes 100-300 milliseconds)\n1. Checks multiple websites are up (only with `--network` flag as it takes 100-300 milliseconds)\n\n## Setup\n\n```sh\nwget -qO ~/welcome https://github.com/qdm12/welcome/releases/download/v0.1.0/welcome_0.1.0_linux_amd64\nchmod +x ~/welcome\n# And then, depending on your shell\necho \"~/welcome\" \u003e\u003e ~/.zshrc\n```\n\n## Usage\n\n```sh\nUsage of welcome:\n  -compose\n        show docker-compose version (slow)\n  -network\n        verify network connectivity\n  -requiredContainers string\n        comma separated list of required running container names to check for (default \"dns,ddns\")\n  -websitesToCheck string\n        comma separated list of websites to check, only enabled if --network is specified (default \"https://qqq.ninja,https://1.1.1.1\")\n```\n\n## TODOs\n\n- Check run as root\n- Fix RAM usage\n- Read partitions using advanced `df --help`\n- Check for non-imported encrypted zpool and prompt to import them `zpool import poolname -l`\n- If Docker is not running, launch it `systemctl start docker`\n- Change colors depending on % used\n- Add emojis\n- Go routines\n    - Bandwidth download, then upload\n    - Ping\n    - Docker Stats\n- ZFS\n    - Use `zpool events`\n    - Check scrub time\n    - Check error numbers with `zpool status POOLNAME`","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqdm12%2Fwelcome","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqdm12%2Fwelcome","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqdm12%2Fwelcome/lists"}