Merge pull request #183 from drsushanth/git_auth

Git Authentication

Author: Linbreux

DOCKER.md

@@ -80,8 +80,45 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
     uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
 ```
 
+## Remote Git Repo
+
+Pass the following environment parameters:
+
+```bash
+  -e SYNC_WITH_REMOTE=1 \
+  -e REMOTE_URL="<ssh url of the remote git repo>"
+```
+
+Along with the parameters you will need four more files. 
+
+1. SSH config file
+    ```
+      Host <hostname or remote repo>
+        User git
+        IdentityFile /root/.ssh/id_ed25519
+        IdentitiesOnly yes                 # Optional to make sure you don't 
+                                            get too many authentication failure
+    ```
+2. SSH key file uploaded to your remote
+3. SSH Public key
+4. SSH Known Hosts file
+
+    As you wont be able to add the remote host's to the docker's known hosts 
+    file you have to provide the file
+
+    ```bash
+      ssh-keyscan -t ed25519 <host url> >> known_hosts
+    ```
+
+The files need to be owned by root not by the UID and GID passed by you. Save 
+the files in a folder *ssh* along with the *wiki* folder and pass both the folders as such.
+
+```bash
+    -v wiki:/wiki \
+    -v ssh:/root/.ssh
+```
+
 ## Support Info
 
 * Shell access whilst the container is running: `docker exec -it wikmd /bin/bash`
 * To monitor the logs of the container in realtime: `docker logs -f wikmd`
-

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.9-alpine3.17 as python-base
+FROM python:3.9-alpine3.17 AS python-base
 
 # Prevents Python from writing pyc files.
 ENV PYTHONDONTWRITEBYTECODE=1
@@ -32,11 +32,12 @@ ENV PATH="$VIRTUAL_ENV/bin:$PATH"
 RUN python -m venv $VIRTUAL_ENV
 
 # BUILDER
-FROM python-base as python-builder
+FROM python-base AS python-builder
 
 # Install our dependencies
 RUN apk update
 RUN apk add git
+RUN apk add openssh
 RUN apk add build-base linux-headers
 
 # Python dependencies

src/wikmd/utils.py

@@ -1,6 +1,7 @@
 import os
 import unicodedata
 import re
+import shutil
 
 _filename_ascii_strip_re = re.compile(r"[^A-Za-z0-9 _.-]")
 _windows_device_files = {
@@ -73,4 +74,4 @@ def move_all_files(src_dir: str, dest_dir: str):
                 new_file += f".{file_split[1]}"  # add the extension
             copies_count += 1
 
-        os.rename(f"{src_dir}/{file}", f"{dest_dir}/{new_file}")
+        shutil.move(f"{src_dir}/{file}", f"{dest_dir}/{new_file}")