mirror of
https://github.com/Hopiu/linkchecker.git
synced 2026-05-04 12:54:42 +00:00
Merge pull request #137 from ruzickap/feature/docker_documentation
Dockerfile fix, Documentation updated
This commit is contained in:
commit
c992bd7a63
2 changed files with 18 additions and 0 deletions
|
|
@ -1,5 +1,8 @@
|
|||
FROM python:2
|
||||
|
||||
# needed to allow linkchecker create plugin directory and initial configuration file in "home" dir
|
||||
ENV HOME /tmp
|
||||
|
||||
RUN set -x \
|
||||
&& apt-get update -qq \
|
||||
&& apt-get install -y -qq --no-install-recommends git \
|
||||
|
|
|
|||
15
README.rst
15
README.rst
|
|
@ -36,3 +36,18 @@ Usage
|
|||
------
|
||||
Execute ``linkchecker http://www.example.com``.
|
||||
For other options see ``linkchecker --help``.
|
||||
|
||||
Docker usage
|
||||
-------------
|
||||
|
||||
If you do not want to install any additional libraries/dependencies you can use the Docker image.
|
||||
|
||||
Example for external web site check:
|
||||
```
|
||||
docker run --rm -it -u $(id -u):$(id -g) linkchecker/linkchecker --verbose https://google.com
|
||||
```
|
||||
|
||||
Local HTML file check:
|
||||
```
|
||||
docker run --rm -it -u $(id -u):$(id -g) -v "$PWD":/mnt linkchecker/linkchecker --verbose index.html
|
||||
```
|
||||
|
|
|
|||
Loading…
Reference in a new issue