Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 18 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
>
Expand All @@ -23,6 +22,7 @@ This repository provides a Docker-based deployment for the DHIS2 application, de
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->


- [Quick Start](#quick-start)
- [Deployment For Production](#deployment-for-production)
- [Deployment Prerequisites](#deployment-prerequisites)
Expand Down Expand Up @@ -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--discussions)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

Expand All @@ -71,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.
<!-- markdownlint-disable MD028 -->

> [!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

Expand Down Expand Up @@ -120,8 +119,7 @@ docker compose up

Open `https://<your-domain.com>` 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

Expand Down Expand Up @@ -323,3 +321,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 & Discussions

> [!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)**