diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..453aa62 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,162 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ +.env +webfinger.log diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..6d881e6 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,14 @@ +FROM python + +LABEL org.opencontainers.image.source https://git.batsense.net/ForgeFlux/webfinger-test + +RUN useradd -ms /bin/bash -u 1001 webfinger +RUN apt-get update && apt-get install -y ca-certificates git +RUN pip3 install requests +USER webfinger + +WORKDIR /home/webfinger +run mkdir app/ +WORKDIR /home/webfinger/app/ +COPY . . +CMD [ "python3", "run.py"] diff --git a/README.md b/README.md index 899038c..2f39872 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,8 @@ ## TODO - [ ] Write code to upload to ftest server -- [ ] Package Docker container -- [ ] Upload to Docker Hub +- [x] Package Docker container +- [x] Upload to Docker Hub ## Environment Variables @@ -24,6 +24,17 @@ source .env python run.py ``` +### Docker + +```bash +cp .env_sample .env # edit and populate .env with the right values +source .env +docker run \ + -e FTEST_AUTH=$FTEST_AUTH \ + -e FTEST_TARGET_HOST=$FTEST_TARGET_HOST \ + -e FTEST_USER=$FTEST_USER forgeflux/webfinger-test +``` + ## Demo ### Successful run: