Manage your Web domains served by NGINX
Project description
webdomains
Manage your Web domains served by NGINX.
Installation
Requirements
On a Debian-based host, you will need an already configured and running NGINX server. You may also install the following packages to satisfy the Python dependencies:
python3-click
python3-jinja2
To generate the SSL/TLS certificates for the domains, you will also have to
install and configure dehydrated. It is recommended
to use a recent version - i.e. from buster-backports
. To serve the ACME
challenge, the default NGINX configuration of a domain is looking for
/etc/nginx/snippets/acme-challenge.conf
- which can just contain:
location /.well-known/acme-challenge {
default_type "text/plain";
alias /var/lib/dehydrated/acme-challenges;
}
Configuration
You can provide your own server.conf
template which is used to generate the
NGINX configuration of a new domain. webdomains will look for a file with this
name in /etc/webdomains/templates
at first. If it does not exist, the
default template is used.
Development
To set up a development environment, all you need to have to install is a Python 3 interpreter, Git and Make. Then, run the following:
git clone https://forge.cliss21.org/cliss21/webdomains.git
cd webdomains/
# create and active a virtual environment
python3 -m venv venv/
source venv/bin/activate
# install the package with test requirements
pip install -e .[test]
You can now run the following commands:
make lint
: check the code syntaxmake tests
: run the testsmake coverage
: report the code coverage
License
webdomains is mainly developed by Cliss XXI and licensed under the GPLv3+. Any contribution is welcome!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for webdomains-1.0.0b2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a153dc74f27a29689b3f7ee1713cc7ebb38f4e1db2e507fb9ed01754cbd4503d |
|
MD5 | 17c6c45d0639a641f9b3aea6c0481372 |
|
BLAKE2b-256 | 46bcc958d19380e166415bdf4b14de4d5e79eaa134b367069334272fc2302c46 |