<commit_before># HTTPS-PORTAL

HTTPS-PORTAL is a fully automated HTTPS server powered by
[Nginx](http://nginx.org), [Let's Encrypt](https://letsencrypt.org) and
[Docker](https://www.docker.com). By using it, you can run any existing web
application over HTTPS, with only one extra line of configuration.

The SSL certificates are obtain, and renew from Let's Encrypt automatically.

Docker Hub page:
[https://hub.docker.com/r/steveltn/https-portal/](https://hub.docker.com/r/steveltn/https-portal/)

## Warning

This project is in active development stage. Use it in production with CAUTION.

## Quick Start

HTTPS-PORTAL shipped as a Docker image, so before use it, you need a Linux
machine (either local or remote host) with Docker installed. We recommand use
[Docker Compose](https://docs.docker.com/compose/) to run it. Create a
`docker-compose.yml` file with the following content in any directory:

```yaml<commit_msg>Carefully about the prerequisite<commit_after># HTTPS-PORTAL

HTTPS-PORTAL is a fully automated HTTPS server powered by
[Nginx](http://nginx.org), [Let's Encrypt](https://letsencrypt.org) and
[Docker](https://www.docker.com). By using it, you can run any existing web
application over HTTPS, with only one extra line of configuration.

The SSL certificates are obtain, and renew from Let's Encrypt automatically.

Docker Hub page:
[https://hub.docker.com/r/steveltn/https-portal/](https://hub.docker.com/r/steveltn/https-portal/)

## Warning

This project is in active development stage. Use it in production with CAUTION.

## Prerequisite

HTTPS-PORTAL shipped as a Docker image. To use it, you need a Linux machine (either local or remote host) which:

* 80 and 443 port can be publicly accessed.
* Has [Docker Engine](https://docs.docker.com/engine/installation/) installed. [Docker Compose](https://docs.docker.com/compose/) is highly recommended, it will simplify your life, and our docs are mainly written for Docker Compose.

Altough it is recommended, but knowledge of Docker is not required to use HTTPS-PORTAL.

## Quick Start


Create a `docker-compose.yml` file with the following content in any directory:

```yaml
{'fraction_non_alphanumeric': 0.10088331008833101, 'fraction_numerical': 0.0023245002324500234, 'mean_word_length': 4.575129533678757, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 11, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2509755', 'n_tokens_mistral': 667, 'n_tokens_neox': 617, 'n_words': 255}