From 6e7706c23e443f8cee48d04d7de51bc23dff5cbd Mon Sep 17 00:00:00 2001
From: mpavlov <mpavlov@olsson.ul>
Date: Fri, 4 Oct 2024 01:22:05 +0300
Subject: [PATCH] README

---
 README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7a6549a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,56 @@
+# PROXY
+
+## Content
+* Reverse proxy
+* HTTPS file share
+* Docker-registry
+
+## Installation
+```yml
+target_host: Enter FQDN or IP Address of target host
+rproxy_install: Install rproxy, https repo and docker-registry if checked
+config_add: Will config be created
+
+rproxy_service_name: Server/service name without domain suffix
+rproxy_service_port: Port to redirect the request to 
+rproxy_service_address: Address to redirect the request to 
+
+Example:
+domain: olsson.ul
+jenkins_host: http://10.10.10.1:8080/
+
+rproxy_service_name: jenkins
+rproxy_service_port: 8080
+rproxy_service_address: 10.10.10.1
+
+# After adding alias jenkins.olsson.ul => rproxy.olsson.ul
+result_address: https://jenkins.olsson.ul/
+```
+
+## Reverse Proxy
+Allows redirecting requests based on fqdn to the required address and ports with ssl certificate substitution
+
+## HTTPS repository
+Would be installed with rproxy service. Hosted on port 9000. \
+Files should be stored in /opt/rproxy/repo/ to be shared.
+
+## Docker-registry
+Would be installed with rproxy service. Hosted on port 5000.
+Images would be stored in /opt/dockerrepo/repo/. Uses SSL so you should have trust with root certificate. \
+Install trust with root certificate:
+```bash
+# RHEL based
+openssl x509 -in RootCA.crt -out RootCA.pem -outform PEM
+mv RootCA.pem /etc/pki/ca-trust/source/anchors/
+update-ca-trust force-enable
+
+# Debian based
+mv RootCA.crt /usr/local/share/ca-certificates/
+update-ca-certificates
+```
+How to store image:
+```bash
+# After image build
+docker tag $image $registry_address:5000/$image
+docker push $registry_address:5000/$image
+```
-- 
2.49.1