chore: updated README.md to mention docker steps

This commit is contained in:
Shariq Ansari 2024-10-31 22:22:25 +05:30
parent ac7f708de3
commit ab7039d6dc

View File

@ -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.