{"id":13583523,"url":"https://github.com/roest01/docker-speedtest-analyser","last_synced_at":"2025-04-06T21:32:18.268Z","repository":{"id":26476976,"uuid":"50864528","full_name":"roest01/docker-speedtest-analyser","owner":"roest01","description":"Automated docker speedtest analyser tool with included web interface to monitor your internet speed connection over time. Setup at home on your NAS (Synology, QNAP tested) and the container runs hourly speedtests. The speedtest results are displayed in an webinterface as line graph(s) over the day.","archived":false,"fork":false,"pushed_at":"2022-07-07T06:23:37.000Z","size":317,"stargazers_count":108,"open_issues_count":40,"forks_count":47,"subscribers_count":10,"default_branch":"master","last_synced_at":"2024-11-06T00:39:16.605Z","etag":null,"topics":["analytics","docker","monitor","speedtest"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/roest01.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-02-01T19:23:52.000Z","updated_at":"2023-12-03T09:31:24.000Z","dependencies_parsed_at":"2022-09-10T19:51:33.378Z","dependency_job_id":null,"html_url":"https://github.com/roest01/docker-speedtest-analyser","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roest01%2Fdocker-speedtest-analyser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roest01%2Fdocker-speedtest-analyser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roest01%2Fdocker-speedtest-analyser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roest01%2Fdocker-speedtest-analyser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/roest01","download_url":"https://codeload.github.com/roest01/docker-speedtest-analyser/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247555786,"owners_count":20957839,"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":["analytics","docker","monitor","speedtest"],"created_at":"2024-08-01T15:03:32.881Z","updated_at":"2025-04-06T21:32:18.018Z","avatar_url":"https://github.com/roest01.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# Docker Speedtest Analyser\n\nAutomated docker speedtest analyser tool with included web interface to monitor your internet speed connection over time. Setup at home on your NAS (Synology, QNAP tested) and the container runs hourly speedtests. The speedtest results are displayed in an webinterface as line graph(s) over the day.\n\nThis tool was created in reference to [this reddit post](https://www.reddit.com/r/technology/comments/43fi39/i_set_up_my_raspberry_pi_to_automatically_tweet/).  \nIt used [speedtest-cli](https://github.com/sivel/speedtest-cli) to make speedtests and log them into a CSV file.  \nAfter that you can visit the web interface to view a hourly - time filterable reports about\nyour internet connectivity speed.\n\n# Screenshot\n![Statistic Screenshot](https://github.com/roest01/docker-speedtest-analyser/raw/master/speedlogger_screenshot.png?raw=true)\n\n# Docker Hub Image\nYou can get the publicly available docker image at the following location: [roest/docker-speedtest-analyser](https://hub.docker.com/r/roest/docker-speedtest-analyser/).\n\n\n# Facts\n1. The speedtest runs hourly per default\n2. nginx is prepared but not configured for SSL yet\n3. data is saved in a _.csv_ under ```/var/www/html/data/result.csv```\n4. First speedtest will be executed in container build\n\n# Installation\nThe SpeedTest analyser should to run out of the box with docker.\n\n**Important:** To keep the history of speedtest within a rebuild of\nthe container please moint a volume in ``/var/www/html/data/``\n\n### Setup:\n1. Moint host volume onto ``/var/www/html/data/``\n2. Map preferred host port on port _80_\n3. Build container from image\n4. Enjoy continious speed statistics after a while\n\n# Environment variables\n| Variable  | Type | Usage |  Example Value | Default |\n| ------------- | ------------- | ------------- | ------------- | ------------- |\n| CRONJOB_ITERATION  | INT  | Time between speedtests in minutes. Value 15 means the cronjob runs every 15 minutes. Keep undefined to run hourly. | 15 | 60 |\n| SPEEDTEST_PARAMS  | STRING  | append extra parameter for cli command.\u003cbr/\u003e `speedtest-cli --simple $SPEEDTEST_PARAMS` \u003cbr/\u003e Check [parameter documentation](https://github.com/sivel/speedtest-cli#usage)  | --mini https://speedtest.test.fr | none |\n\n# Config\nYou can configure the visualization frontend via ``appConfig.js``\ncopy the ``/js/appConfig.example.js`` into ``/data/appConfig.js`` (where your volume should be mounted).\nChange ``let appConfig = {`` to ``appConfig = {`` in /data/appConfig.js\n\n#### Libs used\n1. Bootstrap 4 - alpha\n2. Chart.js\n3. daterangepicker.js\n4. moment.js\n5. papaparse\n6. speedtest-cli\n\n#### Licence\nI kindly ask not to re-distribute this repo on hub.docker.com if it's not indispensable.\n\n##### Disclaimer / Off topic\nI've written this small tool for private use on my Synology NAS.  \nThe original twitter function is removed in this version.\n\nIf you want to contribute and report / fix bugs or bring the feature stuff written for your\nown setup, don't be shy.\n\nhave fun and test your speeeeed :)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froest01%2Fdocker-speedtest-analyser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Froest01%2Fdocker-speedtest-analyser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froest01%2Fdocker-speedtest-analyser/lists"}