Fixes #47: Added DEV_ADDR variable for custom mkdocs ip and port definition inside of container (#48)

Author: pozgo

.github/workflows/build_image.yml

@@ -2,14 +2,12 @@ name: Build & Test MKDocs
 
 on:
   push:
-    branches: [ issue/*, feature/* ]
+    branches: [issue/*, feature/*]
   pull_request:
-    branches: [ master ]
+    branches: [master]
 
 jobs:
-
   build:
-
     runs-on: ubuntu-latest
 
     steps:
@@ -24,3 +22,7 @@ jobs:
           docker run -d --cap-add NET_ADMIN -p 8000:8000 --name mkdocs polinux/mkdocs:${RELEASE}
           sleep 10
           curl -sSLi http://127.0.0.1:8000  | grep '200 OK'
+          # Test custom port
+          docker run -d --cap-add NET_ADMIN -p 8001:9000 --name custom -e "DEV_ADDR=0.0.0.0:9000" polinux/mkdocs:${RELEASE}
+          sleep 10
+          curl -sSLi http://127.0.0.1:8001  | grep '200 OK'

Dockerfile

@@ -15,17 +15,18 @@ ADD container-files/ /
 
 RUN \
     apk add --update \
-        ca-certificates \
-        bash \
-        git \
-        openssh \
-        python3 \
-        python3-dev \
-        build-base && \
-    pip3 install --upgrade pip && \
+    ca-certificates \
+    bash \
+    git \
+    openssh \
+    python3 \
+    python3-dev \
+    py3-pip \
+    build-base && \
+    pip install --upgrade pip && \
     pip install mkdocs==${MKDOCS_VERSION} && \
     cd /bootstrap && pip install -e /bootstrap && \
     rm -rf /tmp/* /var/tmp/* /var/cache/apk/* /var/cache/distfiles/* && \
     chmod 600 /root/.ssh/config
 
-CMD ["/usr/bin/bootstrap", "start"]
+CMD ["/usr/bin/bootstrap", "start"]

README.md

@@ -1,6 +1,6 @@
 ### MkDocs in a docker.
 
-![Docker Image MKDocs](https://github.com/pozgo/docker-mkdocs/workflows/Docker%20Image%20MKDocs/badge.svg?branch=master)
+[![Docker Image MKDocs](https://github.com/pozgo/docker-mkdocs/workflows/Docker%20Image%20MKDocs/badge.svg?branch=master)](https://github.com/pozgo/docker-mkdocs/actions?query=workflow%3A%22Build+%26+Test+MKDocs%22)
 [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fpozgo%2Fdocker-mkdocs.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fpozgo%2Fdocker-mkdocs?ref=badge_shield)
 
 [![GitHub Open Issues](https://img.shields.io/github/issues/pozgo/docker-mkdocs.svg)](https://github.com/pozgo/docker-mkdocs/issues)
@@ -25,7 +25,7 @@ version: '3'
 services:
   mkdocs:
     container_name: mkdocs
-    image: polinux/mkdocs:1.1.0
+    image: polinux/mkdocs:1.1.2
     restart: always
     ports:
       - "8000:8000"
@@ -53,6 +53,7 @@ services:
 |`GIT_BRANCH`|Self explanatory|`master`|
 |`AUTO_UPDATE`|Auto update for git repository support|`false`|
 |`UPDATE_INTERVAL`|Update interval in *minutes* - used only when `AUTO_UPDATE` set to `true`|every `15` minutes|
+|`DEV_ADDR`|Custom IP address and port to serve documentation locall|`0.0.0.0:8000`|
 
 ### Usage
 
@@ -68,7 +69,7 @@ Custom config with `git` repository as source of documentation
 docker run \
     -ti \
     --name mkdocs \
-    -p 80:8000 \
+    -p 80:9000 \
     -e "ADD_MODULES=mkdocs-bootstrap mkdocs-gitbook mkdocs-bootstrap4" \
     -e "LIVE_RELOAD_SUPPORT=true" \
     -e "FAST_MODE=true" \
@@ -77,6 +78,7 @@ docker run \
     -e "GIT_BRANCH=develop" \
     -e "AUTO_UPDATE=true" \
     -e "UPDATE_INTERVAL=1" \
+    -e "DEV_ADDR=0.0.0.0:9000" \
     -v ${HOME}/.ssh/id_rsa:/root/.ssh/id_rsa \
     polinux/mkdocs
 ```

container-files/bootstrap/app/mkdocs/common.py

@@ -24,7 +24,11 @@ def start():
     _check_previous_installation()
     print('Starting MKDocs')
     os.chdir(docks_dir)
-    os.system(f'mkdocs serve -a 0.0.0.0:8000 {_live_reload()} {_fast_mode()}')
+    if "DEV_ADDR" in os.environ:
+        _dev_addr = os.environ['DEV_ADDR']
+    else:
+        _dev_addr = '0.0.0.0:8000'
+    os.system(f'mkdocs serve -a {_dev_addr} {_live_reload()} {_fast_mode()}')
 
 
 def _install_modules(modules):
@@ -45,13 +49,15 @@ def _check_previous_installation():
     :return:
     """
     if not os.path.exists(docks_dir + '/mkdocs.yml'):
-        print(colored(f'No documentation found in ({docks_dir}). Creating new one.', 'yellow'))
+        print(colored(
+            f'No documentation found in ({docks_dir}). Creating new one.', 'yellow'))
         if not os.path.exists(docks_dir):
             os.mkdir(docks_dir)
         print(colored(f'Starting fresh installation', 'green'))
         os.system(f'mkdocs new {docks_dir}/')
     else:
-        print(colored(f'Detected previous installation in ({docks_dir}).', 'green'))
+        print(
+            colored(f'Detected previous installation in ({docks_dir}).', 'green'))
 
 
 def _live_reload():
@@ -111,7 +117,8 @@ def _clone_repo(repo):
 
     if auto_update == 'true':
         print(colored(f'AUTO_UPDATE - [ ENABLED ]', 'green'))
-        print(colored(f'UPDATE_INTERVAL set to every {interval} minute/s', 'green'))
+        print(
+            colored(f'UPDATE_INTERVAL set to every {interval} minute/s', 'green'))
         _set_auto_update(interval)
 
 

container-files/bootstrap/setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name='bootstrap',
-    version='0.0.2',
+    version='1.0.0',
     py_modules=['bootstrap'],
     include_package_data=True,
     install_requires=[