Skip to content

Commit

Permalink
Merge pull request frappe#437 from shariquerik/docker-compose-1
Browse files Browse the repository at this point in the history
  • Loading branch information
shariquerik authored Oct 31, 2024
2 parents bb8c232 + ab7039d commit 5442f4c
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 4 deletions.
34 changes: 33 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,42 @@

## Getting Started

### Cloud Hosting
### Managed Hosting

Get started with your personal or business site with a few clicks on [Frappe Cloud](https://frappecloud.com/marketplace/apps/crm).

### Docker (Recommended)

The quickest way to set up Frappe CRM and take it for a test ride.

Frappe framework is multi-tenant and supports multiple apps by default. This docker compose is just a standalone version with Frappe CRM pre-installed. Just put it behind your desired reverse-proxy if needed, and you're good to go.

If you wish to use multiple Frappe apps or need multi-tenancy. Take a look at our production ready self-hosted workflow, or join us on Frappe Cloud to get first party support and hassle-free hosting.

**Step 1**: Setup folder and download the required files

mkdir frappe-crm
cd frappe-crm

**Step 2**: Download the required files

Docker Compose File:

wget -O docker-compose.yml https://raw.githubusercontent.com/frappe/crm/develop/docker/docker-compose.yml

Frappe CRM bench setup script

wget -O init.sh https://raw.githubusercontent.com/frappe/crm/develop/docker/init.sh

**Step 3**: Run the container and daemonize it

docker compose up -d

**Step 4**: The site [http://crm.localhost](http://crm.localhost) should now be available. The default credentials are:

> username: administrator
> password: admin
### Self-hosting

If you prefer self-hosting, follow the official [Frappe Bench Installation](https://github.com/frappe/bench#installation) instructions.
Expand Down
2 changes: 1 addition & 1 deletion docker/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ version: "3.7"
name: crm
services:
mariadb:
image: mariadb:10.6
image: mariadb:10.8
command:
- --character-set-server=utf8mb4
- --collation-server=utf8mb4_unicode_ci
Expand Down
3 changes: 1 addition & 2 deletions docker/init.sh
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ bench set-redis-socketio-host redis:6379
sed -i '/redis/d' ./Procfile
sed -i '/watch/d' ./Procfile

bench get-app crm
bench get-app crm --branch develop

bench new-site crm.localhost \
--force \
Expand All @@ -34,7 +34,6 @@ bench --site crm.localhost install-app crm
bench --site crm.localhost set-config developer_mode 1
bench --site crm.localhost clear-cache
bench --site crm.localhost set-config mute_emails 1
bench --site crm.localhost add-user alex@example.com --first-name Alex --last-name Scott --password 123 --user-type 'System User' --add-role 'crm Admin'
bench use crm.localhost

bench start

0 comments on commit 5442f4c

Please sign in to comment.