{"id":21428988,"url":"https://github.com/notcoffee418/docker-ipc-access-check","last_synced_at":"2025-10-28T06:37:36.430Z","repository":{"id":166088708,"uuid":"641524824","full_name":"NotCoffee418/docker-ipc-access-check","owner":"NotCoffee418","description":"Check if a docker container can access an IPC file on the host system","archived":false,"fork":false,"pushed_at":"2023-05-16T17:28:23.000Z","size":3,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-16T21:48:30.415Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","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/NotCoffee418.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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-16T16:45:19.000Z","updated_at":"2023-05-16T16:47:32.000Z","dependencies_parsed_at":null,"dependency_job_id":"59456fc1-be6c-42da-8ebc-93fdfd532843","html_url":"https://github.com/NotCoffee418/docker-ipc-access-check","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/NotCoffee418/docker-ipc-access-check","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotCoffee418%2Fdocker-ipc-access-check","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotCoffee418%2Fdocker-ipc-access-check/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotCoffee418%2Fdocker-ipc-access-check/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotCoffee418%2Fdocker-ipc-access-check/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NotCoffee418","download_url":"https://codeload.github.com/NotCoffee418/docker-ipc-access-check/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotCoffee418%2Fdocker-ipc-access-check/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281397339,"owners_count":26493908,"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","status":"online","status_checked_at":"2025-10-28T02:00:06.022Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2024-11-22T22:15:27.542Z","updated_at":"2025-10-28T06:37:36.416Z","avatar_url":"https://github.com/NotCoffee418.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docker IPC Access Check Tool\n\nThis tool checks if you have access to an Inter-Process Communication (IPC) file on the host system from inside a Docker container.\n\nIt was created for debugging issues accessing a Geth IPC endpoint ran by the host system from an application running in a docker container but should be useful for testing similar permission issues with any file.\n\n## ⚠️ Important\n\nTo access an IPC file on the host system with permission restrictions, your user ID should match the user ID which owns the IPC file or a user ID which has access to it.\n\n## Getting Started\n\nClone the repository:\n\n```bash\ngit clone https://github.com/NotCoffee418/docker-ipc-access-check\n```\n\n## Configuration\n\nModify the `docker-compose.yml` file in the cloned repository. The file should look like this:\n\n```yaml\nversion: '3'\nservices:\n  check_ipc_permissions:\n    build: \n      context: .\n      dockerfile: Dockerfile\n      args: \n        - USER_NAME=usertotest\n        - USER_ID=1234\n    volumes:\n      - /path/to/host/file.ipc:/path/in/container/file.ipc\n```\n\n#### User and Id\nChange the `args` to reflect the user you want to test.  \nThis will create a user in the container's userspace matching your host.  \nAs stated previously, only the user ID should matter to ensure the permissions match.  \n\n#### IPC Path\nModify the volume on the host system only to point to your ipc file.  \nThe internal file path `/path/in/container/file.ipc` is literal and should not be modified.\n\n## Running the Tool\n\nAfter modifying the `docker-compose.yml` file, build and run the docker compose:\n\n```bash\ndocker compose up --build\n```\n\nThe tool will print whether the container has access to the IPC file or not.  \nYour output should look like this if all goes well:\n\n```\nRunning as UID = 110\n️✔ ok: IPC file exists and is readable\n✔ ok: Write check completed\nTests completed\n```\n\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnotcoffee418%2Fdocker-ipc-access-check","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnotcoffee418%2Fdocker-ipc-access-check","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnotcoffee418%2Fdocker-ipc-access-check/lists"}