You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/quickstart.rst
+30-2
Original file line number
Diff line number
Diff line change
@@ -7,9 +7,37 @@ Quick Start Guide
7
7
1. Launch the Web UI
8
8
---------------------
9
9
10
+
There are two ways to launch the Dagu Web UI:
11
+
12
+
**Option A: Direct Launch**
13
+
10
14
Start the server with ``dagu start-all`` and browse to http://127.0.0.1:8080 to explore the Web UI.
15
+
After the Web UI loads, navigate to the DAGs page by either:
16
+
17
+
#. Clicking the second button from the top in the left sidebar (the one that looks like a list)
18
+
#. Directly accessing http://localhost:8080/dags
19
+
20
+
.. note::
21
+
The server will be started on port ``8080`` by default. You can change the port by passing ``--port`` option. See `configurations options </config.html>`_ for more details.
22
+
23
+
**Option B: Using Docker Compose**
24
+
25
+
If you prefer using Docker, you can use `docker-compose.yaml <https://github.com/dagu-org/dagu/blob/main/docker-compose.yaml>`_ to launch the Web UI:
26
+
27
+
.. code-block:: bash
28
+
29
+
# Clone the repository
30
+
git clone https://github.com/dagu-org/dagu.git
31
+
# Navigate to the project root
32
+
cd dagu
33
+
# Launch with docker compose from the project root
34
+
docker compose up
35
+
36
+
Then browse to http://127.0.0.1:8080/dags to access the Web UI.
37
+
After the Web UI loads, navigate to the DAGs page by either:
11
38
12
-
Note: The server will be started on port ``8080`` by default. You can change the port by passing ``--port`` option. See :ref:`Host and Port Configuration` for more details.
39
+
#. Clicking the second button from the top in the left sidebar (the one that looks like a list)
40
+
#. Directly accessing http://localhost:8080/dags
13
41
14
42
2. Create a New DAG
15
43
-------------------
@@ -56,7 +84,7 @@ Go to the ``SPEC`` Tab and hit the ``Edit`` button. Copy & Paste the following Y
56
84
-------------------
57
85
58
86
.. note::
59
-
In the `examples <https://github.com/dagu-org/dagu/tree/main/examples>`_ folder, there is a ``docker-compose.yaml`` which can be used to test out DAGs, and get up to speed with examples like the above.
87
+
In the `project root <https://github.com/dagu-org/dagu>`_, there is a `docker-compose.yaml<https://github.com/dagu-org/dagu/blob/main/docker-compose.yaml>`_ which can be used to test out DAGs, and get up to speed with examples like the above.
60
88
61
89
You can execute the example by pressing the `Start` button.
0 commit comments