Skip to content

Commit 29e713c

Browse files
committed
docs: Updated docs to reflect compose changes and some readability/usage improvements
1 parent d1dce2b commit 29e713c

File tree

1 file changed

+43
-18
lines changed

1 file changed

+43
-18
lines changed

README.md

+43-18
Original file line numberDiff line numberDiff line change
@@ -12,48 +12,73 @@ Dkron is a distributed cron service, easy to setup and fault tolerant with focus
1212
- Reliable: Completely fault tolerant
1313
- Highly scalable: Able to handle high volumes of scheduled jobs and thousands of nodes
1414

15-
Dkron is written in Go and leverage the power of the Raft protocol and Serf for providing fault tolerance, reliability and scalability while keeping simple and easily installable.
15+
Dkron is written in Go and leverage the power of the Raft protocol and Serf for providing fault tolerance, reliability
16+
and scalability while keeping simple and easily installable.
1617

17-
Dkron is inspired by the google whitepaper [Reliable Cron across the Planet](https://queue.acm.org/detail.cfm?id=2745840) and by Airbnb Chronos borrowing the same features from it.
18+
Dkron is inspired by the google
19+
whitepaper [Reliable Cron across the Planet](https://queue.acm.org/detail.cfm?id=2745840) and by Airbnb Chronos
20+
borrowing the same features from it.
1821

19-
Dkron runs on Linux, OSX and Windows. It can be used to run scheduled commands on a server cluster using any combination of servers for each job. It has no single points of failure due to the use of the Gossip protocol and fault tolerant distributed databases.
22+
Dkron runs on Linux, OSX and Windows. It can be used to run scheduled commands on a server cluster using any combination
23+
of servers for each job. It has no single points of failure due to the use of the Gossip protocol and fault tolerant
24+
distributed databases.
2025

2126
You can use Dkron to run the most important part of your company, scheduled jobs.
2227

2328
## Installation
2429

2530
[Installation instructions](https://dkron.io/docs/basics/installation)
2631

27-
Full, comprehensive documentation is viewable on the [Dkron website](http://dkron.io)
32+
Full, comprehensive documentation is accessible on the [Dkron website](http://dkron.io)
2833

29-
## Development Quick start
34+
## Quickstart
3035

31-
The best way to test and develop dkron is using docker, you will need [Docker](https://www.docker.com/) installed before proceeding.
36+
### Deploying Dkron using Docker
3237

33-
Clone the repository.
38+
The best way to test and develop dkron is using docker, you will need [Docker](https://www.docker.com/) with Docker
39+
compose installed before proceeding.
3440

35-
Next, run the included Docker Compose config:
41+
```bash
42+
docker compose up -d
43+
```
3644

37-
`docker-compose up`
45+
The UI should be available on http://localhost:8080/ui.
3846

39-
This will start Dkron instances. To add more Dkron instances to the clusters:
47+
### Using Dkron
4048

41-
```
42-
docker-compose up --scale dkron-server=4
43-
docker-compose up --scale dkron-agent=10
49+
To add jobs to the system read the [API docs](https://dkron.io/api/).
50+
51+
### Scaling the cluster
52+
53+
To add more Dkron instances to the cluster:
54+
55+
```bash
56+
docker compose up -d --scale dkron-server=4
57+
docker compose up -d --scale dkron-agent=10
4458
```
4559

46-
Check the port mapping using `docker-compose ps` and use the browser to navigate to the Dkron dashboard using one of the ports mapped by compose.
60+
## Development
4761

48-
To add jobs to the system read the [API docs](https://dkron.io/api/).
62+
To develop Dkron, you can deploy the cluster with local changes applied with the following steps:
63+
64+
1. Clone the repository.
65+
66+
2. Run the `docker compose`:
67+
68+
```bash
69+
docker compose -f docker-compose.dev.yml up
70+
```
4971

50-
## Frontend development
72+
### Frontend development
5173

5274
Dkron dashboard is built using [React Admin](https://marmelab.com/react-admin/) as a single page application.
5375

54-
To start developing the dashboard enter the `ui` directory and run `npm install` to get the frontend dependencies and then start the local server with `npm start` it should start a new local web server and open a new browser window serving de web ui.
76+
To start developing the dashboard enter the `ui` directory and run `npm install` to get the frontend dependencies and
77+
then start the local server with `npm start` it should start a new local web server and open a new browser window
78+
serving de web ui.
5579

56-
Make your changes to the code, then run `make ui` to generate assets files. This is a method of embedding resources in Go applications.
80+
Make your changes to the code, then run `make ui` to generate assets files. This is a method of embedding resources in
81+
Go applications.
5782

5883
### Resources
5984

0 commit comments

Comments
 (0)