container/link-validator
Archived
1
0
Fork 0
Code Issues Pull Requests Releases 35 Activity

add instructions to readme
All checks were successful
continuous-integration/drone/push Build is passing
Details
continuous-integration/drone/tag Build is passing
Details

Browse Source
This commit is contained in:
Robert Kaussow 2020-05-31 21:54:12 +02:00
parent 4878373353
commit 8f7148e4f5
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -6,6 +6,30 @@
Simple wrapper for [broken-link-checker](https://github.com/stevenvachon/broken-link-checker) optimized for CI.
## Usage
```Shell
docker run -v $(pwd)/public:/drone/src link-validator
# or pass arguments to broken-link-checker
# ... but DO NOT set the server url! This will be done automatically. See environment variables.
docker run -v $(pwd)/public:/drone/src link-validator -ro
```
## Environment variables
```Shell
LINK_VALIDATOR_BASE_DIR=/drone/src
LINK_VALIDATOR_SERVER_ADDRESS=127.0.0.1
LINK_VALIDATOR_SERVER_PORT=8000
```
## Build
```Shell
docker build -t link-validator:latest .
```
## License
This project is licensed under the MIT License - see the [LICENSE](https://gitea.rknet.org/docker/link-validator/src/branch/master/LICENSE) file for details.