[{"_1":2,"_161":-5,"_162":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_140":141},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":-5,"_89":90,"_129":-5,"_130":11,"_131":21,"_132":11,"_133":-5,"_134":11,"_135":-5,"_136":137,"_138":91,"_139":-7},"canonicalUrl","https://hub.docker.com/r/stratosgear/livereloading/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","stratosgear","reponame","livereloading","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":11,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2020-03-26T17:23:58.77278Z","description","Docker-compose livereloading service based on docker labels","is_private","last_updated","2020-03-27T00:20:49.82628Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",307,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","[![forthebadge](https://forthebadge.com/images/badges/built-with-grammas-recipe.svg)](https://forthebadge.com)\n\n# Docker Compose Live Reloader\n\nThis docker-compose pattern, aims to provide plug and play live reloading functionality\nto docker-compose stacks.\n\nA simple use case scenario for using this is the following:\n\nYou have a stack of a web proxy, web server and a database all together containerized\nand configured as services in docker-compose for easy deployment. To develop locally,\nyou make the changes and run `docker-compose up` to inspect what has changed. You\nrealise that you have do make additional changes but now you need to restart\ndocker-compose to see them in effect. This procedure is conducted many times in a normal\nsoftware develpment lifecycle and in the long term it can be time-consuming and\nfrustrating. I know that often development servers have auto reloading functionality out\nof the box if you mount the code instead of copying it in the docker container, however,\nI often find myself needing to have auto reload on commands that do not really have auto\nreloading. \n\nWith the livereloader docker image you can easily instrument your docker compose service\nto be restarted when there are any new file modifications. What is more, the file\nwatching is configurable such that you can control the delay to wait for reload and the\npatterns that reloading should react to (WIP).\n\nFollow the next sections to find more details about this and how to get started using\nit.\n\n# Getting Started\n\nIt is very simple to get started with the docker-compose live reloader. First things\nfirst, you need to have a docker compose file. The concept is to create a new local\ndocker-compose file which extends your existing one and just adds one the reloader\nservice to your stack. \n\nThe reloading functionality was written as a separate container such that the changes\nrequired in order to get started using it are minimal. With this in mind, you can easily\nseparate the local docker-compose files which contain live reloading from automatically\ndeployed environments. \n\n## How to enable reloading\n\n1. Create a new docker-compose yaml file i.e. `docker-compose-with-reloading.yml` and\n add the following\"\n\n```yml\nversion: '3'\n\nservices:\n\n live-reloader:\n image: apogiatzis/livereloading\n container_name: livereloader\n privileged: true\n environment:\n - RELOAD_CONTAINER=\n - RELOAD_LABEL=\n - RELOAD_DELAY= # seconds\n - RESTART_TIMEOUT= # seconds\n - RELOAD_DIR=\n volumes:\n - \"/var/run/docker.sock:/var/run/docker.sock\"\n - \":\"\n```\n\nNote that version 3 is only indicative, you can use your own docker compose version\nnumber.\n\nThe only required parameters in the above docker-compose service are:\n\n* the `RELOAD_DIR` to know which directories to watch\n* either the `RELOAD_CONTAINER` or the `RELOAD_LABEL` variables which give instructions\n of which containers are ought to be reloaded. \n \nThe other variables can be ommited. (More details in the Configuration section below)\n\nIn order for the reloading service to watch for changes you have to mount your source\ncode directory to a directory in the container. If no `RELOAD_DIR` variable was set,\nlivereloader automatically watches for changes in that directory. A more explicit path\ncan be set with `RELOAD_DIR`\n\n1. Ensure that the code's directory is mounted to your service container as well. (If\n not mounted, reloading will work but code changes will not be applied to restarted\n container)\n\nAssuming that you don't have the source code mounted already and container name is\ndifferently you can add the following in your new docker-compose file to override it.\ni.e:\n\n```yml\nversion: '3'\n\nservices:\n ...\n service-name:\n container_name: \n volumes:\n - \":\"\n ...\n```\n3. Run your docker compose with live reloading using the following command:\n\n`docker-compose -f docker-compose.yml -f docker-compose-with-reloading.yml up`\n\n## Example\n\nThe files for this example are in the `test/` folder of this repository.\n\nConsidering that you have the following docker-compose.yml file:\n\n```yml\nversion: '3'\n\nservices:\n\n test-service:\n image: ubuntu\n volumes:\n - \".:/code\"\n working_dir: \"/code\"\n command: ./command.sh\n```\n\nWhere `command.sh` is just a simulation of a running service:\n\n```bash\n#!/bin/bash\nwhile true ; do\n echo \"Alive!\" ; sleep 2\n done\n```\n\nYou should create a new `docker-compose-with-reloading.yml` file and add the following:\n\n```yml\nversion: '3'\n\nservices:\n test-service:\n image: ubuntu\n container_name: test-container-name \n\n live-reloader:\n image: apogiatzis/livereloading\n container_name: livereloader\n privileged: true\n environment:\n - RELOAD_DELAY=1.5 # seconds\n - RELOAD_CONTAINER=test-container-name\n volumes:\n - \"/var/run/docker.sock:/var/run/docker.sock\"\n - \".:/code\"\n```\n\nRun the docker-compose with reloading with this command:\n```\ndocker-compose -f docker-compose.yml -f docker-compose-with-reloading.yml up\n```\n\n# Reloading Configration \n\nThe reloading can be configured from the environment variables of the `livereloader`\ndocker-compoe service. Here is a list of the available configuration variables:\n\n- **RELOAD_CONTAINER**: The container name to target for reloading. (Required: False,\n but this or **RELOAD_LABEL** must be set if any containers are to be restarted)\n- **RELOAD_LABEL**: A container label name. All containers with that label name will be\n restarted. (Required: False, but this or **RELOAD_CONTAINER** must be set if any\n containers are to be restarted)\n- **RELOAD_DELAY**: The number of seconds to wait before restarting the container\n (Required: False, Default: 1.5s)\n- **RESTART_TIMEOUT**: The timeout period in seconds to wait for the container to\n restart. (Requied: False, Default: 10, same as the default timeout of Docker)\n- **RELOAD_DIR**: The directory or directories to monitor for changes (multiple\n directories can be supplied, comma-separated). (Required: True)\n\n\n# Contribute\n\nFeel free to open any issues and suggest improvements.","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":21,"_83":11,"_84":11},"read","write","admin","user","storage_size",474869679,"orgData","recentTags",[91],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":66,"_128":21},"content_type","creator",131439,"full_size",474822330,"id",92466595,"images",[101],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":66,"_117":-5},"architecture","amd64","digest","sha256:6191c54cf071272869e771c4912021be256100d60f1489f221f4b488c0cc036d","features","","last_pulled","2026-09-25T11:20:41.873227504Z","last_pushed","2020-03-27T00:20:50Z","os","linux","os_features","os_version","size","variant","2020-03-27T00:20:49.456049Z","last_updater","last_updater_username","media_type","latest","repository",8716662,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":142,"_149":150,"_136":159,"_160":11},{"_40":143,"_42":144,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":145,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":146,"_79":11,"_80":148,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":147},[78],{"_82":21,"_83":11,"_84":11},"tags",{"_151":64,"_152":-5,"_153":-5,"_154":155},"count","next","previous","results",[156],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":157,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":66,"_128":21},[158],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":66,"_117":-5},[],"canDeleteTags","actionData","errors"]

stratosgear/livereloading

Tags for stratosgear/livereloading