Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Task]: Improve automatic documentation generation #330

Open
igorpecovnik opened this issue Dec 22, 2024 · 0 comments
Open

[Task]: Improve automatic documentation generation #330

igorpecovnik opened this issue Dec 22, 2024 · 0 comments
Labels
Task/To-Do Project management: To-Do or task(s) someone is working on

Comments

@igorpecovnik
Copy link
Member

Task description

Current automation is making documentation a bit inhuman. Below is rendered example:

  • displaying status, authors, maintainers only at first item of the routine
  • reduce command

image

# Web hosting

## SWAG reverse proxy

**Status:** Stable

**Author:** @armbian

**Maintainer:** @armbian

<!--- section image START from tools/include/images/SWAG01.png --->
[![SWAG reverse proxy install](/images/SWAG01.png)](#)
<!--- section image STOP from tools/include/images/SWAG01.png --->


<!--- header START from tools/include/markdown/SWAG01-header.md --->
SWAG - Secure Web Application Gateway sets up an Nginx webserver and reverse proxy with php support and a built-in certbot client that automates free SSL server certificate generation and renewal processes (Let's Encrypt). It also contains fail2ban for intrusion prevention.

After entering required information, your server will have auto updating SSL secured website! To this website you can attach several services, for example: https://my.server.com/netdata will run [Netdata](https://www.netdata.cloud/) instance.

=== "Requirements"

    - this computer port 80 and 443 must be open to the internet
    - your domain name (myserver.mydomain.com) DNS server should point to your router WAN address
    - make sure to set additional .htpasswd username and password as you don't want to expose your services without password

=== "Directories"

    - Config directory: `/armbian/swag/config/`
    - Website root folder: `/armbian/swag/config/www/`
    - Reverse proxy configuration samples: `/armbian/swag/config/nginx/proxy-confs/`

=== "Advanced setup"

    - Please follow this comprehensive guide: <https://github.com/linuxserver/docker-swag>

<!--- header STOP from tools/include/markdown/SWAG01-header.md --->

**** 
~~~ bash title="SWAG reverse proxy install:"
armbian-config --cmd SWAG01
~~~

~~~ bash title="SWAG reverse proxy .htpasswd set"
armbian-config --cmd SWAG02
~~~

~~~ bash title="SWAG reverse proxy remove"
armbian-config --cmd SWAG02
~~~

~~~ bash title="SWAG reverse proxy purge data folder"
armbian-config --cmd SWAG02
~~~


## WEB server with limonade

**Status:** Stable

**Author:** @armbian

**Maintainer:** @armbian

~~~ bash title="Limonade"
armbian-config --cmd LIMO01
~~~
@igorpecovnik igorpecovnik added the Task/To-Do Project management: To-Do or task(s) someone is working on label Dec 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Task/To-Do Project management: To-Do or task(s) someone is working on
Projects
None yet
Development

No branches or pull requests

1 participant