Commit graph

137 commits

Author SHA1 Message Date
adithya
cab78405cc refactor: Moving md files to src for clarity 2026-03-15 18:47:35 +05:30
adithya
c81d6c794b fix: Contain all docs and related in docs folder
The package.json and pnpm-lock.yaml are not part of the main repo but
specific to the docs. The workflow will now target this folder for
running.
2026-03-15 18:47:35 +05:30
adithya
a48633d33c feat: Deploy to GitHub pages
fix: pnpm Actions fix, corrected base

fix: Build error fixes

fix: Images not showing up in pages

fix: Moved logo to public path
2026-03-15 18:47:35 +05:30
adithya
e7f2c66e1d feat: VitePress for docs
VitePress is configured in the repo for handling docs
2026-03-15 18:47:35 +05:30
RocketQuack
99d9a1dc38
feat: add nginx-proxy with acme companion as an alternative to traefik (#1800)
* refactor: move core nginx files into more recognizable folder structure

* chore: include HTTPS_PUBLISH_PORT in example .env

* feat: add nginx-proxy and acme-companion compose overrides

* docs: add NGINX_PROXY_HOSTS to example.env

* docs: add nginx-proxy overrides

* docs: split docs, variables for usage of traefik or nginx-proxy

* docs: update override notes for traefik proxy on separate stack

* docs: split TLS/SSL overview and add own caddy guide

* docs: add nginx-proxy + acme companion guide

* docs: add nginx-proxy and acme single-server setup guide
2026-02-06 09:56:28 +05:30
RocketQuack
bfb040e5a6 docs: mark v3 migration complete 2026-01-25 14:31:46 +01:00
RocketQuack
6b0a7cc218
Merge branch 'main' into chore/Update-Traefik-to-Version-3.6 2026-01-19 22:33:19 +01:00
RocketQuack
80a11fb47f chore: run pre-commit fixes 2026-01-19 19:31:55 +01:00
RocketQuack
a1265baed6 chore: run pre-commit fixes 2026-01-19 19:07:33 +01:00
Rocket-Quack
166a904041 docs: deprecation note for SITES in favor of SITES_RULE for v3 traefik 2026-01-19 15:24:43 +01:00
Rocket-Quack
c5525bf021 docs: add Traefik v2 to v3 migration guide 2026-01-16 13:27:10 +01:00
Rocket-Quack
9a4a078bde docs: update Traefik v3 SITES_RULE usage and examples 2026-01-16 13:04:34 +01:00
Daniel Radl
4b90bfdade
docs(readme): refactor readme to explaining how to navigate this repository (#1779) 2026-01-02 02:30:45 +05:30
daniel.radl
a6eba1e913 docs: use costom.env in setup 2025-12-29 10:42:25 +01:00
Daniel Radl
7de99474cb
docs: added deployment methode chooser (#1777) 2025-12-25 05:20:35 +05:30
Michael Uray
4548ead3dd
Update link to site operations documentation
Fixed link to
04-operations/01-site-operations.md
2025-12-09 23:28:00 +01:00
Ali Al Saif
09934d576c
docs: reorganize documentation structure with numbered navigation (#1729)
* 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>
2025-12-06 10:07:36 +05:30
duthink
41f30248c9 docs: Revise core services section in Getting Started guide for clarity and accuracy 2025-11-04 12:40:15 +05:30
duthink
a7ccf3565d docs: Add comprehensive Getting Started guide for Frappe Docker 2025-10-31 19:20:01 +05:30
Fitzroy Zeng
a830f288d8
Fix typo in Docker compose command (#1724) 2025-10-21 12:52:06 +05:30
DanielRadlAMR
ffd2aa47a6
docs: reorganize container setup information into new subfolder docs/container-setup (#1720) 2025-10-14 17:31:25 +05:30
MeIchthys
b6e89163ec
Revert "Use docker compose instead of docker-compose (#1702)" (#1708)
This reverts commit 2f5a42d864.
2025-09-16 08:19:27 +05:30
MeIchthys
2f5a42d864
Use docker compose instead of docker-compose (#1702)
* Use `docker compose` instead of `docker-compose`

Update to use new docker syntax.

* use `docker` instead of `docker-compose`
2025-09-13 12:24:41 +05:30
DanielRadlAMR
8841d78c13
Add Docker Secrets Support for Database Password & fixed missing boto3 dependency in tests (#1657)
* Added overrider to use docker secrets for mariadb password

* typo in overrider file name

* typo in overrider mariadb-secrets

* typo in overriider mariadb-secrets

* Secrets enviroment variable override

* secrets need different enviroment variable name

* no - for env variables

* Updated deprecated MinIO Env Variables

* refactored to be more robust and better error handling

* temprary debugging changes

* Revert "temprary debugging changes"

This reverts commit d01931064d.

* Revert "refactored to be more robust and better error handling"

This reverts commit fe508668a8.

* Revert "Updated deprecated MinIO Env Variables"

This reverts commit 76e66b5262.

* manually added boto3 before running _create_bucket

* lint formatting
2025-07-19 08:27:10 +05:30
YapWC
d505c91eab
Update Install Traefik Section (#1664)
Since the password would be parsed in single quote (') the text transformation is no longer needed. This update is based on issue #1002 (Unable to login to Traefik Dashboard even after providing Correct password in Basic Auth.)
2025-07-19 08:24:05 +05:30
gp
31ed5daa68
chore: Update EOL NodeJS to 20.19.2 (#1638) 2025-05-29 17:33:28 +05:30
Harmeet Singh
65a0ac2e7f
Update site-operations.md (#1627)
Added note for -p <project_name> in docker-compose exec command.

https://github.com/frappe/frappe_docker/issues/927
2025-05-13 22:07:44 +05:30
Reuel Ramos Ribeiro
e6f7deec5c
Update development.md (#1600)
Clarify documentation about error. Solution was found at: https://discuss.frappe.io/t/youre-attempting-to-install-erpnext-version-15-with-frappe-version-16-this-is-not-supported-and-wi/127422
2025-04-01 16:32:19 +05:30
Amanuel Elhanan
56e1da3f37
Autostart pod on system boot (#1561)
* Autostart pod on system boot

* ci: fix pre-commit

---------

Co-authored-by: Revant Nandgaonkar <revant.one@gmail.com>
2025-02-04 18:48:44 +05:30
kelvine
fcfe63e0df
Update custom-apps.md (#1554)
* Update custom-apps.md

grammar fixes

* Remove redis-cache volume (#1555)

* Remove redis-cache volume

* remove from docs

* ci: fix pre-commit

---------

Co-authored-by: Revant Nandgaonkar <revant.one@gmail.com>

---------

Co-authored-by: Salah Aldin Fateh <83924106+sdfateh@users.noreply.github.com>
Co-authored-by: Revant Nandgaonkar <revant.one@gmail.com>
2025-01-27 11:13:47 +05:30
Salah Aldin Fateh
bcb203551a
Remove redis-cache volume (#1555)
* Remove redis-cache volume

* remove from docs

* ci: fix pre-commit

---------

Co-authored-by: Revant Nandgaonkar <revant.one@gmail.com>
2025-01-27 11:10:14 +05:30
Roberto Alonso De la Garza Mendoza
dfcbe3fc22
Update troubleshoot.md for edge cases
Add create command template on troubleshoot.md
2025-01-07 12:34:55 -06:00
Revant Nandgaonkar
cb3cf80e1a
Merge pull request #1539 from elhananjair/patch-2
Building an image with custom apps using podman
2025-01-06 17:48:44 +05:30
Revant Nandgaonkar
acb08c5179 docs: custom apps with podman 2025-01-06 17:47:10 +05:30
Revant Nandgaonkar
b8354030c5 docs: tls for local deployment 2025-01-06 17:41:32 +05:30
Amanuel Elhanan
869de6218b
Create custom-apps-podman
This is a full guide on building an image with custom apps using Podman.
2025-01-05 15:45:40 +03:00
Revant Nandgaonkar
85e164f34c revert: quote percent as mentioned in bench help 2024-12-10 15:48:00 +05:30
Revant Nandgaonkar
1505d125f1 fix: quote percent as mentioned in bench help 2024-12-10 15:36:18 +05:30
0xD0M1M0
598c7dab43 fix: --no-mariadb-socket & --mariadb-root-password is DEPRECATED 2024-12-07 15:30:46 +01:00
Revant Nandgaonkar
1c6f58c986
docs: fix broken link (#1516)
fixes #1510
2024-11-18 16:23:09 +05:30
Dr.Blank
faa2065026
docs: fix grammar in administrator password instructions (#1504)
Correct redundant wording and improve clarity in site creation documentation.
2024-11-07 09:10:13 +05:30
Revant Nandgaonkar
b24a4109c8
chore: fix pre-commit lint for md file (#1503) 2024-11-04 16:59:47 +05:30
Marc-Antoine Lalonde
5d0d14dde8
docs: clarify docker-compose and add steps to troubleshooting instructions (#1502)
Add steps to the database debugging guide to include more possibilities and fix mysql instructions.

Add explanation on the use of certain variables affected by network configuration.
2024-11-04 11:42:57 +05:30
Revant Nandgaonkar
a919f44505
docs: quick build command (#1500)
* docs: quick build command

* chore: fix pre-commit lint for md file
2024-10-27 14:45:41 +05:30
Edward Almanzar
10c755fe0c
Enhance Docs for Custom Apps: Base64 Decoding for Testing and Fix 'nginx-entrypoint.sh: No Such File' Issue on Windows only" (#1479)
* Decode the Base64-encoded Environment Variable

* add docs to fix nginx-entrypoint.sh: no such file on windows

* Revert "add docs to fix nginx-entrypoint.sh: no such file on windows"

This reverts commit 395d7cfa3f.

* add docs to fix nginx-entrypoint.sh: no such file on windows

* Fix files according to pre-commit hooks
2024-10-06 17:49:47 +05:30
Martin Heini
eb3ce8a146
increase mariadb health-check timeout (#1485) 2024-10-06 13:47:47 +05:30
Himanshu Shivhare
10e28f4d9d
hyperlink updated (#1407) 2024-06-10 12:22:49 +05:30
Yeifer Alexander Muñoz Torres
fa543662ed
#1402 Environment variables for custom image (#1403)
* chore: enhance compose.yaml with variables for customize

* chore: use default blank values for db and redis variables in compose.yaml

* chore: Use env var for HTTP(S) publish ports in overrides

* docs: explain use of environment variables for image customization

* chore: use ERPNEXT_VERSION as default

* docs: fixed spelling errors
2024-06-08 00:21:17 +05:30
Anthony
855ce6cb0b
Update single-server-example.md (#1401)
Fix nonworking step - hashed password fails - per https://discuss.frappe.io/t/frappe-docker-unable-to-log-in-into-traefik/123077
2024-05-28 19:06:49 +05:30
Bowrna
8404d8946d
Update development.md (#1392)
* Update development.md

The extension name is renamed

* Update development.md
2024-05-07 10:31:44 +05:30