Skip to content

Commit 5cb7031

Browse files
piyushroshanpiyushroshan
authored
Docs update (#65)
* Landing update * Update overview.md
1 parent 35890ca commit 5cb7031

File tree

3 files changed

+119
-94
lines changed

3 files changed

+119
-94
lines changed

‎README.md‎

Lines changed: 27 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -17,108 +17,48 @@ You'll need to have Docker installed and running on your host system.
1717
#### Using prebuilt images
1818
You can use prebuilt images generated by our CI workflow.
1919

20-
1. Clone crAPI repository
21-
22-
- Linux Machine
23-
24-
```
25-
$ git clone [REPOSITORY-URL]
26-
```
27-
28-
- Windows Machine
29-
30-
```
31-
$ git clone [REPOSITORY-URL] --config core.autocrlf=input
32-
```
33-
34-
35-
2. Start crAPI
36-
- To use the latest stable version.
20+
- To use the latest stable version.
3721

3822
- Linux Machine
39-
40-
```
41-
git checkout main
42-
43-
VERSION=latest docker-compose -f deploy/docker/docker-compose.yml --compatibility up -d
44-
```
4523

46-
- Windows Machine
47-
48-
```
49-
git checkout main
50-
51-
setx VERSION latest && docker-compose -f deploy/docker/docker-compose.yml --compatibility up -d
5224
```
25+
curl -o docker-compose.yml https://github.com/OWASP/crAPI/blob/main/deploy/docker/docker-compose.yml
5326

54-
- To use the latest development version
55-
56-
- Linux Machine
57-
58-
```
59-
git checkout develop
60-
61-
VERSION=develop docker-compose -f deploy/docker/docker-compose.yml --compatibility up -d
27+
docker-compose -f docker-compose.yml --compatibility up -d
6228
```
6329

6430
- Windows Machine
65-
66-
```
67-
git checkout develop
68-
69-
setx VERSION develop && docker-compose -f deploy/docker/docker-compose.yml --compatibility up -d
70-
```
71-
72-
3. Visit `http://localhost:8888`
73-
74-
**Note**: All emails are sent to mailhog service by default and can be checked on
75-
`http://localhost:8025`
76-
You can change the smtp configuration if required however all emails with domain **example.com** will still go to mailhog.
7731

32+
```
33+
curl.exe -o docker-compose.yml https://github.com/OWASP/crAPI/blob/main/deploy/docker/docker-compose.yml
7834

79-
#### Build it yourself
80-
81-
1. Clone crAPI repository
82-
83-
- Linux Machine
84-
85-
```
86-
$ git clone [REPOSITORY-URL]
87-
```
35+
docker-compose -f docker-compose.yml --compatibility up -d
36+
```
8837

89-
- Windows Machine
38+
- To use the latest development version
9039

91-
```
92-
$ git clone [REPOSITORY-URL] --config core.autocrlf=input
93-
```
40+
- Linux Machine
9441

95-
2. Build all docker images
42+
```
43+
curl -o docker-compose.yml https://github.com/OWASP/crAPI/blob/develop/deploy/docker/docker-compose.yml
9644
97-
- Linux Machine
45+
VERSION=develop docker-compose -f docker-compose.yml --compatibility up -d
46+
```
9847
99-
```
100-
$ deploy/docker/build-all.sh
101-
```
48+
- Windows Machine
10249
103-
- Windows Machine
50+
```
51+
curl.exe -o docker-compose.yml https://github.com/OWASP/crAPI/blob/main/deploy/docker/docker-compose.yml
10452
105-
```
106-
$ call "%cd%\deploy\docker\build-all.bat"
107-
```
53+
setx VERSION develop && docker-compose -f docker-compose.yml --compatibility up -d
54+
```
10855
109-
3. Start crAPI
110-
```
111-
$ docker-compose -f deploy/docker/docker-compose.yml --compatibility up -d
112-
```
113-
4. Visit `http://localhost:8888`
56+
Visit [http://localhost:8888](http://localhost:8888)
11457
11558
**Note**: All emails are sent to mailhog service by default and can be checked on
116-
`http://localhost:8025`
59+
[http://localhost:8025](http://localhost:8025)
11760
You can change the smtp configuration if required however all emails with domain **example.com** will still go to mailhog.
11861
119-
If you would like to deploy on kubernetes we have sample k8s configs already
120-
created. Check [the setup instructions][setup-k8s] for more details.
121-
12262
### Vagrant
12363
12464
This option allows you to run crAPI within a virtual machine, thus isolated from
@@ -133,10 +73,10 @@ installed.
13373
```
13474
$ cd deploy/vagrant && vagrant up
13575
```
136-
3. Visit `http://192.168.33.20`
76+
3. Visit [http://192.168.33.20](http://192.168.33.20)
13777
13878
**Note**: All emails are sent to mailhog service and can be checked on
139-
`http://192.168.33.20:8025`
79+
[http://192.168.33.20:8025](http://192.168.33.20:8025)
14080
14181
Once you're done playing with crAPI, you can remove it completely from your
14282
system running the following command from the repository root directory
@@ -145,8 +85,13 @@ system running the following command from the repository root directory
14585
$ cd deploy/vagrant && vagrant destroy
14686
```
14787
88+
For more deployment options visit [the setup instructions](docs/setup.md) for more details.
14889
---
14990
91+
To know more about challenges in crAPI. Visit [challenges]
92+
----
93+
94+
[challenges]: docs/challenges.md
15095
[overview]: docs/overview.md
15196
[setup-k8s]: docs/setup.md#kubernetes-minikube
15297
[vagrant]: https://www.vagrantup.com/downloads

‎docs/overview.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,16 @@ crAPI has a microservices architecture comprising the following services develop
1616
* postgres: SQL Database
1717

1818
[0]: ./challenges.md
19+
20+
21+
For deployment options, visit [the setup instructions](docs/setup.md).
22+
---
23+
24+
To know more about challenges in crAPI, visit [challenges].
25+
----
26+
27+
[challenges]: docs/challenges.md
28+
[overview]: docs/overview.md
29+
[setup-k8s]: docs/setup.md#kubernetes-minikube
30+
[vagrant]: https://www.vagrantup.com/downloads
31+
[virtualbox]: https://www.virtualbox.org/wiki/Downloads

‎docs/setup.md‎

Lines changed: 79 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,95 @@ Setup | crAPI
44
## Docker
55

66
You'll need to have Docker installed and running on your host system.
7-
After having crAPI running, you may want to remove unnecessary docker images
8-
left behind.
7+
8+
### Using prebuilt images
9+
You can use prebuilt images generated by our CI workflow.
10+
11+
#### Start crAPI
12+
- To use the latest stable version.
13+
14+
- Linux Machine
15+
16+
```
17+
curl -o docker-compose.yml https://github.com/OWASP/crAPI/blob/main/deploy/docker/docker-compose.yml
18+
19+
docker-compose -f docker-compose.yml --compatibility up -d
20+
```
21+
22+
- Windows Machine
23+
24+
```
25+
curl.exe -o docker-compose.yml https://github.com/OWASP/crAPI/blob/main/deploy/docker/docker-compose.yml
26+
27+
docker-compose -f docker-compose.yml --compatibility up -d
28+
```
29+
30+
- To use the latest development version
31+
32+
- Linux Machine
33+
34+
```
35+
curl -o docker-compose.yml https://github.com/OWASP/crAPI/blob/develop/deploy/docker/docker-compose.yml
36+
37+
VERSION=develop docker-compose -f docker-compose.yml --compatibility up -d
38+
```
39+
40+
- Windows Machine
41+
42+
```
43+
curl.exe -o docker-compose.yml https://github.com/OWASP/crAPI/blob/main/deploy/docker/docker-compose.yml
44+
45+
setx VERSION develop && docker-compose -f docker-compose.yml --compatibility up -d
46+
```
47+
48+
#### Visit [http://localhost:8888](http://localhost:8888).
49+
50+
**Note**: All emails are sent to mailhog service by default and can be checked on
51+
[http://localhost:8025](http://localhost:8025)
52+
You can change the smtp configuration if required however all emails with domain **example.com** will still go to mailhog.
53+
54+
### Build it yourself
955
1056
1. Clone crAPI repository
11-
```
12-
$ git clone [REPOSITORY-URL]
13-
```
57+
58+
- Linux Machine
59+
60+
```
61+
$ git clone [REPOSITORY-URL]
62+
```
63+
64+
- Windows Machine
65+
66+
```
67+
$ git clone [REPOSITORY-URL] --config core.autocrlf=input
68+
```
69+
1470
2. Build all docker images
15-
```
16-
$ deploy/docker/build-all.sh
17-
```
71+
72+
- Linux Machine
73+
74+
```
75+
$ deploy/docker/build-all.sh
76+
```
77+
78+
- Windows Machine
79+
80+
```
81+
$ call "%cd%\deploy\docker\build-all.bat"
82+
```
83+
1884
3. Start crAPI
19-
```
20-
$ docker-compose -f deploy/docker/docker-compose.yml --compatibility up -d
21-
```
85+
```
86+
$ docker-compose -f deploy/docker/docker-compose.yml --compatibility up -d
87+
```
2288
4. Visit `http://localhost:8888`
2389
24-
2590
**Note**: All emails are sent to mailhog service by default and can be checked on
2691
`http://localhost:8025`
2792
You can change the smtp configuration if required however all emails with domain **example.com** will still go to mailhog.
2893
94+
If you would like to deploy on kubernetes we have sample k8s configs already
95+
created. Check [the setup instructions][setup-k8s] for more details.
2996
## Kubernetes
3097
3198
### Minikube

0 commit comments

Comments
 (0)