You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jun 7, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: Readme.md
-31Lines changed: 0 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,32 +17,14 @@ You can specify different Env Var to the docker-ci to configure it as you want
17
17
### Basic conf
18
18
|Name|Default|Description|
19
19
|----|----|-----------|
20
-
|`VERBOSE`|`false`|Print all logs to the docker stdout|
21
20
|`PORT`|`3000`|The port for the webhook server and the API in case of use|
22
21
23
-
### Mailing
24
-
You can use add mailing informations, then you will be notified if there is an error when deploying the container
25
-
The mailing conf should be in a mail.json in the `conf` dir at the root
26
-
```jsonc
27
-
{
28
-
"mailing": boolean, //Enable the mailing system
29
-
"mail_host": string, //the host of the mail server, can be an IP or a domain name
30
-
"mail_port": number, //The port of the mail server
31
-
"mail_password": string, //The password for the mail server
32
-
"mail_addr": string, //The sender mail address
33
-
"mail_oauth": boolean, //If the server use a basic auth system or an oauth system
34
-
"client_id": string, //The client id for the oauth system
35
-
"private_key": string, //The private key for the oauth system
36
-
"mail_admin": string, //The admin mail where error alerts will be sent
37
-
}
38
-
```
39
22
## Base configuration :
40
23
This is the default configuration for your container, you just have to add docker-ci.enable and the image url in your docker-compose.yml :
41
24
42
25
|Name|Type|Description|
43
26
|----|----|-----------|
44
27
|`docker-ci.enable`|`boolean`|Enable CI for this container, an endpoint will be created for this container and whenever it will be called the container image will be repulled and the container will be recreated (total update of the container)|
45
-
|`docker-ci.repo-url`|`string`|Url of the image repository (same as what you put in image:)|
46
28
|`docker-ci.name`|`string (Optional)`|Set a custom name for the endpoint, by default it is the name of the container|
47
29
48
30
@@ -64,12 +46,6 @@ If you use Github or Dockerhub to send your webhooks you can protect them, it'll
64
46
|`docker-ci.webhook-callback`|`boolean (Optional)`|Some webhook validation use a callback given in the body of the request (e.g : DockerHub)|
65
47
|`docker-ci.webhook-secret`|`string (Optional)`|Some webhook validation use a secret to encode the body with a HMAC-SHA-256 encryption (e.g : Github)|
66
48
67
-
## Mailing
68
-
If you want to be notified when an error occurs when the container is redeployed you can add a mail
69
-
|Name|Description|
70
-
|----|-----------|
71
-
|`docker-ci.email`|Set a specific user email to be notified only for this user when an error occurs|
72
-
|`docker-ci.email.notify`|Docker-ci will send email notification when container is redeployed|
- "docker-ci.name=automate"#This argument is optional by default it is the name of the container (container_name)
108
83
# The following is only if you use auth to get private package
109
84
- "docker-ci.password=MyPasswordOrToken"#Registry Password or token
110
85
- "docker-ci.username=MyRegistryUsername"
111
86
- "docker-ci.auth-server=MyRegistryURL"#Ex for Github Registry : https://ghcr.io or https://docker.pkg.github.com
112
-
113
-
- "docker-ci.email=prevottheodore@gmail.com"#Notify this email when errors occured when redeploying this container
114
-
- "docker-ci.email.notify=true"#Notify the above email when this container is redeployed
115
87
```
116
88
117
89
### docker-publish in the github repo :
@@ -177,13 +149,10 @@ jobs:
177
149
|Name|Description|
178
150
|----|-----------|
179
151
| `docker-ci.enable`|Enable CI for this container, an endpoint will be created for this container and whenever it will be called the container image will be repulled and the container will be recreated (total update of the container)|
180
-
| `docker-ci.repo-url`|Url of the image repo|
181
152
| `docker-ci.name`|Set a custom name for the endpoint, by default it is the name of the container|
182
153
| `docker-ci.username`|Set a username for the docker package registry auth|
183
154
| `docker-ci.password`|Set a password or a token for the docker package registry auth|
184
155
| `docker-ci.auth-server`|Set an auth server for the docker package registry auth|
185
-
|`docker-ci.email`|Set a specific user email to be notified only for this user when an error occurs|
186
-
|`docker-ci.email.notify`|Notify the above email that the container has been updated|
0 commit comments