Skip to content

docs: improve Docker setup instructions #3741

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+17 −15
Open

docs: improve Docker setup instructions #3741

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 17 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,19 +80,28 @@ _By default, this will launch the application on `http://localhost:3000`. You wi

## 🐳 Installing with Docker

To build the Umami container and start up a Postgres database, run:
To run Umami using Docker, follow these steps:

```bash
docker compose up -d
```
1. **Make sure Docker and Docker Compose are installed** on your machine.
- You can download Docker from [https://www.docker.com](https://www.docker.com)

Alternatively, to pull just the Umami Docker image with PostgreSQL support:
2. **Clone the Umami repository**:
```bash
git clone https://github.com/umami-software/umami.git
cd umami

Copy link
Contributor

@greptile-apps greptile-apps bot Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

syntax: Missing closing backtick for code block

Suggested change 

<details><summary>Prompt To Fix With AI</summary>

`````markdown
This is a comment left during a code review.
Path: README.md
Line: 92:92

Comment:
**syntax:** Missing closing backtick for code block

```suggestion


How can I resolve this? If you propose a fix, please make it concise.

```bash
3.**start the application and PostgreSQL database:
docker compose up -d
Comment on lines +93 to +94
Copy link
Contributor

@greptile-apps greptile-apps bot Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

syntax: Missing opening code block fence and broken formatting

Suggested change
3.**start the application and PostgreSQL database:
docker compose up -d
3. **Start the application and PostgreSQL database**:
```bash
docker compose up -d 

<details><summary>Prompt To Fix With AI</summary>

`````markdown
This is a comment left during a code review.
Path: README.md
Line: 93:94

Comment:
**syntax:** Missing opening code block fence and broken formatting

```suggestion
3. **Start the application and PostgreSQL database**:
   ```bash
   docker compose up -d


How can I resolve this? If you propose a fix, please make it concise.


4. **- Access Umami in your browser:
http://localhost:3000
-
- Default login credentials:
- Username: admin
- Password: umami
Comment on lines +96 to +101
Copy link
Contributor

@greptile-apps greptile-apps bot Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

syntax: Broken markdown formatting: missing code block formatting and inconsistent structure

Suggested change
4. **- Access Umami in your browser:
http://localhost:3000
-
- Default login credentials:
- Username: admin
- Password: umami
4. **Access Umami in your browser**:
- Navigate to: `http://localhost:3000`
- Default login credentials:
- Username: `admin`
- Password: `umami`
Alternatively, if you just want to pull the Docker image:
```bash
docker pull docker.umami.is/umami-software/umami:latest 

<details><summary>Prompt To Fix With AI</summary>

`````markdown
This is a comment left during a code review.
Path: README.md
Line: 96:101

Comment:
**syntax:** Broken markdown formatting: missing code block formatting and inconsistent structure

```suggestion
4. **Access Umami in your browser**:
   - Navigate to: `http://localhost:3000`
   - Default login credentials:
     - Username: `admin`
     - Password: `umami`

Alternatively, if you just want to pull the Docker image:
```bash
docker pull docker.umami.is/umami-software/umami:latest


How can I resolve this? If you propose a fix, please make it concise.

Alternatively, if you just want to pull the Docker image:
docker pull docker.umami.is/umami-software/umami:latest
Copy link
Contributor

@greptile-apps greptile-apps bot Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

syntax: Orphaned code block without proper fencing - this will break markdown rendering

Suggested change
docker pull docker.umami.is/umami-software/umami:latest
---
Prompt To Fix With AI 
This is a comment left during a code review.
Path: README.md
Line: 103:103

Comment:
**syntax:** Orphaned code block without proper fencing - this will break markdown rendering

```suggestion

---
```

How can I resolve this? If you propose a fix, please make it concise.

```

---

## 🔄 Getting Updates
> [!WARNING]
Expand All @@ -107,14 +116,7 @@ pnpm install
pnpm run build
```

To update the Docker image, simply pull the new images and rebuild:

```bash
docker compose pull
docker compose up --force-recreate -d
```

---

## 🛟 Support

Expand Down