Skip to content

Commit 9eca8fe

Browse files
committed
Update docs
1 parent 62de191 commit 9eca8fe

2 files changed

Lines changed: 32 additions & 2 deletions

File tree

.github/workflows/docker-image.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@ name: Docker Image CI
22

33
on:
44
push:
5-
tags:
6-
- 'v*.*.*'
5+
branches: [ master ]
76

87
jobs:
98

docs/docker.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Docker
2+
3+
The application is available as a Docker image too, and can be used in 2 ways:
4+
5+
## Build image locally
6+
7+
You can build the image locally in your development environment, by using the **Docker** files in the project root.
8+
9+
To build the docker image you can execute the following command:
10+
11+
```bash
12+
docker build --network=host -t devaslanphp/helper:latest .
13+
```
14+
15+
After the image is created in your docker, you can use the following command to construct your docker container:
16+
17+
```bash
18+
docker-compose up -d
19+
```
20+
21+
This will create a docker container for you in a daemon mode.
22+
23+
> This command uses the file `docker-compose.yml` existing in the project root folder, so before executing the `docker-compose` you need to update the environment variable in this folder.
24+
25+
## Use the Docker hub image
26+
27+
You can use the docker hub image instead of building the image locally [https://hub.docker.com/r/eloufirhatim/helper](https://hub.docker.com/r/eloufirhatim/helper).
28+
29+
> You can refer to the `docker-compose.yml` file to have an example how to use the hub image instead of the local image
30+
31+
> Important: The docker hub image is pushed automatically after a new release tag is created in the repository

0 commit comments

Comments
 (0)