Cutlery/LibreTranslate
1
0
Fork 0
mirror of https://github.com/LibreTranslate/LibreTranslate.git synced 2025-05-23 17:02:58 -04:00
Code Issues Packages Projects Releases Wiki Activity

Add 2 variations of Dockerfile

Browse Source 
1. docker/root-with-sshd.Dockerfile
   - executes as user: "root"
   - supports build arguments:
     * api_key
     * root_password

2. docker/user-with-api-key.Dockerfile
   - executes as user: "libretranslate"
   - supports build arguments:
     * api_key

Build arguments are optional:

* api_key=""
  - initializes one API key with the user-defined value

* root_password=""
  - sets password for "root" user
  - installs sshd server to allow remote access to "ltmanage" command
    * enables "PermitRootLogin"
    * enables "PasswordAuthentication"

Environment variables with complimentary behavior:

* LT_REQ_LIMIT = 0
* LT_API_KEYS  = true
  - locks down server and requires an API key for all API access

Testing:

* unexpected complications
  - sudo:
    * error message:
        effective uid is not 0,
        is /usr/bin/sudo on a file system with the 'nosuid' option set
        or an NFS file system without root privileges?
    * info:
        https://unix.stackexchange.com/q/546822
    * result:
      - discarded Dockerfile variation that attempted to:
        * run entrypoint as user: "libretranslate"
        * use sudo to run sshd

* "render.com" free tier
  - notes:
    * completely free
    * no credit card required
    * can clone any public git repo and run any Dockerfile it contains
    * can NOT use SSH to access containers
  - Dockerfile variations:
    1. docker/Dockerfile
       - works perfectly
       - public API is open and unrestricted
    2. docker/root-with-sshd.Dockerfile
       - works perfectly
       - public API is only accessible to requests with "api_key"
       - SSH server is running
         * public access is blocked by container firewall
         * haven't tested on a paid tier,
           but external connections should be allowed and work
    3. docker/user-with-api-key.Dockerfile
       - works perfectly
       - public API is only accessible to requests with "api_key"
This commit is contained in:
Warren R. Bank 2025-04-21 15:56:20 -07:00
parent 15dbc94783
commit 01042ab2bd
2 changed files with 183 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

105
docker/root-with-sshd.Dockerfile Normal file
View File

@ -0,0 +1,105 @@
FROM python:3.11.11-slim-bullseye AS builder
WORKDIR /app
ARG DEBIAN_FRONTEND=noninteractive
RUN <<EOF
apt-get update -qq
apt-get -qqq install --no-install-recommends -y pkg-config gcc g++
apt-get upgrade --assume-yes
apt-get clean
rm -rf /var/lib/apt
python -mvenv venv
./venv/bin/pip install --no-cache-dir --upgrade pip
EOF
COPY . .
# Install package from source code, compile translations
RUN <<EOF
./venv/bin/pip install Babel==2.12.1
./venv/bin/python scripts/compile_locales.py
./venv/bin/pip install torch==2.2.0 --extra-index-url https://download.pytorch.org/whl/cpu
./venv/bin/pip install "numpy<2"
./venv/bin/pip install .
./venv/bin/pip cache purge
EOF
FROM python:3.11.11-slim-bullseye
ARG with_models=false
ARG models=""
ARG root_password=""
ARG api_key=""
ENV ENABLE_SSHD=${root_password:+true}
RUN <<EOF
if [ "$ENABLE_SSHD" = "true" ]; then
# sshd
mkdir /var/run/sshd
apt-get update -qq
apt-get -qqq install --no-install-recommends -y openssh-server
apt-get clean
rm -rf /var/lib/apt
# sshd_config
echo "root:${root_password}" | chpasswd
sed -i 's/^#?\(PermitRootLogin\) .*$/\1 yes/' /etc/ssh/sshd_config
sed -i 's/^#?\(PasswordAuthentication\) .*$/\1 yes/' /etc/ssh/sshd_config
sed -i 's/^#?\(UsePAM\) .*$/\1 no/' /etc/ssh/sshd_config
fi
EOF
COPY --from=builder --chown=root:root /app /app
WORKDIR /app
COPY --from=builder --chown=root:root /app/venv/bin/ltmanage /usr/bin/
RUN <<EOF
if [ "$with_models" = "true" ]; then
# initialize the language models
if [ ! -z "$models" ]; then
./venv/bin/python scripts/install_models.py --load_only_lang_codes "$models"
else
./venv/bin/python scripts/install_models.py
fi
fi
EOF
RUN <<EOF
if [ ! -z "$api_key" ]; then
# initialize the API key database
./venv/bin/python - <<'EOPython'
from libretranslate.api_keys import Database
from libretranslate.default_values import DEFAULT_ARGUMENTS as DEFARGS
Database(DEFARGS['API_KEYS_DB_PATH'])
EOPython
# initialize one API key
ltmanage keys add 120 --key "$api_key"
fi
EOF
EXPOSE 22
EXPOSE 5000
# entry point
RUN <<EOF
cat >'/app/start.sh' <<EOENTRY
#!/bin/sh
set -e
if [ "$ENABLE_SSHD" = "true" ]; then
service ssh start &
fi
/app/venv/bin/libretranslate --host '*'
exit 0
EOENTRY
chmod 755 /app/start.sh
EOF
ENTRYPOINT [ "/app/start.sh" ]

78
docker/user-with-api-key.Dockerfile Normal file
View File

@ -0,0 +1,78 @@
FROM python:3.11.11-slim-bullseye AS builder
WORKDIR /app
ARG DEBIAN_FRONTEND=noninteractive
RUN <<EOF
apt-get update -qq
apt-get -qqq install --no-install-recommends -y pkg-config gcc g++
apt-get upgrade --assume-yes
apt-get clean
rm -rf /var/lib/apt
python -mvenv venv
./venv/bin/pip install --no-cache-dir --upgrade pip
EOF
COPY . .
# Install package from source code, compile translations
RUN <<EOF
./venv/bin/pip install Babel==2.12.1
./venv/bin/python scripts/compile_locales.py
./venv/bin/pip install torch==2.2.0 --extra-index-url https://download.pytorch.org/whl/cpu
./venv/bin/pip install "numpy<2"
./venv/bin/pip install .
./venv/bin/pip cache purge
EOF
FROM python:3.11.11-slim-bullseye
ARG with_models=false
ARG models=""
ARG api_key=""
RUN <<EOF
addgroup --system --gid 1032 libretranslate
adduser --system --uid 1032 libretranslate
mkdir -p /home/libretranslate/.local
chown -R libretranslate:libretranslate /home/libretranslate/.local
EOF
USER libretranslate
COPY --from=builder --chown=1032:1032 /app /app
WORKDIR /app
COPY --from=builder --chown=1032:1032 /app/venv/bin/ltmanage /usr/bin/
RUN <<EOF
if [ "$with_models" = "true" ]; then
# initialize the language models
if [ ! -z "$models" ]; then
./venv/bin/python scripts/install_models.py --load_only_lang_codes "$models"
else
./venv/bin/python scripts/install_models.py
fi
fi
EOF
RUN <<EOF
if [ ! -z "$api_key" ]; then
# initialize the API key database
./venv/bin/python - <<'EOPython'
from libretranslate.api_keys import Database
from libretranslate.default_values import DEFAULT_ARGUMENTS as DEFARGS
Database(DEFARGS['API_KEYS_DB_PATH'])
EOPython
# initialize one API key
ltmanage keys add 120 --key "$api_key"
fi
EOF
EXPOSE 22
EXPOSE 5000
ENTRYPOINT [ "./venv/bin/libretranslate", "--host", "*" ]