[tutorial v1.1_105)] xxx (config and doc)
This commit is contained in:
parent
ad35430323
commit
6fef540313
1 changed files with 159 additions and 13 deletions
172
README.md
172
README.md
|
|
@ -1,9 +1,9 @@
|
|||
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
|
||||
- [[tutorial v1.1_103] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_103/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_103~1..v1.1_103))
|
||||
- [[tutorial v1.1_104] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_104/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_104~1..v1.1_104))
|
||||
|
||||
# [tutorial v1.1_104)] xxx
|
||||
# [tutorial v1.1_105)] xxx
|
||||
|
||||
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_104~1..v1.1_104)
|
||||
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_105~1..v1.1_105)
|
||||
|
||||
|
||||
## Screenshot
|
||||
|
|
@ -293,13 +293,114 @@ proxies:
|
|||
{%- endfor -%}
|
||||
description: random color value
|
||||
auto_save: true
|
||||
|
||||
address:
|
||||
description: IP address, DNS name, server name
|
||||
type: domainname
|
||||
params:
|
||||
allow_ip: true
|
||||
allow_without_dot: true
|
||||
default:
|
||||
jinja: >-
|
||||
{% if firefox.manual.http_proxy.address is not propertyerror %}
|
||||
{{ firefox.manual.http_proxy.address }}
|
||||
{% endif %}
|
||||
description: copy HTTP address if proxy is not "Manual"
|
||||
disabled:
|
||||
jinja: |-
|
||||
{% if _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] %}
|
||||
disabled
|
||||
{% endif %}
|
||||
description: |-
|
||||
if type not in:
|
||||
- HTTP
|
||||
- HTTPS/SSL
|
||||
- SOCKS4
|
||||
- SOCKS5
|
||||
|
||||
port:
|
||||
description: Port
|
||||
type: port
|
||||
default:
|
||||
jinja: >-
|
||||
{% if firefox.manual.http_proxy.port is not propertyerror %}
|
||||
{{ firefox.manual.http_proxy.port }}
|
||||
{% endif %}
|
||||
description: copy HTTP port if proxy is not "Manual"
|
||||
disabled:
|
||||
jinja: |-
|
||||
{% if _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] %}
|
||||
disabled
|
||||
{% endif %}
|
||||
description: |-
|
||||
if type not in:
|
||||
- HTTP
|
||||
- HTTPS/SSL
|
||||
- SOCKS4
|
||||
- SOCKS5
|
||||
|
||||
username:
|
||||
description: Username
|
||||
type: unix_user
|
||||
mandatory:
|
||||
jinja: |-
|
||||
{% if _.password is not propertyerror and _.password %}
|
||||
username is mandatory
|
||||
{% endif %}
|
||||
description: if a password is set
|
||||
disabled:
|
||||
jinja: |-
|
||||
{% if _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] %}
|
||||
disabled
|
||||
{% endif %}
|
||||
description: |-
|
||||
if type not in:
|
||||
- HTTP
|
||||
- HTTPS/SSL
|
||||
- SOCKS4
|
||||
- SOCKS5
|
||||
|
||||
password:
|
||||
description: Password
|
||||
type: secret
|
||||
mandatory: false
|
||||
disabled:
|
||||
jinja: |-
|
||||
{% if _.type not in ['HTTP', 'HTTPS/SSL', 'SOCKS4', 'SOCKS5'] %}
|
||||
disabled
|
||||
{% endif %}
|
||||
description: |-
|
||||
if type not in:
|
||||
- HTTP
|
||||
- HTTPS/SSL
|
||||
- SOCKS4
|
||||
- SOCKS5
|
||||
|
||||
url:
|
||||
description: URL
|
||||
type: web_address
|
||||
default:
|
||||
jinja: >-
|
||||
{% if firefox.auto is not propertyerror %}
|
||||
{{ firefox.auto }}
|
||||
{% endif %}
|
||||
description: copy HTTP address if proxy is "Auto"
|
||||
disabled:
|
||||
jinja: |-
|
||||
{% if _.type not in ['PAC URL', 'WPAD'] %}
|
||||
proxy does not need url
|
||||
{% endif %}
|
||||
description: |-
|
||||
if type is not in:
|
||||
- PAC URL
|
||||
- WPAD
|
||||
...
|
||||
|
||||
```
|
||||
### Let's generate the documentation
|
||||
|
||||
```console
|
||||
foo@bar:~$ git switch --detach v1.1_104
|
||||
foo@bar:~$ git switch --detach v1.1_105
|
||||
foo@bar:~$ rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --modes_level basic standard advanced -o doc
|
||||
```
|
||||
#### Variables for "Firefox"
|
||||
|
|
@ -392,26 +493,71 @@ This family contains lists of variable blocks
|
|||
| **foxyproxy.proxies.title**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `unique` `multiple` | Title or Description. |
|
||||
| **foxyproxy.proxies.type**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Proxy Type.<br/>**Choices**: <br/>- HTTP<br/>- HTTPS/SSL<br/>- SOCKS4<br/>- SOCKS5<br/>- PAC URL<br/>- WPAD<br/>- System (use system settings)<br/>- Direct (no proxy) **← (default)** |
|
||||
| **foxyproxy.proxies.color**<br/>[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | Color.<br/>**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"<br/>**Default**: random color value |
|
||||
| **foxyproxy.proxies.address**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | IP address, DNS name, server name.<br/>**Validators**: <br/>- the domain name can be a hostname<br/>- the domain name can be an IP<br/>**Default**: copy HTTP address if proxy is not "Manual"<br/>**Disabled**: if type not in:
|
||||
- HTTP
|
||||
- HTTPS/SSL
|
||||
- SOCKS4
|
||||
- SOCKS5 |
|
||||
| **foxyproxy.proxies.port**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | Port.<br/>**Validators**: <br/>- well-known ports (1 to 1023) are allowed<br/>- registred ports (1024 to 49151) are allowed<br/>- private ports (greater than 49152) are allowed<br/>**Default**: copy HTTP port if proxy is not "Manual"<br/>**Disabled**: if type not in:
|
||||
- HTTP
|
||||
- HTTPS/SSL
|
||||
- SOCKS4
|
||||
- SOCKS5 |
|
||||
| **foxyproxy.proxies.username**<br/>[`unix_user`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`mandatory`* *`disabled`* | Username.<br/>**Mandatory**: if a password is set<br/>**Disabled**: if type not in:
|
||||
- HTTP
|
||||
- HTTPS/SSL
|
||||
- SOCKS4
|
||||
- SOCKS5 |
|
||||
| **foxyproxy.proxies.password**<br/>[`secret`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`disabled`* | Password.<br/>**Disabled**: if type not in:
|
||||
- HTTP
|
||||
- HTTPS/SSL
|
||||
- SOCKS4
|
||||
- SOCKS5 |
|
||||
| **foxyproxy.proxies.url**<br/>[`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | URL.<br/>**Validator**: the domain name in web address can be only a hostname<br/>**Default**: copy HTTP address if proxy is "Auto"<br/>**Disabled**: if type is not in:
|
||||
- PAC URL
|
||||
- WPAD |
|
||||
|
||||
### Let's generate the changelog
|
||||
|
||||
```console
|
||||
foo@bar:~$ git switch --detach v1.1_104
|
||||
foo@bar:~$ git switch --detach v1.1_105
|
||||
foo@bar:~$ rougail -m firefox/ -s Firefox -xn FoxyProxy -xd 0 foxyproxy/ --modes_level basic standard advanced -o doc --doc.contents changelog
|
||||
```
|
||||
#### New variable
|
||||
#### New variables
|
||||
|
||||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **foxyproxy.proxies.type**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Proxy Type.<br/>**Choices**: <br/>- HTTP<br/>- HTTPS/SSL<br/>- SOCKS4<br/>- SOCKS5<br/>- PAC URL<br/>- WPAD<br/>- System (use system settings)<br/>- Direct (no proxy) **← (default)** |
|
||||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **foxyproxy.proxies.address**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | IP address, DNS name, server name.<br/>**Validators**: <br/>- the domain name can be a hostname<br/>- the domain name can be an IP<br/>**Default**: copy HTTP address if proxy is not "Manual"<br/>**Disabled**: if type not in:
|
||||
- HTTP
|
||||
- HTTPS/SSL
|
||||
- SOCKS4
|
||||
- SOCKS5 |
|
||||
| **foxyproxy.proxies.port**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | Port.<br/>**Validators**: <br/>- well-known ports (1 to 1023) are allowed<br/>- registred ports (1024 to 49151) are allowed<br/>- private ports (greater than 49152) are allowed<br/>**Default**: copy HTTP port if proxy is not "Manual"<br/>**Disabled**: if type not in:
|
||||
- HTTP
|
||||
- HTTPS/SSL
|
||||
- SOCKS4
|
||||
- SOCKS5 |
|
||||
| **foxyproxy.proxies.username**<br/>[`unix_user`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`mandatory`* *`disabled`* | Username.<br/>**Mandatory**: if a password is set<br/>**Disabled**: if type not in:
|
||||
- HTTP
|
||||
- HTTPS/SSL
|
||||
- SOCKS4
|
||||
- SOCKS5 |
|
||||
| **foxyproxy.proxies.password**<br/>[`secret`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` *`disabled`* | Password.<br/>**Disabled**: if type not in:
|
||||
- HTTP
|
||||
- HTTPS/SSL
|
||||
- SOCKS4
|
||||
- SOCKS5 |
|
||||
| **foxyproxy.proxies.url**<br/>[`web_address`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` *`disabled`* | URL.<br/>**Validator**: the domain name in web address can be only a hostname<br/>**Default**: copy HTTP address if proxy is "Auto"<br/>**Disabled**: if type is not in:
|
||||
- PAC URL
|
||||
- WPAD |
|
||||
|
||||
#### Modified variable
|
||||
|
||||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **foxyproxy.proxies.color**<br/>[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | Color.<br/>**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"<br/>**Default**: random color value |
|
||||
| Variable | Description |
|
||||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **foxyproxy.proxies.color**<br/>[`regexp`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` `auto modified` | Color.<br/>**Validator**: text based with regular expressions "^#(?:[0-9a-f]{3}){1,2}$"<br/>**Default**: random color value |
|
||||
|
||||
|
||||
|
||||
|
||||
- [[tutorial v1.1_105] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_105/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_105~1..v1.1_105))
|
||||
- [[tutorial v1.1_110] xxx](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_110/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_110~1..v1.1_110))
|
||||
|
|
|
|||
Loading…
Reference in a new issue