diff --git a/README.md b/README.md index 6522f97..06e3d07 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,106 @@ -# http-to-https -The most simple http to https service +
+
+ + Logo + + +

http-to-https

+ +

+ The most simple http to https redirector +
+
+ Report Bug + ยท + Pull request +

+
+ + +
+ Table of contents +
    +
  1. + What is http-to-https ? + +
  2. +
  3. + Getting started + +
  4. +
  5. License
  6. +
+
+ + + +## What is http-to-https + +http-to-https is a simple request redirector from http to https that log request and allow custom ports. + +

(back to top)

+ +### Built With + +This section list major frameworks/libraries used + +* ![](https://img.shields.io/badge/GO-20232A?style=for-the-badge&logo=go) + +

(back to top)

+ + + +## Getting Started + +Now let's see how to set up an http-to-https instance. + +### Installation + +1. Create directory + ```sh + mkdir /opt/http-to-https + cd /opt/http-to-https + ``` +2. Download the latest release and apply permissions + ```sh + wget -O http-to-https https://github.com/itsmrval/http-to-https/releases/download/1.1.0/http-to-https_linux_amd64 + chmod +x http-to-https + ``` +3. Create the service on systemd + Write the file + ```sh + nano /etc/systemd/system/http-to-https.service + ``` + Complete and put the service file below: + ```txt + [Unit] + Description=http-to-https service + After=network.target + + [Service] + Type=simple + ExecStart=/opt/http-to-https/http-to-https + Environment="PORT=80" + + [Install] + WantedBy=multi-user.target + ``` + +6. Reload systemd and run the service ! + ```sh + systemctl daemon-reload + systemctl enable --now http-to-https + ``` +

(back to top)

+ + + +## License + +Distributed under the MIT License. See `LICENSE` for more information. + +

(back to top)