stove/rougail
3
0
Fork 0
Code Issues 5 Pull requests 1 Projects Releases Wiki Activity

fix: tuto 08* and add tutorial links

Browse source
This commit is contained in:
gwen 2026-05-05 13:37:23 +02:00
parent 64229f9169
commit 820fb9c736
1 changed files with 13 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
docs/tutorial/customtype.rst
View file

@ -106,11 +106,15 @@ Let's modify the existing family using this new `proxy` type:
type: proxy type: proxy
... ...
We can see that the type declared for the `http_proxy` family is now `type: proxy`. We can see that the type declared for the `http_proxy` family is now `type: proxy`.
It's perfectly natural in the Rougail style. It's perfectly natural in the Rougail style.
But in order to use our new type we need to declare it to Rougail otherwise the new type is not available. Due to the type definition we can "omit" some settings in the structure file
such as the `domainname` type and the `allow_ip` parameter.
And the `address` variable it is not necessary to be specified at all in the structure file
because it's in the type definition.
In order to use our new type we need to declare it to Rougail otherwise the new type is not available.
The Rougail CLI has the `--types` type declaration command line option for this purpose. The Rougail CLI has the `--types` type declaration command line option for this purpose.
Let's launch the Rougail CLI with this command line parameter: Let's launch the Rougail CLI with this command line parameter:
@ -126,28 +130,17 @@ We want the same behavior as usual.
:url: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_080/config/01/output_ro.html :url: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_080/config/01/output_ro.html
:class: output :class: output
The type definition adds nothing to the structural logic. It's just a very convenient way to save time when writing structure files.
Now in the `address` variable it is not necessary to be specified and all parameters (the `domainname` type and the `allow_ip` parameter) are available:
.. code-block:: yaml
:caption: We can omit these settings now due to the type definition
description: HTTP address
type: domainname
params:
allow_ip: true
HTTPS and SOCKS Proxy with "proxy" type HTTPS and SOCKS Proxy with "proxy" type
--------------------------------------- ---------------------------------------
.. type-along:: For those who follow the tutorial with the help of the git repository .. type-along:: For those who follow the tutorial with the help of the git repository
Now you need to checkout the `v1.1_081` version:: Now you need to checkout the :tutorial:`v1.1_081 <src/tag/v1.1_081/README.md>` version:
git switch --detach v1.1_081 git switch --detach v1.1_081
With this use of a type, it is possible to define our HTTPS and SOCKS Proxy in a much more conscious way: With this use of a type, it is possible to define our HTTPS and SOCKS Proxy in a much more conscious way:
It's very practical. In fact, the type definition adds nothing else to the structural logic.
.. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_081/firefox/20-manual.yml .. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_081/firefox/20-manual.yml
:language: yaml :language: yaml
@ -184,7 +177,7 @@ Add a variable in a family with custom type
.. type-along:: For those who follow the tutorial with the help of the git repository .. type-along:: For those who follow the tutorial with the help of the git repository
Now you need to checkout the `v1.1_082` version:: Now you need to checkout the :tutorial:`v1.1_082 <src/tag/v1.1_082/README.md>` version::
git switch --detach v1.1_082 git switch --detach v1.1_082
@ -209,7 +202,7 @@ Redefine default value in custom type variable
.. type-along:: For those who follow the tutorial with the help of the git repository .. type-along:: For those who follow the tutorial with the help of the git repository
Now you need to checkout the `v1.1_083` version:: Now you need to checkout the :tutorial:`v1.1_083 <src/tag/v1.1_083/README.md>` version::
git switch --detach v1.1_083 git switch --detach v1.1_083
@ -379,7 +372,7 @@ Redefine other parameter in custom type for HTTP
.. type-along:: For those who follow the tutorial with the help of the git repository .. type-along:: For those who follow the tutorial with the help of the git repository
Now you need to checkout the `v1.1_084` version:: Now you need to checkout the :tutorial:`v1.1_084 <src/tag/v1.1_084/README.md>` version::
git switch --detach v1.1_084 git switch --detach v1.1_084
@ -494,7 +487,7 @@ Redefine other parameter in custom type for HTTPS and SOCKS
.. type-along:: For those who follow the tutorial with the help of the git repository .. type-along:: For those who follow the tutorial with the help of the git repository
Now you need to checkout the `v1.1_085` version:: Now you need to checkout the :tutorial:`v1.1_085 <src/tag/v1.1_085/README.md>` version::
git switch --detach v1.1_085 git switch --detach v1.1_085