diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 00000000..07c6697e --- /dev/null +++ b/Dockerfile @@ -0,0 +1,14 @@ +FROM alpine:3.14 + +RUN apk update && apk add py3-pip + +COPY requirements.txt . + +RUN pip install -r requirements.txt + +WORKDIR /docs + +EXPOSE 8000 + +CMD [ "mkdocs","serve","-a","0.0.0.0:8000"] + diff --git a/README.md b/README.md index a2ff7d83..b37324ae 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,21 @@ Read the docs at [docs.vapor.codes](https://docs.vapor.codes) +# Start with Docker +* Prerequisite for this setup, you must have docker and docker compose installed on the system + +1. first clone the repo + +2. then run +``` +docker compose up +``` +3. then open from the browser on the port 8000 +e.g. +``` +http://127.0.1.1:8000 +``` + ## Contributing If you want to add information to the docs or have found any mistakes you wish to fix, feel free to create a PR for the change. diff --git a/docker-compose.yaml b/docker-compose.yaml new file mode 100644 index 00000000..8686e0a1 --- /dev/null +++ b/docker-compose.yaml @@ -0,0 +1,11 @@ +services: + docs: + build: ./ + image: vapor/docs + container_name: vapor-docs + ports: + - "8000:8000" + volumes: + - type: bind + source: ./ + target: /docs \ No newline at end of file