Skip to content

Enhanced README to Pull and Modify Variables in the .env file #288

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

Merged
piyushroshan merged 3 commits into from
Jan 31, 2025
Merged

Enhanced README to Pull and Modify Variables in the .env file #288

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8e1271a
enhanced readme
mathew-jose Jan 29, 2025
d680f99
enhanced setup.md
mathew-jose Jan 29, 2025
062f5ee
enhanced setup.md
mathew-jose Jan 29, 2025
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
16 changes: 15 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,16 @@ docker-compose version
```

#### Using prebuilt images
You can use prebuilt images generated by our CI workflow.
You can use prebuilt images generated by our CI workflow by downloading the docker-compose and .env files.

- To use the latest stable version.

- Linux Machine

```
curl -o docker-compose.yml https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/docker-compose.yml

curl -o .env https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/.env

docker-compose pull

Expand All @@ -37,18 +39,28 @@ You can use prebuilt images generated by our CI workflow.
```
curl.exe -o docker-compose.yml https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/docker-compose.yml

curl.exe -o .env https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/.env

docker-compose pull

docker-compose -f docker-compose.yml --compatibility up -d
```

To override server configurations, change the values of the variables present in the .env file or add the respective variables to the start of the docker-compose command.

```
LISTEN_IP="127.0.0.1" docker-compose -f docker-compose.yml --compatibility up -d
```

- To use the latest development version

- Linux Machine

```
curl -o docker-compose.yml https://raw.githubusercontent.com/OWASP/crAPI/develop/deploy/docker/docker-compose.yml

curl -o .env https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/.env

VERSION=develop docker-compose pull

VERSION=develop docker-compose -f docker-compose.yml --compatibility up -d
Expand All @@ -59,6 +71,8 @@ You can use prebuilt images generated by our CI workflow.
```
curl.exe -o docker-compose.yml https://raw.githubusercontent.com/OWASP/crAPI/develop/deploy/docker/docker-compose.yml

curl.exe -o .env https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/.env

set "VERSION=develop"

docker-compose pull
Expand Down
15 changes: 14 additions & 1 deletion docs/setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ docker-compose version
```

### Using prebuilt images
You can use prebuilt images generated by our CI workflow.
You can use prebuilt images generated by our CI workflow by downloading the docker-compose and .env files.

#### Start crAPI
- To use the latest stable version.
Expand All @@ -21,6 +21,8 @@ You can use prebuilt images generated by our CI workflow.
```
curl -o docker-compose.yml https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/docker-compose.yml

curl -o .env https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/.env

docker-compose pull

docker-compose -f docker-compose.yml --compatibility up -d
Expand All @@ -31,10 +33,17 @@ You can use prebuilt images generated by our CI workflow.
```
curl.exe -o docker-compose.yml https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/docker-compose.yml

curl.exe -o .env https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/.env

docker-compose pull

docker-compose -f docker-compose.yml --compatibility up -d
```
To override server configurations, change the values of the variables present in the .env file or add the respective variables to the start of the docker-compose command.

```
LISTEN_IP="127.0.0.1" docker-compose -f docker-compose.yml --compatibility up -d
```

- To use the latest development version

Expand All @@ -43,6 +52,8 @@ You can use prebuilt images generated by our CI workflow.
```
curl -o docker-compose.yml https://raw.githubusercontent.com/OWASP/crAPI/develop/deploy/docker/docker-compose.yml

curl -o .env https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/.env

VERSION=develop docker-compose pull

VERSION=develop docker-compose -f docker-compose.yml --compatibility up -d
Expand All @@ -53,6 +64,8 @@ You can use prebuilt images generated by our CI workflow.
```
curl.exe -o docker-compose.yml https://raw.githubusercontent.com/OWASP/crAPI/develop/deploy/docker/docker-compose.yml

curl.exe -o .env https://raw.githubusercontent.com/OWASP/crAPI/main/deploy/docker/.env

set "VERSION=develop"

docker-compose pull
Expand Down