Skip to content
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.

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

Update the Vagrant setup instructions #215

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
75 changes: 40 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,58 +13,60 @@ know more about crAPI, please check [crAPI's overview][overview].
### Docker and docker-compose

You'll need to have Docker and docker-compose installed and running on your host system. Also, the version of docker-compose should be `1.27.0` or above. Check your docker-compose version using:

```
docker-compose version
```

#### Using prebuilt images

You can use prebuilt images generated by our CI workflow.

- To use the latest stable version.
- To use the latest stable version.

- Linux Machine
- Linux Machine

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

docker-compose pull
docker-compose pull

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

- Windows Machine
- Windows Machine

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

docker-compose pull
docker-compose pull

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

- To use the latest development version
- To use the latest development version

- Linux Machine
- Linux Machine

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

VERSION=develop docker-compose pull
VERSION=develop docker-compose pull

VERSION=develop docker-compose -f docker-compose.yml --compatibility up -d
```
VERSION=develop docker-compose -f docker-compose.yml --compatibility up -d
```

- Windows Machine
- Windows Machine

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

set "VERSION=develop"
set "VERSION=develop"

docker-compose pull
docker-compose pull

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

Visit [http://localhost:8888](http://localhost:8888)

Expand All @@ -80,13 +82,17 @@ installed.

1. Clone crAPI repository
```
$ git clone [REPOSITORY-URL]
$ git clone https://github.com/OWASP/crAPI.git
```
2. Change into the directory of the crAPI repository
```
2. Start crAPI Virtual Machine
$ cd crAPI
```
3. Start crAPI Virtual Machine
```
$ cd deploy/vagrant && vagrant up
```
3. Visit [http://192.168.33.20](http://192.168.33.20)
4. Visit [http://192.168.33.20](http://192.168.33.20)

**Note**: All emails are sent to mailhog service and can be checked on
[http://192.168.33.20:8025](http://192.168.33.20:8025)
Expand All @@ -98,11 +104,9 @@ system running the following command from the repository root directory
$ cd deploy/vagrant && vagrant destroy
```

For more deployment options visit [the setup instructions](docs/setup.md) for more details.
---
## For more deployment options visit [the setup instructions](docs/setup.md) for more details.

To know more about challenges in crAPI. Visit [challenges]
----
## To know more about challenges in crAPI. Visit [challenges]

[challenges]: docs/challenges.md
[overview]: docs/overview.md
Expand All @@ -111,4 +115,5 @@ To know more about challenges in crAPI. Visit [challenges]
[virtualbox]: https://www.virtualbox.org/wiki/Downloads

## Troubleshooting guide for general issues while installing and running crAPI
If you need any help with installing and running crAPI you can check out this guide: [Troubleshooting guide crAPI](https://github.com/OWASP/crAPI/blob/main/docs/troubleshooting.md). If this doesn't solve your problem, please create an issue in Github Issues.

If you need any help with installing and running crAPI you can check out this guide: [Troubleshooting guide crAPI](https://github.com/OWASP/crAPI/blob/main/docs/troubleshooting.md). If this doesn't solve your problem, please create an issue in Github Issues.
156 changes: 78 additions & 78 deletions services/community/vendor/github.com/klauspost/compress/fse/README.md
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your contribution, can you just commit the relevant README file along with adding a description to this PR.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading