From e1ccb72689aa2be07d47d0022f96e0bd9a30e5c9 Mon Sep 17 00:00:00 2001 From: gassim Date: Tue, 24 Feb 2026 23:09:29 +0300 Subject: [PATCH 1/4] docs: add CoP Server Administration categories links --- README.md | 46 ++++++++++++++++++++++++++++++---------------- 1 file changed, 30 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 98f6a65..4a7ae21 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,7 @@ This repository provides a Docker-based deployment for the DHIS2 application, de - [Clean all services](#clean-all-services) - [Run end-to-end tests](#run-end-to-end-tests) - [Further Documentation](#further-documentation) +- [Community & Discussions](#community) @@ -70,6 +71,7 @@ Open [http://dhis2-127-0-0-1.nip.io](http://dhis2-127-0-0-1.nip.io) in your favo > [!NOTE] > Your browser will warn you that the certificate is not trusted. This is expected, as it is a self-signed certificate. + > [!NOTE] @@ -118,7 +120,7 @@ docker compose up Open `https://` in your favorite browser. > [!NOTE] -> The first time you launch the application, it will initialise with a blank database. *The default admin credentials are available in the `.env` file.* If you have an existing database, you can restore it following the [Backup and Restore](#backup-and-restore) section, under Advanced Usage, below. +> The first time you launch the application, it will initialise with a blank database. _The default admin credentials are available in the `.env` file._ If you have an existing database, you can restore it following the [Backup and Restore](#backup-and-restore) section, under Advanced Usage, below. ## Advanced Usage @@ -182,17 +184,17 @@ This command will create two files in the `./backups` directory: one for the dat - **Backup Database**: The database can be backed up in `custom` (default) or `plain` format, controlled by the `POSTGRES_BACKUP_FORMAT` environment variable. - ```shell - make backup-database - ``` + ```shell + make backup-database + ``` - This creates a file in `./backups` named `$TIMESTAMP.pgc` (custom) or `$TIMESTAMP.sql.gz` (plain). Consult the [PostgreSQL documentation](https://www.postgresql.org/docs/current/app-pgdump.html) for more details. + This creates a file in `./backups` named `$TIMESTAMP.pgc` (custom) or `$TIMESTAMP.sql.gz` (plain). Consult the [PostgreSQL documentation](https://www.postgresql.org/docs/current/app-pgdump.html) for more details. - **Backup File Storage**: - ```shell - make backup-file-storage - ``` + ```shell + make backup-file-storage + ``` #### Backup Timestamp @@ -214,15 +216,15 @@ make restore - **Restore Database**: Set the `DB_RESTORE_FILE` environment variable to the backup file name. - ```shell - make restore-database - ``` + ```shell + make restore-database + ``` - **Restore File Storage**: Set the `FILE_STORAGE_RESTORE_SOURCE_DIR` environment variable to the backup directory name. - ```shell - make restore-file-storage - ``` + ```shell + make restore-file-storage + ``` ### Monitoring @@ -259,8 +261,8 @@ DHIS2's built-in monitoring API is enabled, exposing health and performance metr 1. Start services with the monitoring overlay (as shown above). 2. Open `https://grafana.{APP_HOSTNAME}` in your browser (where `{APP_HOSTNAME}` is from your `.env` file). 3. Login with: - - Username: `admin` - - Password: Check your `.env` file for `GRAFANA_ADMIN_PASSWORD`. + - Username: `admin` + - Password: Check your `.env` file for `GRAFANA_ADMIN_PASSWORD`. #### Configuration @@ -320,3 +322,15 @@ For more in-depth information, please refer to the following: - [Environment Variables](docs/environment-variables.md) - [PostgreSQL Documentation](https://www.postgresql.org/docs/current/app-pgdump.html) + +## Community + +> [!TIP] +> +> ### 🤝 Join the Discussion +> +> For troubleshooting, configuration help, and community, please use the **DHIS2 Community of Practice**: +> +> - 🟦 **[Server Administration](https://community.dhis2.org/c/server-administration/33)** — General server topics. +> - 🔹 **[DHIS2 on Docker](https://community.dhis2.org/c/server-administration/docker/95)** — **Specific to Docker on DHIS2.** +> - 🔹 **[DHIS2 on Kubernetes](https://community.dhis2.org/c/server-administration/kubernetes/94)** From d5d80d758c48e9f1fa4d3ae4a5b1b73ba9d91331 Mon Sep 17 00:00:00 2001 From: gassim Date: Tue, 24 Feb 2026 23:30:27 +0300 Subject: [PATCH 2/4] docs: add CoP Server Administration categories links --- README.md | 39 +++++++++++++++++++-------------------- 1 file changed, 19 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 4a7ae21..5ffe9d3 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,7 @@ This repository provides a Docker-based deployment for the DHIS2 application, de + - [Quick Start](#quick-start) - [Deployment For Production](#deployment-for-production) - [Deployment Prerequisites](#deployment-prerequisites) @@ -50,7 +51,7 @@ This repository provides a Docker-based deployment for the DHIS2 application, de - [Clean all services](#clean-all-services) - [Run end-to-end tests](#run-end-to-end-tests) - [Further Documentation](#further-documentation) -- [Community & Discussions](#community) +- [Community & Discussions](#community--discussions) @@ -71,7 +72,6 @@ Open [http://dhis2-127-0-0-1.nip.io](http://dhis2-127-0-0-1.nip.io) in your favo > [!NOTE] > Your browser will warn you that the certificate is not trusted. This is expected, as it is a self-signed certificate. - > [!NOTE] @@ -120,7 +120,7 @@ docker compose up Open `https://` in your favorite browser. > [!NOTE] -> The first time you launch the application, it will initialise with a blank database. _The default admin credentials are available in the `.env` file._ If you have an existing database, you can restore it following the [Backup and Restore](#backup-and-restore) section, under Advanced Usage, below. +> The first time you launch the application, it will initialise with a blank database. *The default admin credentials are available in the `.env` file.* If you have an existing database, you can restore it following the [Backup and Restore](#backup-and-restore) section, under Advanced Usage, below. ## Advanced Usage @@ -184,17 +184,17 @@ This command will create two files in the `./backups` directory: one for the dat - **Backup Database**: The database can be backed up in `custom` (default) or `plain` format, controlled by the `POSTGRES_BACKUP_FORMAT` environment variable. - ```shell - make backup-database - ``` + ```shell + make backup-database + ``` - This creates a file in `./backups` named `$TIMESTAMP.pgc` (custom) or `$TIMESTAMP.sql.gz` (plain). Consult the [PostgreSQL documentation](https://www.postgresql.org/docs/current/app-pgdump.html) for more details. + This creates a file in `./backups` named `$TIMESTAMP.pgc` (custom) or `$TIMESTAMP.sql.gz` (plain). Consult the [PostgreSQL documentation](https://www.postgresql.org/docs/current/app-pgdump.html) for more details. - **Backup File Storage**: - ```shell - make backup-file-storage - ``` + ```shell + make backup-file-storage + ``` #### Backup Timestamp @@ -216,15 +216,15 @@ make restore - **Restore Database**: Set the `DB_RESTORE_FILE` environment variable to the backup file name. - ```shell - make restore-database - ``` + ```shell + make restore-database + ``` - **Restore File Storage**: Set the `FILE_STORAGE_RESTORE_SOURCE_DIR` environment variable to the backup directory name. - ```shell - make restore-file-storage - ``` + ```shell + make restore-file-storage + ``` ### Monitoring @@ -261,8 +261,8 @@ DHIS2's built-in monitoring API is enabled, exposing health and performance metr 1. Start services with the monitoring overlay (as shown above). 2. Open `https://grafana.{APP_HOSTNAME}` in your browser (where `{APP_HOSTNAME}` is from your `.env` file). 3. Login with: - - Username: `admin` - - Password: Check your `.env` file for `GRAFANA_ADMIN_PASSWORD`. + - Username: `admin` + - Password: Check your `.env` file for `GRAFANA_ADMIN_PASSWORD`. #### Configuration @@ -323,8 +323,7 @@ For more in-depth information, please refer to the following: - [Environment Variables](docs/environment-variables.md) - [PostgreSQL Documentation](https://www.postgresql.org/docs/current/app-pgdump.html) -## Community - +## Community & Discussions > [!TIP] > > ### 🤝 Join the Discussion From 9bb42c8b048d944b2484e5df72a3b7f51ce9a2b9 Mon Sep 17 00:00:00 2001 From: gassim Date: Tue, 24 Feb 2026 23:36:13 +0300 Subject: [PATCH 3/4] docs: add blank line after heading --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 5ffe9d3..7421808 100644 --- a/README.md +++ b/README.md @@ -324,6 +324,7 @@ For more in-depth information, please refer to the following: - [PostgreSQL Documentation](https://www.postgresql.org/docs/current/app-pgdump.html) ## Community & Discussions + > [!TIP] > > ### 🤝 Join the Discussion From 046e7783a74a3ec41d3cb6de9a6b6a760385addd Mon Sep 17 00:00:00 2001 From: gassim Date: Mon, 30 Mar 2026 11:15:53 +0300 Subject: [PATCH 4/4] docs: fix markdown linting issues --- README.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index af0a3ab..4eb88bd 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # Docker Deployment -> [!CAUTION] -> **Ready for public testing — NOT yet recommended for production or critical data** +> [!CAUTION] > **Ready for public testing — NOT yet recommended for production or critical data** > > This project is available for public testing and evaluation, but it remains immature and is not recommended for production use yet. The implementation has been designed to meet production standards, however it needs additional testing, stabilization, and a small set of features before we can recommend it for critical data. > @@ -73,12 +72,10 @@ git clone https://github.com/dhis2/docker-deployment.git && \ Open [http://dhis2-127-0-0-1.nip.io](http://dhis2-127-0-0-1.nip.io) in your favorite browser. -> [!NOTE] -> Your browser will warn you that the certificate is not trusted. This is expected, as it is a self-signed certificate. +> [!NOTE] > Your browser will warn you that the certificate is not trusted. This is expected, as it is a self-signed certificate. -> [!NOTE] -> The default admin credentials are available in the `.env` file. +> [!NOTE] > The default admin credentials are available in the `.env` file. ## Deployment For Production @@ -122,8 +119,7 @@ docker compose up Open `https://` in your favorite browser. -> [!NOTE] -> The first time you launch the application, it will initialise with a blank database. *The default admin credentials are available in the `.env` file.* If you have an existing database, you can restore it following the [Backup and Restore](#backup-and-restore) section, under Advanced Usage, below. +> [!NOTE] > The first time you launch the application, it will initialise with a blank database. *The default admin credentials are available in the `.env` file.* If you have an existing database, you can restore it following the [Backup and Restore](#backup-and-restore) section, under Advanced Usage, below. ## Advanced Usage