mirror of
https://github.com/frappe/frappe_docker.git
synced 2026-06-23 00:05:09 +00:00
Updated readme
This commit is contained in:
chabad360
parent
78ac80d54a
commit
ae0e89b1a8
1 changed files with 34 additions and 28 deletions
56
README.md
56
README.md
|
|
@ -1,5 +1,8 @@
|
|||
# frappe_docker
|
||||
[](https://travis-ci.org/frappe/frappe_docker)
|
||||
|
||||
| `latest` | `env` | `frappe-dev` |
|
||||
|:--------:|:-----:|:------------:|
|
||||
| [](https://travis-ci.org/frappe/frappe_docker) | [](https://travis-ci.org/frappe/frappe_docker) |[](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.
|
||||
|
||||
|
|
@ -19,9 +22,9 @@ These instructions will get you a copy of the project up and running on your loc
|
|||
|
||||
### Container Configuration
|
||||
|
||||
#### ports:
|
||||
#### Ports
|
||||
|
||||
```
|
||||
```bash
|
||||
ports:
|
||||
- "3307:3307" mariadb-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.
|
||||
|
||||
#### volumes:
|
||||
#### Volumes
|
||||
|
||||
```
|
||||
```bash
|
||||
volumes:
|
||||
- ./frappe-bench:/home/frappe/frappe-bench
|
||||
- ./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_cache.conf:/etc/conf.d/redis.conf
|
||||
```
|
||||
|
||||
Exposes a directory inside the host to the container.
|
||||
|
||||
#### links:
|
||||
#### Links
|
||||
|
||||
```
|
||||
```bash
|
||||
links:
|
||||
- redis-cache
|
||||
- redis-queue
|
||||
|
|
@ -58,15 +62,16 @@ links:
|
|||
|
||||
Links allow you to define extra aliases by which a service is reachable from another service.
|
||||
|
||||
#### depends_on:
|
||||
#### Depends_on
|
||||
|
||||
```
|
||||
```bash
|
||||
depends_on:
|
||||
- mariadb
|
||||
- redis-cache
|
||||
- redis-queue
|
||||
- redis-socketio
|
||||
```
|
||||
|
||||
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.
|
||||
|
|
@ -83,38 +88,39 @@ Express dependency between services, which has two effects:
|
|||
|
||||
#### 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
|
||||
cd frappe_docker
|
||||
git clone --depth 1 https://github.com/frappe/frappe_docker.git
|
||||
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
|
||||
|
||||
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)
|
||||
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)
|
||||
|
||||
Note: Please do not remove the bench-repo directory the above commands will create
|
||||
|
||||
|
||||
|
||||
#### Basic Usage
|
||||
|
||||
##### Make sure your current directory is frappe_docker
|
||||
1. First time setup
|
||||
|
||||
1.First time setup
|
||||
|
||||
./dbench --init
|
||||
|
||||
2. Command to start all the containers
|
||||
2.Command to start all the containers
|
||||
|
||||
./dbench --start
|
||||
./dbench --start
|
||||
|
||||
4. Command to enter your container
|
||||
4.Command to enter your container
|
||||
|
||||
./dbench
|
||||
./dbench
|
||||
|
||||
5. All bench commands can also be directly run from the host machine by using `dbench`. For instance `bench start` can be executed by running `./dbench -c start`. Just preface the option with `./dbench -c`. For more information on `dbench` run the command `./dbench -h`.
|
||||
5.All bench commands can also be directly run from the host machine by using `dbench`. For instance `bench start` can be executed by running `./dbench -c start`. Just preface the option with `./dbench -c`. For more information on `dbench` run the command `./dbench -h`.
|
||||
|
||||
For more info on how to build this docker container refer to this [Wiki](https://github.com/chabad360/frappe_docker/wiki/Hitchhiker's-guide-to-building-this-frappe_docker-image)
|
||||
|
||||
|
|
@ -124,7 +130,7 @@ The default username is "Administrator" and password is what you set when you cr
|
|||
|
||||
## Built With
|
||||
|
||||
* [Docker](https://www.docker.com/)
|
||||
- [Docker](https://www.docker.com/)
|
||||
|
||||
## Contributing
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue