{"id":36630195,"url":"https://github.com/sleroy/smoketest-docker-webserver","last_synced_at":"2026-01-12T09:36:25.521Z","repository":{"id":216158502,"uuid":"740611223","full_name":"sleroy/smoketest-docker-webserver","owner":"sleroy","description":"Docker image to display a basic web app with some additional health checks (DB, pings)","archived":false,"fork":false,"pushed_at":"2024-04-12T16:11:42.000Z","size":832,"stargazers_count":0,"open_issues_count":6,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-04-16T07:52:48.124Z","etag":null,"topics":["containers","devops","docker","smoke-test"],"latest_commit_sha":null,"homepage":"https://www.byoskill.com","language":"JavaScript","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/sleroy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":"sleroy"}},"created_at":"2024-01-08T17:41:22.000Z","updated_at":"2024-04-16T07:52:48.125Z","dependencies_parsed_at":"2024-01-10T10:25:30.644Z","dependency_job_id":"ed9b7707-7318-4ca4-a2e4-9a3206afbec7","html_url":"https://github.com/sleroy/smoketest-docker-webserver","commit_stats":null,"previous_names":["sleroy/docker-web","sleroy/smoketest-docker-webserver"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/sleroy/smoketest-docker-webserver","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sleroy%2Fsmoketest-docker-webserver","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sleroy%2Fsmoketest-docker-webserver/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sleroy%2Fsmoketest-docker-webserver/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sleroy%2Fsmoketest-docker-webserver/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sleroy","download_url":"https://codeload.github.com/sleroy/smoketest-docker-webserver/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sleroy%2Fsmoketest-docker-webserver/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28337728,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-12T06:09:07.588Z","status":"ssl_error","status_checked_at":"2026-01-12T06:05:18.301Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["containers","devops","docker","smoke-test"],"created_at":"2026-01-12T09:36:25.461Z","updated_at":"2026-01-12T09:36:25.511Z","avatar_url":"https://github.com/sleroy.png","language":"JavaScript","funding_links":["https://github.com/sponsors/sleroy"],"categories":[],"sub_categories":[],"readme":"# Docker SmokeTest image\n\nDocker image to display a basic web app with some additional health checks (DB, pings)\n\n[![Docker Hub Image CI](https://github.com/sleroy/smoketest-docker-webserver/actions/workflows/docker-image.yml/badge.svg)](https://github.com/sleroy/smoketest-docker-webserver/actions/workflows/docker-image.yml)\n\n[![Node.js CI](https://github.com/sleroy/smoketest-docker-webserver/actions/workflows/node.js.yml/badge.svg)](https://github.com/sleroy/smoketest-docker-webserver/actions/workflows/node.js.yml)\n\n[![CodeQL](https://github.com/sleroy/smoketest-docker-webserver/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/sleroy/smoketest-docker-webserver/actions/workflows/github-code-scanning/codeql)\n\nDocker hub page : [Dockerhub page](https://hub.docker.com/repository/docker/sylvainleroy/smoketest-docker-webserver)\n\n![Screenshot](./screenshot.png)\n\n\n## Overview\n\nDocker SmokeTest is a project aimed at providing a Docker image designed for cloud-based container architectures such as AWS ECS, AWS EKS, or GCP GKE. The image includes a basic web page exposed on port 80, displaying essential server information, including hostname and IP addresses. Additionally, the image facilitates health checks, including database connection tests for MySQL/MariaDB/PGQL, MongoDB, and DynamoDB.\n\n## Features\n\n- **Basic Web Page**: The Docker image exposes a simple web page on port 80, showcasing server details.\n\n- **Hostname and IP Display**: The web page displays the hostname and IP addresses of the servers, aiding in quick identification.\n\n- **Health checks**: The image includes healthchecks to ensure the availability and connectivity of various databases:\n\n  - MySQL/MariaDB/PGQL\n  - MongoDB\n  - DynamoDB\n\n- **Configuration Options**: Healthcheck configurations can be customized either through a JSON file or via environment variables, offering flexibility in adapting to different environments.\n\n## Usage\n\n## TL / DR\n\nPull the docker image\n\n```bash\ndocker run ghcr.io/sleroy/smoketest-docker-webserver:main -p 3000:3000      \n```\n\nLaunch the container : \n\n```bash\n docker run --rm -i -t -p 3000:3000  ghcr.io/sleroy/smoketest-docker-webserver:main\n```\n\nOpen your browser to the adress `localhost:3000`.\n\n### Run with Environment Variables\n\n```bash\n\ndocker run -p 80:80 \\\n           -e DB_TYPE=mysql \\\n           -e DB_HOST=my-database-host \\\n           -e DB_PORT=3306 \\\n           -e DB_USER=myuser \\\n           -e DB_PASSWORD=mypassword \\\n           docker-smoketest:latest\n```\n\n### Run with JSON Configuration\n\n```bash\n\ndocker run -p 80:80 -v /path/to/config.json:/app/config.json docker-smoketest:latest\n\n```\n\n### Environment\n\n- **DB_TYPE**: Database type (mysql, mongodb, dynamodb, etc.).\n- **DB_HOST**: Database host address.\n- **DB_PORT**: Database port.\n- **DB_USER**: Database username.\n- **DB_PASSWORD**: Database password.\\*\\*: Database password.\n- **DB_TIMEOUT**: Database connection timeout\n\n## Database connection configuration\n\n### JSON Format\n\n```json\n{\n  \"database\": {\n    \"type\": \"mysql\",\n    \"host\": \"my-database-host\",\n    \"port\": 3306,\n    \"user\": \"myuser\",\n    \"password\": \"mypassword\",\n    \"timeout\": 5000,\n    \"debug\": false\n  },\n  \"healthchecks\": [{ \"ip\": \"127.0.0.1\", \"port\": 80 }]\n}\n```\n\n## License\n\nThis project is licensed under the MIT License.\n\nFeel free to contribute, report issues, or provide suggestions. Happy containerizing!\n\n## Roadmap\n\n- [ ] Support of SecretManager\n- [ ] Support of SSM ParameterStore to load the configuration\n- [ ] Support of MongoDB\n- [ ] Support of DynamoDB\n- [ ] Support of S3 health checks\n- [ ] Asynchronous checks\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsleroy%2Fsmoketest-docker-webserver","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsleroy%2Fsmoketest-docker-webserver","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsleroy%2Fsmoketest-docker-webserver/lists"}