You've already forked watchtower
							
							
				mirror of
				https://github.com/containrrr/watchtower.git
				synced 2025-10-31 00:17:44 +02:00 
			
		
		
		
	docs: fix more auto-format casualties (#943)
This commit is contained in:
		
							
								
								
									
										6
									
								
								.github/workflows/publish-docs.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										6
									
								
								.github/workflows/publish-docs.yml
									
									
									
									
										vendored
									
									
								
							| @@ -25,9 +25,3 @@ jobs: | |||||||
|             md-toc |             md-toc | ||||||
|       - name: Generate docs |       - name: Generate docs | ||||||
|         run: mkdocs gh-deploy --strict |         run: mkdocs gh-deploy --strict | ||||||
| #      - name: Publish docs |  | ||||||
| #        uses: peaceiris/actions-gh-pages@v3 |  | ||||||
| #        with: |  | ||||||
| #          github_token: ${{ secrets.GITHUB_TOKEN }} |  | ||||||
| #          publish_dir: ./site |  | ||||||
|  |  | ||||||
|   | |||||||
| @@ -1,5 +1,5 @@ | |||||||
| <p style="text-align: center; margin-left: 1.6rem;"> | <p style="text-align: center; margin-left: 1.6rem;"> | ||||||
|   <img src="./images/logo-450px.png" width="450" /> |   <img alt="Logotype depicting a lighthouse" src="./images/logo-450px.png" width="450" /> | ||||||
| </p> | </p> | ||||||
| <h1 align="center"> | <h1 align="center"> | ||||||
|   Watchtower |   Watchtower | ||||||
| @@ -48,13 +48,15 @@ and restart it with the same options that were used when it was deployed initial | |||||||
| the following command: | the following command: | ||||||
|  |  | ||||||
| === "docker run" | === "docker run" | ||||||
| ```bash $ docker run -d \ |     ```bash | ||||||
|  |     $ docker run -d \ | ||||||
|     --name watchtower \ |     --name watchtower \ | ||||||
|     -v /var/run/docker.sock:/var/run/docker.sock \ |     -v /var/run/docker.sock:/var/run/docker.sock \ | ||||||
|     containrrr/watchtower |     containrrr/watchtower | ||||||
|     ``` |     ``` | ||||||
| === "docker-compose.yml" | === "docker-compose.yml" | ||||||
| ```yaml version: "3" |     ```yaml | ||||||
|  |     version: "3" | ||||||
|     services: |     services: | ||||||
|     watchtower: |     watchtower: | ||||||
|     image: containrrr/watchtower volumes: |     image: containrrr/watchtower volumes: | ||||||
|   | |||||||
| @@ -31,13 +31,16 @@ These labels can be declared as instructions in a Dockerfile (with some example | |||||||
| the `docker run` command line: | the `docker run` command line: | ||||||
|  |  | ||||||
| === "Dockerfile" | === "Dockerfile" | ||||||
| ```docker LABEL com.centurylinklabs.watchtower.lifecycle.pre-check="/sync.sh" |     ```docker  | ||||||
|  |     LABEL com.centurylinklabs.watchtower.lifecycle.pre-check="/sync.sh" | ||||||
|     LABEL com.centurylinklabs.watchtower.lifecycle.pre-update="/dump-data.sh" |     LABEL com.centurylinklabs.watchtower.lifecycle.pre-update="/dump-data.sh" | ||||||
|     LABEL com.centurylinklabs.watchtower.lifecycle.post-update="/restore-data.sh" |     LABEL com.centurylinklabs.watchtower.lifecycle.post-update="/restore-data.sh" | ||||||
|     LABEL com.centurylinklabs.watchtower.lifecycle.post-check="/send-heartbeat.sh" |     LABEL com.centurylinklabs.watchtower.lifecycle.post-check="/send-heartbeat.sh" | ||||||
|     ``` |     ``` | ||||||
|  |  | ||||||
| === "docker run" | === "docker run" | ||||||
| ```bash docker run -d \ |     ```bash  | ||||||
|  |     docker run -d \ | ||||||
|     --label=com.centurylinklabs.watchtower.lifecycle.pre-check="/sync.sh" \ |     --label=com.centurylinklabs.watchtower.lifecycle.pre-check="/sync.sh" \ | ||||||
|     --label=com.centurylinklabs.watchtower.lifecycle.pre-update="/dump-data.sh" \ |     --label=com.centurylinklabs.watchtower.lifecycle.pre-update="/dump-data.sh" \ | ||||||
|     --label=com.centurylinklabs.watchtower.lifecycle.post-update="/restore-data.sh" \ |     --label=com.centurylinklabs.watchtower.lifecycle.post-update="/restore-data.sh" \ | ||||||
|   | |||||||
| @@ -103,7 +103,6 @@ Use the dockerfile below to build the [amazon-ecr-credential-helper](https://git | |||||||
| in a volume that may be mounted onto your watchtower container. | in a volume that may be mounted onto your watchtower container. | ||||||
|  |  | ||||||
| 1.  Create the Dockerfile (contents below): | 1.  Create the Dockerfile (contents below): | ||||||
|  |  | ||||||
|     ```Dockerfile |     ```Dockerfile | ||||||
|     FROM golang:latest |     FROM golang:latest | ||||||
|      |      | ||||||
| @@ -122,7 +121,6 @@ in a volume that may be mounted onto your watchtower container. | |||||||
|     ``` |     ``` | ||||||
|  |  | ||||||
| 2.  Use the following commands to build the aws-ecr-dock-cred-helper and store it's output in a volume: | 2.  Use the following commands to build the aws-ecr-dock-cred-helper and store it's output in a volume: | ||||||
|  |  | ||||||
|     ```bash |     ```bash | ||||||
|     # Create a volume to store the command (once built) |     # Create a volume to store the command (once built) | ||||||
|     docker volume create helper  |     docker volume create helper  | ||||||
| @@ -131,13 +129,12 @@ in a volume that may be mounted onto your watchtower container. | |||||||
|     docker build -t aws-ecr-dock-cred-helper . |     docker build -t aws-ecr-dock-cred-helper . | ||||||
|      |      | ||||||
|     # Build the command and store it in the new volume in the /go/bin directory. |     # Build the command and store it in the new volume in the /go/bin directory. | ||||||
|    docker run  -d --rm --name aws-cred-helper --volume helper:/go/bin aws-ecr-dock-cred-helper |     docker run  -d --rm --name aws-cred-helper \ | ||||||
|     |       --volume helper:/go/bin aws-ecr-dock-cred-helper | ||||||
|     ``` |     ``` | ||||||
|  |  | ||||||
| 3.  Create a configuration file for docker, and store it in $HOME/.docker/config.json (replace the <AWS_ACCOUNT_ID> | 3.  Create a configuration file for docker, and store it in $HOME/.docker/config.json (replace the <AWS_ACCOUNT_ID> | ||||||
|    placeholders with your AWS Account ID): |    placeholders with your AWS Account ID): | ||||||
|  |  | ||||||
|     ```json |     ```json | ||||||
|     { |     { | ||||||
|        "credsStore" : "ecr-login", |        "credsStore" : "ecr-login", | ||||||
| @@ -154,7 +151,6 @@ in a volume that may be mounted onto your watchtower container. | |||||||
|     ``` |     ``` | ||||||
|  |  | ||||||
| 4.  Create a docker-compose file (as an example) to help launch the container: | 4.  Create a docker-compose file (as an example) to help launch the container: | ||||||
|   |  | ||||||
|     ```yaml |     ```yaml | ||||||
|     version: "3.4" |     version: "3.4" | ||||||
|     services: |     services: | ||||||
|   | |||||||
		Reference in New Issue
	
	Block a user