mirror of
https://github.com/frappe/frappe_docker.git
synced 2026-06-18 22:25:09 +00:00
70 lines
2.5 KiB
Markdown
70 lines
2.5 KiB
Markdown
# Frappe on Docker
|
|
|
|
[](https://travis-ci.org/frappe/frappe_docker)
|
|
|
|
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](https://docs.docker.com/engine/installation) Community Edition
|
|
|
|
- Install [Docker Compose](https://docs.docker.com/compose/install/) (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
|
|
|
|
```bash
|
|
git clone https://github.com/frappe/frappe_docker.git
|
|
cd frappe_docker
|
|
```
|
|
|
|
2. Build and start the container, and initialize the bench
|
|
|
|
```bash
|
|
./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
|
|
|
|
```bash
|
|
./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](https://github.com/frappe/frappe_docker/wiki/Hitchhiker's-guide-to-building-this-frappe_docker-image)
|
|
|
|
## 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](LICENSE.md) file for details
|