{"id":19914452,"url":"https://github.com/fescobar/allure-docker-service-ui","last_synced_at":"2025-05-03T05:31:28.886Z","repository":{"id":37926605,"uuid":"286517721","full_name":"fescobar/allure-docker-service-ui","owner":"fescobar","description":"Allure Docker Service UI provides a friendly user interface for frankescobar/allure-docker-service API container.","archived":false,"fork":false,"pushed_at":"2024-03-15T21:05:04.000Z","size":330,"stargazers_count":75,"open_issues_count":7,"forks_count":37,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-03-15T22:24:14.886Z","etag":null,"topics":["allure","allure-docker","allure-docker-service","automation","docker","kubernetes","reactjs","reporting","reporting-tool","testing"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fescobar.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}},"created_at":"2020-08-10T15:53:14.000Z","updated_at":"2024-03-13T09:27:05.000Z","dependencies_parsed_at":"2022-07-07T23:13:07.563Z","dependency_job_id":null,"html_url":"https://github.com/fescobar/allure-docker-service-ui","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/fescobar%2Fallure-docker-service-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fescobar%2Fallure-docker-service-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fescobar%2Fallure-docker-service-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fescobar%2Fallure-docker-service-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fescobar","download_url":"https://codeload.github.com/fescobar/allure-docker-service-ui/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224354006,"owners_count":17297378,"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":["allure","allure-docker","allure-docker-service","automation","docker","kubernetes","reactjs","reporting","reporting-tool","testing"],"created_at":"2024-11-12T21:36:08.634Z","updated_at":"2024-11-12T21:36:09.114Z","avatar_url":"https://github.com/fescobar.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![](resources/allure.png)](http://allure.qatools.ru/)\n[![](resources/docker.png)](https://docs.docker.com/)\n[![](resources/reactjs.png)](https://reactjs.org/)\n\n# ALLURE-DOCKER-SERVICE UI\n[![](https://github.com/fescobar/allure-docker-service-ui/actions/workflows/docker-publish.yml/badge.svg?branch=master)](https://github.com/fescobar/allure-docker-service-ui/actions?query=branch%3Amaster)\n\n![](https://img.shields.io/docker/pulls/frankescobar/allure-docker-service-ui)\n\nTable of contents\n=================\n   * [FEATURES](#FEATURES)\n      * [Docker Hub](#docker-hub)\n      * [Docker Versions](#docker-versions)\n   * [USAGE](#USAGE)\n      * [Docker on Unix/Mac](#docker-on-unixmac)\n      * [Docker on Windows (Git Bash)](#docker-on-windows-git-bash)\n      * [Docker Compose](#docker-compose)\n      * [Implementation Examples](#implementation-examples)\n      * [Known Issues](#known-issues)\n      * [Accessing UI](#accessing-ui)\n      * [Extra options](#extra-options)\n          * [Get Info](#get-info)\n          * [Add Custom URL Prefix](#add-custom-url-prefix)\n   * [SUPPORT](#SUPPORT)\n      * [Gitter](#gitter)\n   * [DOCKER GENERATION (Usage for developers)](#docker-generation-usage-for-developers)\n\n## FEATURES\nAllure Docker Service UI provides a friendly user interface for [frankescobar/allure-docker-service](https://github.com/fescobar/allure-docker-service) API container.\n\n[![](resources/signin-allure-docker-service-ui.png)](resources/signin-allure-docker-service-ui.png)\n[![](resources/allure-docker-service-ui.png)](resources/allure-docker-service-ui.png)\n\n### Docker Hub\n- Repository: [frankescobar/allure-docker-service-ui](https://hub.docker.com/r/frankescobar/allure-docker-service-ui/)\n\n### Docker Versions\nDocker container versions are publish on [https://github.com/fescobar/allure-docker-service-ui/releases](https://github.com/fescobar/allure-docker-service-ui/releases)\n\n#### Image Variants\nAllure Docker Service supports architectures amd64, arm/v7 and arm64.\n\n- Tags: https://hub.docker.com/r/frankescobar/allure-docker-service-ui/tags\n\n## USAGE\n### Docker on Unix/Mac\n```sh\ndocker run -p 5050:5050 -e CHECK_RESULTS_EVERY_SECONDS=NONE -e KEEP_HISTORY=1 \\\n           -v ${PWD}/projects:/app/projects \\\n           frankescobar/allure-docker-service\n\ndocker run -p 5252:5252 -e ALLURE_DOCKER_PUBLIC_API_URL=http://localhost:5050 \\\n           frankescobar/allure-docker-service-ui\n```\n\n### Docker on Windows (Git Bash)\n```sh\ndocker run -p 5050:5050 -e CHECK_RESULTS_EVERY_SECONDS=NONE -e KEEP_HISTORY=1 \\\n           -v \"/$(pwd)/projects:/app/projects\" \\\n           frankescobar/allure-docker-service\n\ndocker run -p 5252:5252 -e ALLURE_DOCKER_PUBLIC_API_URL=http://localhost:5050 \\\n           frankescobar/allure-docker-service-ui\n```\n\n### Docker Compose\nUsing docker-compose is the best way to manage containers: [allure-docker-multi-project-example/docker-compose.yml](https://github.com/fescobar/allure-docker-service-examples/blob/master/allure-docker-multi-project-example/docker-compose.yml)\n\n```sh\nversion: '3'\nservices:\n  allure:\n    image: \"frankescobar/allure-docker-service\"\n    environment:\n      CHECK_RESULTS_EVERY_SECONDS: NONE\n      KEEP_HISTORY: 1\n      KEEP_HISTORY_LATEST: 25\n    ports:\n      - \"5050:5050\"\n    volumes:\n      - ${PWD}/projects:/app/projects\n\n  allure-ui:\n    image: \"frankescobar/allure-docker-service-ui\"\n    environment:\n      ALLURE_DOCKER_PUBLIC_API_URL: \"http://localhost:5050\"\n      ALLURE_DOCKER_PUBLIC_API_URL_PREFIX: \"\"\n    ports:\n      - \"5252:5252\"\n```\n\n```sh\ndocker-compose up allure allure-ui\n```\n\nIf you want to run in background:\n\n```sh\ndocker-compose up -d allure allure-ui\n```\n\nYou can see the logs:\n\n```sh\ndocker-compose logs -f allure\ndocker-compose logs -f allure-ui\n```\n\n### Implementation Examples\nCheck examples here:\n[frankescobar/allure-docker-service-examples](https://github.com/fescobar/allure-docker-service-examples)\n\n### Known Issues\n- `Network Error when I tried to access http://localhost:5252/allure-docker-service-ui/` --\u003e https://github.com/fescobar/allure-docker-service-ui/issues/4\n\n### Accessing UI\nOpen your browser and access to the UI: http://localhost:5252/allure-docker-service-ui\n\n### Extra options\n#### Get Info\nYou can get extra info using the next urls:\n\n- http://localhost:5252/allure-docker-service-ui/config\n\n- http://localhost:5252/allure-docker-service-ui/version\n\n#### Add Custom URL Prefix\nConfigure an url prefix if your deployment requires it (e.g. reverse proxy with nginx)\n```sh\n    environment:\n      URL_PREFIX: \"/my-prefix\"\n```\nWith this configuration you can request the UI in this way too:\n```sh\ncurl http://localhost:5252/my-prefix/allure-docker-service-ui\n```\n\n\n## SUPPORT\n### Gitter\n[![Gitter](https://badges.gitter.im/allure-docker-service/community.svg)](https://gitter.im/allure-docker-service/community?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge)\n\n\n## DOCKER GENERATION (Usage for developers)\n### Install Docker\n```sh\nsudo apt-get update\n```\n```sh\nsudo apt install -y docker.io\n```\nIf you want to use docker without sudo, read following links:\n- https://docs.docker.com/engine/installation/linux/linux-postinstall/#manage-docker-as-a-non-root-user\n- https://stackoverflow.com/questions/21871479/docker-cant-connect-to-docker-daemon\n\n### Build image\n```sh\ndocker build -t allure-ui-release -f docker/Dockerfile --build-arg VERSION=na --build-arg VCS_REF=na --build-arg BUILD_DATE=na .\n```\n### Run container\n```sh\ndocker run -d  -p 5252:5252 allure-ui-release\n```\n### See active containers\n```sh\ndocker container ls\n```\n### Access to container\n```sh\ndocker exec -it ${CONTAINER_ID} bash\n```\n### Access to logs\n```sh\ndocker exec -it ${CONTAINER_ID} tail -f log\n```\n### Remove all containers\n```sh\ndocker container rm $(docker container ls -a -q) -f\n```\n### Remove all images\n```sh\ndocker image rm $(docker image ls -a -q)\n```\n### Remove all stopped containers\n```sh\ndocker ps -q -f status=exited | xargs docker rm\n```\n### Remove all dangling images\n```sh\ndocker images -f dangling=true | xargs docker rmi\n```\n### Register tagged image (Example)\n```sh\ndocker login\ndocker tag allure-ui-release frankescobar/allure-docker-service-ui:${PUBLIC_TAG}\ndocker push frankescobar/allure-docker-service-ui\n```\n### Register latest image (Example)\n```sh\ndocker tag allure-ui-release frankescobar/allure-docker-service-ui:latest\ndocker push frankescobar/allure-docker-service-ui\n```\n### Download latest image registered (Example)\n```sh\ndocker run -d  -p 5252:5252 frankescobar/allure-docker-service-ui\n```\n### Download specific tagged image registered (Example)\n```sh\ndocker run -d -p 5252:5252 frankescobar/allure-docker-service-ui:7.0.0\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffescobar%2Fallure-docker-service-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffescobar%2Fallure-docker-service-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffescobar%2Fallure-docker-service-ui/lists"}