Updated readme

This commit is contained in:
chabad360 2018-08-02 11:31:58 -07:00
parent 78ac80d54a
commit ae0e89b1a8

View file

@ -1,5 +1,8 @@
# frappe_docker # frappe_docker
[![Build Status](https://travis-ci.org/chabad360/frappe_docker.svg?branch=master)](https://travis-ci.org/frappe/frappe_docker)
| `latest` | `env` | `frappe-dev` |
|:--------:|:-----:|:------------:|
| [![Build Status](https://travis-ci.org/chabad360/frappe_docker.svg?branch=frappe)](https://travis-ci.org/frappe/frappe_docker) | [![Build Status](https://travis-ci.org/chabad360/frappe_docker.svg?branch=master)](https://travis-ci.org/frappe/frappe_docker) |[![Build Status](https://travis-ci.org/chabad360/frappe_docker.svg?branch=frappe-dev)](https://travis-ci.org/frappe/frappe_docker) |
- [Docker](https://docker.com/) is an open source project to pack, ship and run any Linux application in a lighter weight, faster container than a traditional virtual machine. - [Docker](https://docker.com/) is an open source project to pack, ship and run any Linux application in a lighter weight, faster container than a traditional virtual machine.
@ -19,9 +22,9 @@ These instructions will get you a copy of the project up and running on your loc
### Container Configuration ### Container Configuration
#### ports: #### Ports
``` ```bash
ports: ports:
- "3307:3307" mariadb-port - "3307:3307" mariadb-port
- "8000:8000" webserver-port - "8000:8000" webserver-port
@ -34,9 +37,9 @@ ports:
Expose port 3307 inside the container on port 3307 on ALL local host interfaces. In order to bind to only one interface, you may specify the host's IP address as `([<host_interface>:[host_port]])|(<host_port>):<container_port>[/udp]` as defined in the [docker port binding documentation](http://docs.docker.com/userguide/dockerlinks/). The port 3307 of the mariadb container and port 8000 of the frappe container is exposed to the host machine and other containers. Expose port 3307 inside the container on port 3307 on ALL local host interfaces. In order to bind to only one interface, you may specify the host's IP address as `([<host_interface>:[host_port]])|(<host_port>):<container_port>[/udp]` as defined in the [docker port binding documentation](http://docs.docker.com/userguide/dockerlinks/). The port 3307 of the mariadb container and port 8000 of the frappe container is exposed to the host machine and other containers.
#### volumes: #### Volumes
``` ```bash
volumes: volumes:
- ./frappe-bench:/home/frappe/frappe-bench - ./frappe-bench:/home/frappe/frappe-bench
- ./conf/mariadb-conf.d:/etc/mysql/conf.d - ./conf/mariadb-conf.d:/etc/mysql/conf.d
@ -44,11 +47,12 @@ volumes:
- ./redis-conf/redis_queue.conf:/etc/conf.d/redis.conf - ./redis-conf/redis_queue.conf:/etc/conf.d/redis.conf
- ./redis-conf/redis_cache.conf:/etc/conf.d/redis.conf - ./redis-conf/redis_cache.conf:/etc/conf.d/redis.conf
``` ```
Exposes a directory inside the host to the container. Exposes a directory inside the host to the container.
#### links: #### Links
``` ```bash
links: links:
- redis-cache - redis-cache
- redis-queue - redis-queue
@ -58,15 +62,16 @@ links:
Links allow you to define extra aliases by which a service is reachable from another service. Links allow you to define extra aliases by which a service is reachable from another service.
#### depends_on: #### Depends_on
``` ```bash
depends_on: depends_on:
- mariadb - mariadb
- redis-cache - redis-cache
- redis-queue - redis-queue
- redis-socketio - redis-socketio
``` ```
Express dependency between services, which has two effects: Express dependency between services, which has two effects:
1. `docker-compose up -d` will start services in dependency order. In the following example, mariadb and redis will be started before frappe. 1. `docker-compose up -d` will start services in dependency order. In the following example, mariadb and redis will be started before frappe.
@ -83,25 +88,26 @@ Express dependency between services, which has two effects:
#### 2. Build the container and install bench #### 2. Build the container and install bench
* Clone this repo and change your working directory to frappe_docker - Clone this repo and change your working directory to frappe_docker
git clone --depth 1 https://github.com/frappe/frappe_docker.git git clone --depth 1 https://github.com/frappe/frappe_docker.git
cd frappe_docker cd frappe_docker
* Build the container and install bench inside the container. - Build the container and install bench inside the container.
1.Build the 5 linked containers frappe, mariadb, redis-cache, redis-queue and redis-socketio using this command. 1. Build and start the 5 linked containers frappe, mariadb, redis-cache, redis-queue and redis-socketio using this command.
./dbench --setup -d ./dbench --setup -d
Make sure your current working directory is frappe_docker which contains the docker-compose.yml and Dockerfile. Make sure your current working directory is frappe_docker which contains the docker-compose.yml and Dockerfile.
It creates a user, frappe inside the frappe container, whose working directory is /home/frappe. It also clones the bench-repo from [here](https://github.com/frappe/bench) It creates a user, frappe inside the frappe container, whose working directory is /home/frappe. It also clones the bench-repo from [here](https://github.com/frappe/bench)
Note: Please do not remove the bench-repo directory the above commands will create Note: Please do not remove the bench-repo directory the above commands will create
#### Basic Usage #### Basic Usage
##### Make sure your current directory is frappe_docker ##### Make sure your current directory is frappe_docker
1.First time setup 1.First time setup
./dbench --init ./dbench --init
@ -124,7 +130,7 @@ The default username is "Administrator" and password is what you set when you cr
## Built With ## Built With
* [Docker](https://www.docker.com/) - [Docker](https://www.docker.com/)
## Contributing ## Contributing