Skip to content

Commit 82bb07e

Browse files
committed
docs: update docs
1 parent 59bb714 commit 82bb07e

File tree

1 file changed

+60
-4
lines changed

1 file changed

+60
-4
lines changed

README.md

Lines changed: 60 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,74 @@ Simple and lightweight Cronicle Docker solution.
44

55
Say goodbye to troublesome configuration and installation, and start your Scheduled Task Center with One-Click.
66

7-
## Usage
7+
## Docker Images
88

9-
Init Cornicle first.
9+
```bash
10+
# use the latest version
11+
docker pull soulteary/cronicle
12+
# or specified version
13+
docker pull soulteary/cronicle:0.9.11
14+
```
15+
16+
### Supported Versions
17+
18+
DockerHub: https://hub.docker.com/r/soulteary/cronicle
19+
20+
- [v0.9.11](https://github.com/jhuckaby/Cronicle/releases/tag/v0.9.11)
21+
- [v0.9.9](https://github.com/jhuckaby/Cronicle/releases/tag/v0.9.11)
22+
- [v0.8.62](https://github.com/jhuckaby/Cronicle/releases/tag/v0.8.62)
23+
24+
### Default Account
25+
26+
default account and password:
27+
28+
- username: admin
29+
- password: admin
30+
31+
## Docker
32+
33+
Init your app first (first time only).
34+
35+
```bash
36+
docker run --rm -it \
37+
-v `pwd`/data/data:/opt/cronicle/data:rw \
38+
-v `pwd`/data/logs:/opt/cronicle/logs:rw \
39+
-v `pwd`/data/plugins:/opt/cronicle/plugins:rw \
40+
--hostname cronicle \
41+
--name cronicle \
42+
soulteary/cronicle \
43+
/opt/cronicle/bin/control.sh setup
44+
```
45+
46+
Then, Start app using the Docker CLI to locally persist data and logs.
47+
48+
```bash
49+
docker run \
50+
-v /etc/localtime:/etc/localtime:ro \
51+
-v /etc/timezone:/etc/timezone:ro \
52+
-v `pwd`/data/data:/opt/cronicle/data:rw \
53+
-v `pwd`/data/logs:/opt/cronicle/logs:rw \
54+
-v `pwd`/data/plugins:/opt/cronicle/plugins:rw \
55+
-p 3012:3012 \
56+
--hostname cronicle \
57+
--name cronicle \
58+
soulteary/cronicle
59+
```
60+
61+
Access it in your browser: http://localhost:3012
62+
63+
## Docker Compose
64+
65+
Init your app first (first time only).
1066

1167
```bash
1268
docker-compose -f docker-compose.init up
1369
```
1470

15-
Start Cronicle App.
71+
Then, Start app with simple command:
1672

1773
```bash
1874
docker-compose down && docker-compose up -d
1975
```
2076

21-
Access it in your browser: http://localhost:3012 (username: admin, password: admin)
77+
Access it in your browser: http://localhost:3012

0 commit comments

Comments
 (0)