Change readme for run (#1028)

adempiere · Aug 7, 2021 · d6e490a · d6e490a
1 parent 44ad352
commit d6e490a
Show file tree

Hide file tree

Showing 2 changed files with 164 additions and 7 deletions.
diff --git a/README.es.md b/README.es.md
@@ -69,18 +69,88 @@ Entendiendo y aprendiendo acerca de lo anterior le ayudará a conocer el proyect
   <img width="900" src="https://wpimg.wallstcn.com/a5894c1b-f6af-456e-82df-1151da0839bf.png">
 </p>
 
-### Para todo el entorno puede descargar las siguientes imágenes:
-- ADempiere gRPC: https://hub.docker.com/r/erpya/adempiere-grpc-all-in-one
+## Corriendo Contenedores de Docker
+
+### Requerimientos Mínimos
+
+Para usar la imagen de Docker debes usar la versión 3.0 o superior de Docker.
+
+Construye la Imagen de docker (solo para desarrollo):
 ```shell
-docker pull erpya/adempiere-grpc-all-in-one
+docker build -t erpya/adempiere-vue:dev -f ./Dockerfile .
 ```
-- Proxy ADempiere API: https://hub.docker.com/r/erpya/proxy-adempiere-api
+
+Descarga de Imagen:
 ```shell
-docker pull erpya/proxy-adempiere-api
+docker pull erpya/adempiere-vue
 ```
-- ADempiere Vue: https://hub.docker.com/r/erpya/adempiere-vue
+
+Ejecución de Contenedor:
 ```shell
-docker pull erpya/adempiere-vue
+docker run -it \
+	--name adempiere-vue \
+	-p 80:80 \
+	-e API_URL="https://api.erpya.com" \
+	erpya/adempiere-vue
+```
+
+
+### Variables de entorno para la configuración
+
+ * `API_URL`: Indica la dirección URL del servidor con el que se comunicará por defecto el cliente web [Proxy-Adempiere-Api](https://github.com/adempiere/proxy-adempiere-api), el valor por defecto es `https://https://api.erpya.com`.
+
+NOTA: Si no cambias los valores de esta variable de entorno, no es necesario indicarlo en el comando `docker run`, por defecto colocará el valor que se encuentra predeterminado.
+
+
+### Corriendo los contenedores con docker-compose:
+
+Facilmente puedes correr el contenedor usando docker-compose con el siguiente comando:
+```shell
+docker-compose up
+```
+
+Salida de la consola:
+```shell
+Building web-client
+Step 1/8 : FROM node:12-alpine
+ ---> 057fa4cc38c2
+Step 2/8 : LABEL maintainer="EdwinBetanc0urt@outlook.com"       description="ADempiere-Vue"
+ ---> Running in d096cf76ce2d
+Removing intermediate container d096cf76ce2d
+ ---> 46cc05704121
+Step 3/8 : ENV RELEASE_VERSION="3.9.3"
+ ---> Running in 9048d159aaf9
+Removing intermediate container 9048d159aaf9
+ ---> a19699234a5d
+Step 4/8 : ENV URL_REPO="https://github.com/adempiere/adempiere-vue"    BINARY_NAME="v$RELEASE_VERSION.zip"     VUE_APP_PROXY_ADDRESS="localhost"       VUE_APP_PROXY_PORT="8989"
+ ---> Running in c703a3818cbf
+Removing intermediate container c703a3818cbf
+ ---> 86b0c2b269c6
+Step 5/8 : RUN mkdir -p /opt/Apps &&    cd /opt/Apps &&         echo "Install needed packages... $BINARY_NAME $RELEASE_VERSION" &&      apk --no-cache add curl unzip &&        curl --output "$BINARY_NAME" -L "$URL_REPO/archive/$BINARY_NAME" &&     unzip -o "$BINARY_NAME" &&      rm "$BINARY_NAME" &&    mv "adempiere-vue-$RELEASE_VERSION" adempiere-vue &&    cd adempiere-vue &&    npm install &&   npm run build:prod
+ ---> Running in 6f3cb21924dd
+Install needed packages... v3.9.3.zip 3.9.3
+fetch http://dl-cdn.alpinelinux.org/alpine/v3.11/main/x86_64/APKINDEX.tar.gz
+fetch http://dl-cdn.alpinelinux.org/alpine/v3.11/community/x86_64/APKINDEX.tar.gz
+(1/5) Installing ca-certificates (20191127-r2)
+(2/5) Installing nghttp2-libs (1.40.0-r1)
+(3/5) Installing libcurl (7.67.0-r0)
+(4/5) Installing curl (7.67.0-r0)
+(5/5) Installing unzip (6.0-r6)
+Executing busybox-1.31.1-r9.trigger
+Executing ca-certificates-20191127-r2.trigger
+OK: 9 MiB in 21 packages
+  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
+                                 Dload  Upload   Total   Spent    Left  Speed
+100   128  100   128    0     0    149      0 --:--:-- --:--:-- --:--:--   149
+100  916k    0  916k    0     0   180k      0 --:--:--  0:00:05 --:--:--  254k
+Archive:  v3.9.3.zip
+1d684b76328e3f6bcd3f75ea011087cce1c13a3c
+   creating: adempiere-vue-3.9.3/
+  inflating: adempiere-vue-3.9.3/.babelrc
+  inflating: adempiere-vue-3.9.3/.editorconfig
+adempiere-ui-client |
+adempiere-ui-client | > Listening at  http://localhost:9526/
+
 ```
 
 ## Patrocinantes

diff --git a/README.md b/README.md
@@ -55,6 +55,7 @@ It is a great UI for [ADempiere ERP, CRM & SCM](https://github.com/adempiere/ade
 
 - [Forked From](https://github.com/PanJiaChen/vue-element-admin)
 
+
 **The current version is `v1.0+` build on `vue-cli`. If you find a problem, please put [issue](https://github.com/adempiere/adempiere-vue/issues/new).**
 
 **This project does not support low version browsers (e.g. IE). Please add polyfill by yourself.**
@@ -84,6 +85,92 @@ docker pull erpya/proxy-adempiere-api
 docker pull erpya/adempiere-vue
 ```
 
+## Run docker container:
+
+### Minimal Docker Requirements
+
+To use this Docker image you must have your Docker engine release number greater
+than or equal to 3.0.
+
+Build docker image (for development only):
+```shell
+docker build -t erpya/adempiere-vue:dev -f ./Dockerfile .
+```
+
+Download docker image:
+```shell
+docker pull erpya/adempiere-vue
+```
+
+Run container container:
+```shell
+docker run -it \
+	--name adempiere-vue \
+	-p 80:80 \
+	-e API_URL="https://api.erpya.com" \
+	erpya/adempiere-vue
+```
+
+
+### Environment variables for the configuration
+
+ * `API_URL`: It indicates the address of the server to which you will point the service [Proxy-Adempiere-Api](https://github.com/adempiere/proxy-adempiere-api), by default its value is `https://https://api.erpya.com`.
+
+NOTE: If you do not change the values of the environment variables, it is not necessary to indicate them in the `docker run` command, since the default values will be set.
+
+
+### Run docker container with docker-compose:
+
+Or easy run container using docker-compose with follow command:
+```shell
+docker-compose up
+```
+
+Terminal output:
+```shell
+Building web-client
+Step 1/8 : FROM node:12-alpine
+ ---> 057fa4cc38c2
+Step 2/8 : LABEL maintainer="EdwinBetanc0urt@outlook.com"       description="ADempiere-Vue"
+ ---> Running in d096cf76ce2d
+Removing intermediate container d096cf76ce2d
+ ---> 46cc05704121
+Step 3/8 : ENV RELEASE_VERSION="3.9.3"
+ ---> Running in 9048d159aaf9
+Removing intermediate container 9048d159aaf9
+ ---> a19699234a5d
+Step 4/8 : ENV URL_REPO="https://github.com/adempiere/adempiere-vue"    BINARY_NAME="v$RELEASE_VERSION.zip"     VUE_APP_PROXY_ADDRESS="localhost"       VUE_APP_PROXY_PORT="8989"
+ ---> Running in c703a3818cbf
+Removing intermediate container c703a3818cbf
+ ---> 86b0c2b269c6
+Step 5/8 : RUN mkdir -p /opt/Apps &&    cd /opt/Apps &&         echo "Install needed packages... $BINARY_NAME $RELEASE_VERSION" &&      apk --no-cache add curl unzip &&        curl --output "$BINARY_NAME" -L "$URL_REPO/archive/$BINARY_NAME" &&     unzip -o "$BINARY_NAME" &&      rm "$BINARY_NAME" &&    mv "adempiere-vue-$RELEASE_VERSION" adempiere-vue &&    cd adempiere-vue &&    npm install &&   npm run build:prod
+ ---> Running in 6f3cb21924dd
+Install needed packages... v3.9.3.zip 3.9.3
+fetch http://dl-cdn.alpinelinux.org/alpine/v3.11/main/x86_64/APKINDEX.tar.gz
+fetch http://dl-cdn.alpinelinux.org/alpine/v3.11/community/x86_64/APKINDEX.tar.gz
+(1/5) Installing ca-certificates (20191127-r2)
+(2/5) Installing nghttp2-libs (1.40.0-r1)
+(3/5) Installing libcurl (7.67.0-r0)
+(4/5) Installing curl (7.67.0-r0)
+(5/5) Installing unzip (6.0-r6)
+Executing busybox-1.31.1-r9.trigger
+Executing ca-certificates-20191127-r2.trigger
+OK: 9 MiB in 21 packages
+  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
+                                 Dload  Upload   Total   Spent    Left  Speed
+100   128  100   128    0     0    149      0 --:--:-- --:--:-- --:--:--   149
+100  916k    0  916k    0     0   180k      0 --:--:--  0:00:05 --:--:--  254k
+Archive:  v3.9.3.zip
+1d684b76328e3f6bcd3f75ea011087cce1c13a3c
+   creating: adempiere-vue-3.9.3/
+  inflating: adempiere-vue-3.9.3/.babelrc
+  inflating: adempiere-vue-3.9.3/.editorconfig
+adempiere-ui-client |
+adempiere-ui-client | > Listening at  http://localhost:9526/
+
+```
+
+
 ## Sponsors
 
 <a href="http://erpya.com/">