epistemophiliac/frappe_docker
1
0
Fork 0
mirror of https://github.com/frappe/frappe_docker.git synced 2026-06-17 13:55:08 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
Docker environment for developing, deploying, and running Frappe applications (ERPNext and custom apps) in production and development
144 commits 1 branch 14 tags 111 MiB
Python 45.2%
Dockerfile 37.6%
Shell 11.3%
HCL 5.9%
Find a file
Mendel Greenberg 33b8dfea70
some refractoring
2019-02-25 23:36:48 -05:00
conf some more slight name changes 2019-02-25 23:36:22 -05:00
frappe-bench Added bench init , start and python tests to curl the site 2017-10-02 09:48:47 +05:30
.dockerignore added a .dockerignore and fixed the dockerfile up a bit 2019-02-25 23:36:23 -05:00
.gitignore added a .gitignore 2019-02-25 23:36:23 -05:00
.travis.yml Updating travis' docker and compose 2019-02-25 23:36:23 -05:00
dbench some refractoring 2019-02-25 23:36:48 -05:00
docker-compose.yml some more slight name changes 2019-02-25 23:36:22 -05:00
Dockerfile some refractoring 2019-02-25 23:36:48 -05:00
LICENSE.md Rename LICENSE to LICENSE.md 2017-10-02 09:48:51 +05:30
README.md Changed the readme significantly 2019-02-25 23:36:22 -05:00
test.py changed test.py to avoid naming errors 2019-02-25 23:36:22 -05:00

README.md

Frappe on Docker

Build Status

This is a repo designed to aide setting up frappe/ERPNext on docker.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. Unfortunetly, this container is not curently suited for a production enviorment.

1. Installation Pre-requisites

  • Install Docker Community Edition

  • Install Docker Compose (only for Linux users. Docker for Mac, Docker for Windows, and Docker Toolbox already include Docker Compose).

2. Build the container and initialize the bench

  1. Clone this repo and change your working directory to frappe_docker

    git clone https://github.com/frappe/frappe_docker.git
cd frappe_docker

  2. Build and start the container, and initialize the bench

    ./dbench setup docker
./dbench init

    Note: This will take a while, as docker will now build the container.

  3. Add a new site and start frappe

    ./dbench new-site site1.local
./dbench setup hosts
./dbench start

  4. To use frappe: Open your browser to localhost:8000.
    Username: Administrator Password: admin

Basic Usage*

  • ./dbench: Launches you into an interactive shell in the container as user frappe

  • ./dbench setup docker [ stop | down ]: Starts and builds the docker containers using docker-compose up -d

  • ./dbench setup hosts: Adds all sites to the containers hosts file.
    Do this after you've added a new site to avoid errors.

  • ./dbench -c frappe | root <command to run>: Runs a command in the container, as the selected user

  • ./dbench -h: Shows this help message

  • ./dbench <bench command>: Runs a command in bench, (Running ./dbench new-site site1.local will run in the conatiner as bench new-site site1.local)

*Always make sure that your current directory is the root directory of the repo (i.e. frappe_docker/)

For more info on building this docker container refer to this Wiki

Contributing

Feel free to contribute to this project and make the container better

License

This project is licensed under the MIT License - see the LICENSE.md file for details