mirror of
https://github.com/frappe/frappe_docker.git
synced 2026-06-18 22:25:09 +00:00
Fixed up the readme
This commit is contained in:
parent
16e766fedd
commit
7271a5db3c
1 changed files with 26 additions and 23 deletions
49
README.md
49
README.md
|
|
@ -1,69 +1,72 @@
|
|||
# Frappe on Docker
|
||||
|
||||
[](https://travis-ci.org/frappe/frappe_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.
|
||||
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
|
||||
|
||||
### 1. Installation Pre-requisites
|
||||
Unfortunetly, this container is not curently suited for a production enviorment (but we're working towards that goal!).
|
||||
|
||||
- Install [Docker](https://docs.docker.com/engine/installation) Community Edition
|
||||
### Build the container and initialize the bench
|
||||
|
||||
- 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).
|
||||
**Note:** These instructions assume you have both [Docker](https://docs.docker.com/engine/installation) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your system.
|
||||
|
||||
### 2. Build the container and initialize the bench
|
||||
|
||||
1. Clone this repo and change your working directory to frappe_docker
|
||||
1. Clone this repo and change your working directory to it:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/frappe/frappe_docker.git
|
||||
cd frappe_docker
|
||||
cd frappe_docker/
|
||||
```
|
||||
|
||||
2. Build and start the container, and initialize the bench
|
||||
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.
|
||||
**Note:** This will take a while, as docker will now build the container.
|
||||
|
||||
3. Add a new site and start frappe
|
||||
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*
|
||||
4. Use Frappe:
|
||||
Open your browser to `localhost:8000/login`. Then login using the username `Administrator` and the password `admin`.
|
||||
|
||||
- `./dbench`: Launches you into an interactive shell in the container as user frappe
|
||||
### Basic Usage of `./dbench`
|
||||
|
||||
- `./dbench setup docker [ stop | down ]`: Starts and builds the docker containers using `docker-compose up -d`
|
||||
**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.
|
||||
Do this after you've added a new site to avoid errors.
|
||||
**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 -c frappe | root <command to run>`: Runs a command in the container, as the selected user.
|
||||
|
||||
- `./dbench -h`: Shows this help message
|
||||
- `./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`)
|
||||
- `./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).
|
||||
|
||||
*Always make sure that your current directory is the root directory of the repo (i.e. `frappe_docker/`)
|
||||
## For More Info
|
||||
|
||||
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
|
||||
Feel free to contribute to this project and make it better.
|
||||
|
||||
## License
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue