2
0
mirror of https://github.com/frappe/frappe_docker.git synced 2024-11-09 23:00:56 +00:00
frappe_docker/README.md
chabad360 acee24b577 refactor: dockerfile
* testing replacement for dbench

* fixed perm issue and added docker control

* fixes and tests

fixed travis test, and perm issue

* auto add permissions

* bench setup anything-else should work now

* removed adding site names to host (its pointless)

* moved redis configuration folder into conf/

* added a docker down feature to dbench and changed some of the docs

* hopefully should fix the args issue

* Condensed Dockerfile

Updated to latest node, and uses python-pip, also condensed a lot the Dockerfile.

* Removed extra line

* Removed MAINTAINER in favor of LABEL

* all installs are in one apt command

* Switch bench to dbench, added -s feature of dbench to bench. updated
Docker file with sudo and vim, and setup travis to run with said changes

* dockerfile: clean up (#52)

* Condensed Dockerfile

Updated to latest node, and uses python-pip, also condensed a lot the Dockerfile.

* fixed travis, and cleaned up dbench a little

* Oops...

* oops, but only for travis, this runs fine

* Travis!

* added help to dbench, and updated readme

* changes some of the wording of the help message

* dbench: fix init issues (#55)

./dbench init would lead to 'missing argument: PATH' issue (#54), and could not find Procfile_docker and site-config.

Signed-off-by: Chinmay Pai <chinmaydpai@gmail.com>

* bench setup anything-else should work now

* Clean cache to get a smaller image (#57)

Please include this commit to decrease the size of the docker image, the "rm -rf /var/lib/apt/lists/*" it is not usefull if it is not used in the same stage of the apt-get install RUN, similar with pip cache.

References:
 - https://linux.die.net/man/8/apt-get
 - https://stackoverflow.com/questions/9510474/removing-pips-cache
 - https://semaphoreci.com/blog/2016/12/13/lightweight-docker-images-in-5-steps.html

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file;

(b) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.

Signed-off-by: William Moreno Reyes <williamjmorenor@gmail.com>

* removed adding site names to host (its pointless)

* moved redis configuration folder into conf/

* added a docker down feature to dbench and changed some of the docs

* Changed the readme significantly

 Please enter the commit message for your changes. Lines starting

* changed test.py to avoid naming errors

* moving some things around for less lines

* some more slight name changes

* added a .gitignore

* added the frappe folder again

* added a .dockerignore and fixed the dockerfile up a bit

* Updating travis' docker and compose

 This is the commit message #3:

* bringing chown in dbench back

* some refractoring

* implementing codacy sugestions

* moving some things around

* Updating dbench in some areas

* some random changes and fixes

* dockerfile refactoring

* Refractoring, reducing layers

* removing the py script that took too many lines to do one simple thing

* Fixed up the readme

* some refractoring

* moving to debian slim and refractoring

* adding some logging

* Updated travis to ubuntu xenial, should fix the curl issue

* manually building curl, cause we cant use  the latest version...

* maybe we dont need it

* changing the url to curl

* trying this instead

* lets just let it pollute the stream

* please pollute!

* some last bits of refractoring

* some refractoring

* fixed a few issues and did some refractoring

* needed an excuse to get travis to build

* adding in some changes learnt from seibert-media/erpnext-docker

* that should fix that

* where did that "h" come from?

* fix that...

* maybe that

* please work...

* try that for locales

* dont know what that's doing there

* so it didn't work...

* lets try doing locales like this

* forgot the -y...

* trying it this way

* and if we dont remove it?

* what about like this?

* small change

* small change

* I wonder...

* some small refractoring

* saving some time

* bring that back

* fix the smallie
2019-11-02 11:17:38 +05:30

2.6 KiB

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.

Unfortunately, this container is not curently suited for a production environment (but we're working towards that goal!).

Build the container and initialize the bench

Note: These instructions assume you have both Docker and Docker Compose installed on your system.

  1. Clone this repo and change your working directory to it:

    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. Use Frappe: Open your browser to localhost:8000/login. Then login using the username Administrator and the password admin.

Basic Usage of ./dbench

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

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

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

    • stop: Stops the containers with docker-compose stop.
    • down: Deletes the containers and the coresponding volumes with docker-compose down.
  • ./dbench setup hosts: Adds all sites to the containers hosts file. Note: Run 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 (i.e. Running ./dbench new-site site1.local, will run bench new-site site1.local in the container).

For More Info

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

Contributing

Feel free to contribute to this project and make it better.

License

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