Skip to content

Commit

Permalink
feat: add new dev setup and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pipech committed Nov 22, 2023
1 parent 63c20a1 commit 9e32dbd
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 3 deletions.
48 changes: 45 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

![push-docker](https://github.com/pipech/erpnext-docker-debian/actions/workflows/push-docker.yml/badge.svg)

**This repository prioritizes stability and repeatability, and is not designed as the ideal approach for a production environment.**
**This repository prioritizes stability, repeatability and simplicity, and is not designed as the ideal approach for a production environment.**

## Problem

Expand All @@ -14,9 +14,51 @@

By using Docker, we can pre-build images and push them to [Docker hub](https://hub.docker.com/r/pipech/erpnext-docker-debian/). This ensures that usable images are always available, and you can select the version that best suits your needs.

## Setup
## User & Password

Read [the Docs](https://github.com/pipech/erpnext-docker-debian/wiki)
```
# Website
U: administrator
P: 12345
# MariaDB
U: root
P: 12345
```

## Usage

### Trial Setup

This setup is designed for users who want to explore the system and is not suitable for production use.

```sh
docker pull pipech/erpnext-docker-debian:version-15-latest

docker run -d -p 8000:8000 -p 9000:9000 -p 3306:3306 pipech/erpnext-docker-debian:version-15-latest
```

The site should be available at http://localhost:8000 after 1-2 minutes.

### Development Setup

This is a self-contained development setup. Developers can fully isolate their environment. The setup utilizes Visual Studio Code and its Dev Containers feature.

1. Open Visual Studio Code.
1. Open the Command Palette (View > Command Palette or Ctrl + Shift + P).
1. Type: `Open Folder in Container`.
1. Select the `setup_development` folder.

For every startup, run:

```sh
sudo service mariadb start
bench start
```

### Production Setup

For best practices in a production environment, [Official Frappe Docker](https://github.com/frappe/frappe_docker).

## Build Process

Expand Down
6 changes: 6 additions & 0 deletions setup_development/.devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"name": "frappe",
"service": "frappe",
"dockerComposeFile": "docker-compose.yml",
"workspaceFolder": "/home/frappe/bench/apps"
}
10 changes: 10 additions & 0 deletions setup_development/.devcontainer/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
version: '3'

services:
frappe:
image: pipech/erpnext-docker-debian:15-F1.0_E2.0
ports:
- '8000:8000' #webserver_port
- '9000:9000' #socketio_port
- '3306:3306' #mysql_port
command: sleep infinity

0 comments on commit 9e32dbd

Please sign in to comment.