mirror of
https://github.com/frappe/frappe_docker.git
synced 2026-06-18 14:15:09 +00:00
09934d576c
* docs: reorganize documentation structure into logical categories Restructure documentation into organized directories for better navigation: - getting-started/: Quick start guides for new users - setup/: Setup and configuration guides - production/: Production deployment guides (backup, TLS, multi-tenancy) - operations/: Site operations and management - development/: Development workflow guides - migration/: Migration guides - troubleshooting/: Troubleshooting guides - reference/: Reference documentation (container setup, build configs) Rename files for consistency: - Use kebab-case naming convention throughout - Remove numbered prefixes from container-setup files - Use descriptive names (backup-strategy, tls-ssl-setup, etc.) Update all internal cross-references to reflect new file locations. Update README.md with organized documentation structure. Fix image paths in development.md to use correct relative paths. * docs: add numeric prefixes to directories and files for navigation order Add numeric prefixes (01-08) to documentation directories to indicate reading order and flow for first-time users: - 01-getting-started: Quick start guides - 02-setup: Setup and configuration - 03-production: Production deployment - 04-operations: Site operations - 05-development: Development guides - 06-migration: Migration guides - 07-troubleshooting: Troubleshooting - 08-reference: Reference documentation Add numeric prefixes to files within directories to guide readers through documentation in a logical sequence. Update all cross-references throughout documentation to use new numbered paths. Update README.md to reflect the new structure. * docs: move container-setup to 02-setup and integrate setup-options content Move container-setup directory from 08-reference/ to 02-setup/ to follow PR feedback. The container-setup documentation provides a more linear and coherent flow compared to the previous unstructured setup files. Changes: - Move container-setup/ from docs/08-reference/ to docs/02-setup/ - Integrate content from setup-options.md into structured flow: - Create new 06-setup-examples.md with practical deployment scenarios - Enhance 03-start-setup.md with site creation details from setup-options - Remove redundant 01-setup-options.md (content now integrated) - Rename 02-single-server-example.md to 07-single-server-example.md - Update all cross-references throughout documentation: - Update README.md with new structure under Setup section - Fix links in site-operations.md and migration docs - Add navigation links between container-setup files and examples - Maintain container-setup's linear flow: overview → build → start → env → overrides - Add practical examples document (06-setup-examples.md) that follows the container-setup guide Result: Documentation now follows a clear progression from conceptual overview through practical examples, with all setup information properly organized under 02-setup/. * docs: remove container-setup subfolder and flatten structure Move all files from docs/02-setup/container-setup/ directly into docs/02-setup/ to eliminate unnecessary subfolder. Files are already numbered sequentially, so they work perfectly at the same level. Changes: - Move all files from container-setup/ subfolder to 02-setup/ root - Remove container-setup/ subfolder - Update all cross-references: - Update README.md paths (remove container-setup/ from all links) - Fix references in site-operations.md - Fix references in migration docs - Update internal references in 06-setup-examples.md - Fix relative path references in 01-overview.md, 02-build-setup.md, 03-start-setup.md Result: Cleaner, flatter structure with all numbered setup files at the same level, making navigation more straightforward. * fix: Pre-commit failure is fixed --------- Co-authored-by: adithya <adithya.a@bayesian.in>
62 lines
2.3 KiB
Markdown
62 lines
2.3 KiB
Markdown
# start Container
|
|
|
|
Once your compose file is ready, start all containers with a single command:
|
|
|
|
```bash
|
|
docker compose -p frappe -f compose.custom.yaml up -d
|
|
```
|
|
|
|
```bash
|
|
podman-compose --in-pod=1 --project-name frappe -f compose.custom.yaml up -d
|
|
```
|
|
|
|
The `-p` (or `--project-name`) flag names the project `frappe`, allowing you to easily reference and manage all containers together.
|
|
|
|
# Create a site and install apps
|
|
|
|
Frappe is now running, but it's not yet configured. You need to create a site and install your apps.
|
|
|
|
## Basic site creation
|
|
|
|
```bash
|
|
docker compose -p frappe exec backend bench new-site <sitename> --mariadb-user-host-login-scope='172.%.%.%'
|
|
docker compose -p frappe exec backend bench --site <sitename> install-app erpnext
|
|
```
|
|
|
|
```bash
|
|
podman exec -ti erpnext_backend_1 /bin/bash
|
|
bench new-site <sitename> --mariadb-user-host-login-scope='172.%.%.%'
|
|
bench --site <sitename> install-app erpnext
|
|
```
|
|
|
|
Replace `<sitename>` with your desired site name.
|
|
|
|
## Create site with app installation
|
|
|
|
You can install apps during site creation:
|
|
|
|
```bash
|
|
docker compose -p frappe exec backend bench new-site <sitename> \
|
|
--mariadb-user-host-login-scope='%' \
|
|
--db-root-password <db-password> \
|
|
--admin-password <admin-password> \
|
|
--install-app erpnext
|
|
```
|
|
|
|
> **Note:** Wait for the `db` service to start and `configurator` to exit before trying to create a new site. Usually this takes up to 10 seconds.
|
|
|
|
For more site operations, refer to [site operations](../../04-operations/01-site-operations.md).
|
|
|
|
> ## Understanding the MariaDB User Scope
|
|
>
|
|
> The flag --mariadb-user-host-login-scope='172.%.%.%' allows database connections from any IP address within the 172.0.0.0/8 range. This includes all containers and virtual machines running on your machine.
|
|
>
|
|
> **Why is this necessary?** Docker and Podman assign dynamic IP addresses to containers. If you set a fixed IP address instead, database connections will fail when the container restarts and receives a new IP. The wildcard pattern ensures connections always work, regardless of IP changes.
|
|
>
|
|
> **Security note:** This scope is sufficient because only the backend container accesses the database. If you need external database access, adjust the scope accordingly, but be cautious with overly permissive settings.
|
|
|
|
---
|
|
|
|
**Back:** [Build Setup →](02-build-setup.md)
|
|
|
|
**Next:** [Setup Examples →](06-setup-examples.md)
|