{"id":15020042,"url":"https://github.com/akretion/docky","last_synced_at":"2025-04-04T19:11:32.540Z","repository":{"id":26808953,"uuid":"30267463","full_name":"akretion/docky","owner":"akretion","description":"Docky - Helper for docker-compose mainly used in odoo context","archived":false,"fork":false,"pushed_at":"2024-10-21T14:04:21.000Z","size":384,"stargazers_count":56,"open_issues_count":10,"forks_count":30,"subscribers_count":25,"default_branch":"master","last_synced_at":"2025-03-28T18:14:41.519Z","etag":null,"topics":["devops","docker","docker-compose","docky","odoo"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/akretion.png","metadata":{"files":{"readme":"README.rst","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":"2015-02-03T22:13:58.000Z","updated_at":"2024-10-21T10:37:55.000Z","dependencies_parsed_at":"2025-02-15T13:12:33.792Z","dependency_job_id":"7a6d6ad9-8dc7-4e5a-9d51-b6d99ef53247","html_url":"https://github.com/akretion/docky","commit_stats":{"total_commits":343,"total_committers":19,"mean_commits":18.05263157894737,"dds":"0.34985422740524785","last_synced_commit":"251612b4c306facfc3603fc71f4a0a1bca494cec"},"previous_names":["akretion/voodoo"],"tags_count":45,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akretion%2Fdocky","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akretion%2Fdocky/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akretion%2Fdocky/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akretion%2Fdocky/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/akretion","download_url":"https://codeload.github.com/akretion/docky/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247234921,"owners_count":20905854,"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":["devops","docker","docker-compose","docky","odoo"],"created_at":"2024-09-24T19:54:30.399Z","updated_at":"2025-04-04T19:11:32.506Z","avatar_url":"https://github.com/akretion.png","language":"Python","readme":"Introduction\n=================\n\ndocky is a dev tool to set up and run multiple odoo projects.\n\n\nHistory \u0026 motivation\n--------------------\n\nThis project was initially created for building Odoo environments without effort based on docker-compose and docker.\n\n\nMain features\n---------------\n\nSimplify docker-compose CLI with few short cuts.\n\n\nRequirements\n------------\n\ndocker-ce : https://docs.docker.com/install/ (or podman)\n\n\nInstallation\n------------\n\nDocky is available from pypi\n\n.. code-block:: shell\n\n    pip install docky\n    # or with pipx : pipx install docky --include-deps\n\n\nUpdate Docky\n-------------\n\n.. code-block:: shell\n\n    pip install docky --upgrade\n    # or with pipx : pipx upgrade docky --include-deps\n\n\nUsage: labels\n-------------\n\nThe label docky.main.service and docky.user\n\n.. code-block:: shell\n\n    docky.main.service: odoo\n    docky.user: odoo\n\nAllows you to define the main service of your docker-compose.yml file, and to specify the command line user for the container when you run for example 'docky run'.\n\n\nUsage: recommendations\n----------------------\n\n* Use `ak \u003chttps://github.com/akretion/ak\u003e`_ to build your project.\n* When developing, if you are on several projects at once, it quickly becomes a mess to manage different ports of your containers. We recommend usage of Traefik. Here is an example docker-compose.yml file for local development purposes:\n\n.. code-block:: yaml\n\n    version: \"3.7\"\n    services:\n        traefik:\n        image: \"traefik:v2.1\"\n        restart: always\n        container_name: \"traefik\"\n        command:\n            - \"--api.insecure=true\"\n            - \"--providers.docker=true\"\n            - \"--providers.docker.exposedbydefault=false\"\n            - \"--entrypoints.web.address=:80\"\n        ports:\n            - \"127.0.0.1:80:80\"\n            - \"127.0.0.1:8080:8080\"\n        volumes:\n            - \"/var/run/docker.sock:/var/run/docker.sock:ro\"\n        networks:\n        - traefik\n\n    networks:\n        traefik:\n            name: traefik\n\nMore info about Traefik config on this repo: https://github.com/akretion/traefik-template\n\n\nTroubleshooting\n---------------\n\nTo avoid issues with line wrapping with \"docky open\" please use a version of docker \u003e to  18.06.0-ce\nsee : https://github.com/docker/compose/issues/6151\n\n\nChangelog\n----------\nversion 9.0.0\n- Migration from docker-compose to docker compose\n\nversion 8.0.0\n- remove docky init\n\nversion 7.0.7\n- update copier depency\n- adapt readme\n\nversion 7.0.6\n- update copier dep to 6.0.0a9\n- remove dead code (old template)\n\nversion 7.0.5\n- fix requirements.txt\n\nversion 7.0.4\n- use `copier` for managing the template\n- drop python 3.5 support\n\nversion 7.0.0\n\n- remove the need of docky config file in $HOME\n- use .env to be more compatible with docker-compose\n- improve templates\n- create init command\n- heavy refactoring\n\n\nversion 6.0.0\n\n- refactor remove proxy code and use traefik\n- remove docky.yml now you must use labels on services (see doc)\n- add option \"--service=myservice\" on docky run and docky open\n\nversion 5.0.0:\n\n- Resolve mac compatibility by remove proxy code that use a mounted version of etc/hosts\n  now you need to install dnsmasq.\n  This should also solve windows compatibilty by using the local dns https://stackoverflow.com/questions/138162/wildcards-in-a-windows-hosts-file?answertab=votes#tab-top\n- Solve issue with project name in multi user env (the name is based on user + directory name)\n- Add possibility to specify the service for run, open, logs, kill, down, restart, start cmd\n  for example now you can do \"docky open db\" to open a terminal on the db server\n  or you can restart a service like \"docky restart varnish\"\n- Solve issue with missing aliases name\n- Solve issue with missing environment variable with docky open (now we use a monkey-pacthed version of docker-compose exec)\n- Fix documentation build\n- Improve docky none specific cmd to a project to be run without project.\n  For example, you can use docky help, docky proxy outside of a directory project\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakretion%2Fdocky","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fakretion%2Fdocky","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakretion%2Fdocky/lists"}