Skip to content

Commit c5d5de3

Browse files
committed
docs(README): update README to document recent changes
1 parent e094d7f commit c5d5de3

1 file changed

Lines changed: 16 additions & 6 deletions

File tree

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ bulckan will show in the logs all the steps to deploy the compose file. It will
1919

2020
bulckan only monitors changes in the specified path and will only update the configuration of the docker compose file. It does not monitor if the images have been updated, use [Watchtower](https://containrrr.dev/watchtower/?ref=selfh.st) for that by deploying it with bulckan or implement a workflow that changes the image version in the compose when the image is rebuilt.
2121

22-
Note: To test the functionality, it is possible to deploy bulckan as configured. The application points to a branch of the same repository with the Docker Compose files needed to deploy an Apache container.
22+
Note: To test the functionality, it is possible to deploy bulckan as configured. The application points to a branch of the same repository that contains the [compose files](https://github.com/dockopslab/bulckan/tree/example/bulckan-target) needed to deploy one or more Apache containers.
2323

2424
## Configuration
2525
First, clone this repository and navigate to the project directory:
@@ -29,7 +29,7 @@ git clone https://github.com/dockopslab/bulckan.git
2929
cd bulckan
3030
```
3131

32-
Configure the ``.env`` file to access the repository, branch and path where the docker-compose.yml file you want to deploy and maintain with this tool is located:
32+
Configure the ``.env`` file to access the repository, branch and path where the compose file you want to deploy and maintain with this tool is located:
3333

3434
```
3535
GITHUB_URL=github.com/dockopslab/bulckan.git
@@ -96,19 +96,29 @@ By adding the following tags to the target application's compose file, informati
9696
- "bulckan.deploy.last_commit=${LAST_COMMIT}"
9797
```
9898

99+
See an example in this [compose file](https://github.com/dockopslab/bulckan/blob/example/bulckan-target/sample/docker-compose.yml).
100+
99101
# Multiple deployment configuration
100102

101103
bulckan can be deployed multiple times, so it can point to different repositories and keep different applications updated and deployed at the same time.
102104

103-
Configure .git.env file if necessary:
105+
If necessary, configure the ``.git.env`` file:
104106
```
105107
GITHUB_USERNAME=
106108
GITHUB_TOKEN=
107109
```
108110

109-
Configure environment variables in docker-compose.example.yml:
111+
Configure environment variables in ``compose.example.yml``:
110112
```
111-
version: '3.8'
113+
name: 'bulckan-example'
114+
115+
networks:
116+
bulckan:
117+
118+
volumes:
119+
repo1:
120+
repo2:
121+
repo3:
112122
113123
services:
114124
bulckan1:
@@ -141,7 +151,7 @@ services:
141151
bulckan deployment:
142152

143153
```
144-
docker-compose -f docker-compose.example.yml up -d
154+
docker-compose -f compose.example.yml up -d
145155
```
146156

147157
Note: Before deploying multiple docker-compose.yml with Bulckan, it is necessary to check for possible incompatibilities. Errors due to duplication of exposed ports, service names, networks, and others must be corrected before deployment.

0 commit comments

Comments
 (0)