From 0d9d1dcf421c80242bf6ae7afb1e111ba360bb66 Mon Sep 17 00:00:00 2001 From: Revant Nandgaonkar Date: Tue, 5 May 2020 13:12:25 +0530 Subject: [PATCH 1/3] [skip travis] Update README --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index badb0721..8c93b580 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,16 @@ For docker based development refer to this [README](development/README.md) This repository requires Docker, docker-compose and Git to be setup on the instance to be used. +Always use non-root user. Add the user to `docker` group instead of using `sudo docker...` commands. + +Docker devop basics. + +- `docker ps`, check running containers. +- `docker logs `, check logs of given container. +- `docker run -it image/tag -v ./volume:/location/in/container --network existing_network` start a container with given image, run command, mount volume and use network. +- `docker exec -it -e "ENVIRONMENT_VARIABLE=VALUE" command`, execute command in existing container and use given environment variables. +- Other important docker commands to manage volumes, containers. Refer Docker documentation. + ### Cloning the repository and preliminary steps Clone this repository somewhere in your system: @@ -38,7 +48,7 @@ cp env-example .env ### Setup Environment Variables -To get started, copy the existing `env-example` file to `.env` inside the `installation` directory. By default, the file will contain the following variables: +To get started, copy the existing `env-example` file to `.env`. By default, the file will contain the following variables: - `VERSION=edge` - In this case, `edge` corresponds to `develop`. To setup any other version, you may use the branch name or version specific tags. (eg. version-12, v11.1.15, v11) @@ -53,12 +63,16 @@ To get started, copy the existing `env-example` file to `.env` inside the `insta - `LETSENCRYPT_EMAIL=your.email@your.domain.com` - Email for LetsEncrypt expiry notification. This is only required if you are setting up LetsEncrypt. +Notes: + +- docker-compose-erpnext.yml and docker-compose-frappe.yml set `AUTO_MIGRATE` environment variable to `1`. +- `AUTO_MIGRATE` checks if there is semver bump or git hash change in case of develop branch and automatically migrates the sites on container start up. +- It is good practice to tag version to specific version instead of latest. e.g `frappe-socketio:v12.5.1`, `erpnext-nginx:v12.7.1`. ### Local deployment for testing For trying out locally or to develop apps using ERPNext REST API port 80 must be published. -The first command will start the containers; the second command will publish the port of the *-nginx container. - +Following command will start the needed containers and expose ports. For Erpnext: From 33672e09e4ee44336549c43cbee40bbced8b79db Mon Sep 17 00:00:00 2001 From: Revant Nandgaonkar Date: Tue, 5 May 2020 13:18:36 +0530 Subject: [PATCH 2/3] [skip travis] Update README --- README.md | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/README.md b/README.md index 8c93b580..d35412e9 100644 --- a/README.md +++ b/README.md @@ -21,15 +21,7 @@ For docker based development refer to this [README](development/README.md) This repository requires Docker, docker-compose and Git to be setup on the instance to be used. -Always use non-root user. Add the user to `docker` group instead of using `sudo docker...` commands. - -Docker devop basics. - -- `docker ps`, check running containers. -- `docker logs `, check logs of given container. -- `docker run -it image/tag -v ./volume:/location/in/container --network existing_network` start a container with given image, run command, mount volume and use network. -- `docker exec -it -e "ENVIRONMENT_VARIABLE=VALUE" command`, execute command in existing container and use given environment variables. -- Other important docker commands to manage volumes, containers. Refer Docker documentation. +Docker basics and best practices. Refer Docker documentation. ### Cloning the repository and preliminary steps From 2fe9826f643d43028efefbb5a58f410f3ab13e95 Mon Sep 17 00:00:00 2001 From: Revant Nandgaonkar Date: Tue, 5 May 2020 13:20:07 +0530 Subject: [PATCH 3/3] [skip travis] Update README fix sentence to avoid version/tag confusion --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d35412e9..91290450 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ Notes: - docker-compose-erpnext.yml and docker-compose-frappe.yml set `AUTO_MIGRATE` environment variable to `1`. - `AUTO_MIGRATE` checks if there is semver bump or git hash change in case of develop branch and automatically migrates the sites on container start up. -- It is good practice to tag version to specific version instead of latest. e.g `frappe-socketio:v12.5.1`, `erpnext-nginx:v12.7.1`. +- It is good practice to use image tag for specific version instead of latest. e.g `frappe-socketio:v12.5.1`, `erpnext-nginx:v12.7.1`. ### Local deployment for testing