Add LICENSE, README.md

LICENSE

@@ -0,0 +1,5 @@
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,62 @@
+# Конфигурационные файлы для запуска локального кеширующего сервера для менеджера пакетов pip
+
+Конфигурационные файлы предназначены для развёртывания зеркала pypi для
+локального применения, например, на случай, если доступ к серверам pypi
+окажется заблокирован. Используется модуль devpi, который запускается
+используя docker-compose.
+
+Пакеты при установке будут сохраняться в локальном репозитории, что позволит
+не скачивать повторно те же файлы через Интернет.
+
+Полное зеркало pypi.org не создаётся, сохраняются только пакеты, которые вы
+будете скачивать через своё зеркало.
+
+В данном примере используется протокол HTTP, если вам необходимо использовать
+защищённое соединение, то реализовать это можно, например, при помощи Apache или
+nginx в качестве обратного прокси-сервера, используя приложение certbot для
+получения бесплатного сертификата, в этом случае вам возможно потребуется
+изменить значение параметра --host в инструкции CMD в файле Dockerfile (чтобы
+сервер принимал запросы по незащищённому соединению только с локального адреса).
+
+## Установка
+
+### Клонируйте репозиторий:
+
+git clone https://github.com/askh/devpisrv.git
+
+### Соберите сервис:
+
+cd devpisrv
+docker-compose build
+
+### Запустите сервис
+
+docker-compose up -d
+
+## Использование
+
+Чтобы при установке приложение pip подключалось к вашему зеркалу, нужно или
+передать ему его адрес через опции командной строки, либо создать
+конфигурационный файл, в котором будут указаны соответствующие значения.
+
+Далее предполагается, что адрес вашго зеркала — http://mirror.example.com:3141,
+для примера будем устанавливать пакет virtualenv.
+
+### Использование опций командной строки
+
+pip install -v --timeout 120 --trusted-host mirror.example.com -U -i http://mirror.example.com:3141/root/pypi/+simple/ virtualenv
+
+### Использовние конфигруационного файла
+
+Создайте файл ~/.config/pip/pip.conf следующего содержания (замените адреес
+mirror.expample.com на адрес вашего зеркала):
+
+[global]
+index-url=http://mirror.example.com:3141/root/pypi/+simple/
+trusted-host=mirror.example.com
+timeout=120
+
+После этого устанавливайте пакеты обычным образом, например:
+
+pip install virtualenv
+