Nginx-set-conf

====================================================================================
This is a simple python library that helps you to create configurations for different docker based applications with nginx as reverse proxy.

Installation

Nginx-set-conf requires

Python (>= 3.8)
click (>= 8.1.3)
PyYaml (>= 5.4.1)

Use the package manager pip to install nginx-set-conf.

pip install nginx-set-conf-equitania

Usage

$ nginx-set-conf --help
usage: nginx-set-conf [--help] [--config_template] [--ip] [--domain] [--port] [--cert_name] [--pollport] [--redirect_domain] [--auth_file] [--config_path]

Options:
  --config_template TEXT  Insert the conf-template.  
  
                          We support:

                          - ngx_code_server (code-server with ssl)
                          - ngx_fast_report (FastReport with ssl)
                          - ngx_mailhog (MailHog with ssl)
                          - ngx_nextcloud (NextCloud with ssl)
                          - ngx_odoo_http (Odoo only http)
                          - ngx_odoo_ssl (Odoo with ssl)
                          - ngx_pgadmin (pgAdmin4 with ssl)
                          - ngx_portainer (NextCloud with ssl)
                          - ngx_pwa (Progressive Web App with ssl)
                          - ngx_redirect (Redirect Domain without ssl)
                          - ngx_redirect_ssl (Redirect Domain with ssl)
  --ip TEXT               IP address of the server
  --domain TEXT           Name of the domain
  --port TEXT             Primary port for the Docker container
  --cert_name TEXT        Name of certificate if you want to use letsencrypt - complete path for self signed or purchased certificates
  --cert_key TEXT         Name and path of certificate key - for self signed or purchased certificates - leave empty for letsencrypt
  --pollport TEXT         Secondary Docker container port for odoo pollings
  --redirect_domain TEXT  Redirect domain
  --auth_file TEXT        Use authfile for htAccess 
  --config_path TEXT      Yaml configuration folder
  --help                  Show this message and exit.

Example

# Execution with config file
nginx-set-conf --config_path server_config

f.e.

nginx-set-conf --config_path=$HOME/docker-builds/ngx-conf

Execution without config file

nginx-set-conf --config_template ngx_odoo_ssl --ip 1.2.3.4 --domain www.equitania.de --port 8069 --cert_name www.equitania.de --pollport 8072

Create your cert

certbot certonly --standalone --agree-tos --register-unsafely-without-email -d www.equitania.de

Install certbot on Debian/Ubuntu with

apt-get install certbot

Create your auth file

Install htpasswd on Debian/Ubuntu with

apt-get install apache2-utils
htpasswd -c /etc/nginx/.htaccess/.htpasswd-user USER

nginx template settings

You can download our settings: nginx.conf
and the : nginxconfig.io.zip
based on https://www.digitalocean.com/community/tools/nginx

This project is licensed under the terms of the AGPLv3 license.

Metadata

Release files for nginx-set-conf-equitania 1.0.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nginx-set-conf-equitania 1.0.7
File	Size	Uploaded
nginx-set-conf-equitania-1.0.7.tar.gz	21.3 kB	Dec 4, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for nginx-set-conf-equitania 1.0.7
File	Interpreter	ABI	Platform	Reset
nginx_set_conf_equitania-1.0.7-py3-none-any.whl 21.7 kB Dec 4, 2024	Python 3	none	any	Details

Total release size: 43.0 kB

Release files / nginx-set-conf-equitania-1.0.7.tar.gz

Download URL	nginx-set-conf-equitania-1.0.7.tar.gz
Size	21.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`21f6d66eb1cfcc15d779897b93be3e0fab040404e3fa9837ee30f2b2b00a131b`
BLAKE2b-256 checksum How to use checksums	`0dfe35f1d9c68d69ca6b4a3c47af12e6fc90b9d4565d0b6e80528a8495b32692`
Upload date	Dec 4, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.11.4`

Release files / nginx_set_conf_equitania-1.0.7-py3-none-any.whl

Download URL	nginx_set_conf_equitania-1.0.7-py3-none-any.whl
Size	21.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`8cf886f84f9610ed76d9e4de4e13fb303cf76a2eb2f715e3985120f379f1eaa4`
BLAKE2b-256 checksum How to use checksums	`9785c6f6e166c56d9645361ed60c08b68419816d8c32c114c15112d4d01cbb83`
Upload date	Dec 4, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.11.4`