summaryrefslogtreecommitdiff
path: root/docs/configuration/service/rst-https.rst
diff options
context:
space:
mode:
authorYuriy Andamasov <yuriy@vyos.io>2026-05-10 17:27:05 +0300
committerYuriy Andamasov <yuriy@vyos.io>2026-05-10 17:27:05 +0300
commite7a0bebdb5dc4b436b8b610bcb4f01afc33152e0 (patch)
treed9ad6bc834c8e5240c300dff6d47841c2787ce61 /docs/configuration/service/rst-https.rst
parent15855844e1fe5b0bd39b020639f4c08c69d24864 (diff)
downloadvyos-documentation-e7a0bebdb5dc4b436b8b610bcb4f01afc33152e0.tar.gz
vyos-documentation-e7a0bebdb5dc4b436b8b610bcb4f01afc33152e0.zip
chore: remove RST swap mechanism, archive rst-*.rst under docs/_rst_legacy/
The swap mechanism (RST-as-fallback for migrated MD pages) is dormant — docs/_rst_overrides.txt has been empty since the MyST flip trio landed. The mechanism's surface area is dead weight and the rst-*.rst shadows scattered across the source tree cause Context7's parser to misclassify the project as RST. Sibling PRs: - yuriy/remove-rst-swap-mechanism (rolling) - yuriy/remove-rst-swap-mechanism-circinus Changes: - Move 210 rst-*.rst shadow files into docs/_rst_legacy/ preserving subdirectory structure. They remain in the repo for reference; Sphinx excludes the folder via exclude_patterns. - Strip swap_sources.py invocation from docs/Makefile. - Strip rst-*.rst exclude entry and the _md_exclude.txt loader from docs/conf.py; replace with a single _rst_legacy exclude. - Delete scripts/swap_sources.py, tests/test_swap_sources.py, docs/_rst_overrides.txt. - Update AGENTS.md: drop the "RST override mechanism" section and the test-runner snippet for the deleted test. Note: .readthedocs.yml on sagitta has no jobs: block to remove (the swap was wired only at build-time via the Makefile chain on this branch). Verified: sphinx-build -b html with --keep-going produces identical warning set (409 unique — pre-existing cli.rst/aws.rst title-level warnings on this branch), identical sitemap entry count (215), identical llms.txt entry count (23), zero rst-* URLs in any artifact. 🤖 Generated by [robots](https://vyos.io)
Diffstat (limited to 'docs/configuration/service/rst-https.rst')
-rw-r--r--docs/configuration/service/rst-https.rst83
1 files changed, 0 insertions, 83 deletions
diff --git a/docs/configuration/service/rst-https.rst b/docs/configuration/service/rst-https.rst
deleted file mode 100644
index 973c5355..00000000
--- a/docs/configuration/service/rst-https.rst
+++ /dev/null
@@ -1,83 +0,0 @@
-.. _http-api:
-
-########
-HTTP API
-########
-
-VyOS provide an HTTP API. You can use it to execute op-mode commands,
-update VyOS, set or delete config.
-
-Please take a look at the :ref:`vyosapi` page for an detailed how-to.
-
-*************
-Configuration
-*************
-
-.. cfgcmd:: set service https allow-client address <address>
-
- Only allow certain IP addresses or prefixes to access the https
- webserver.
-
-.. cfgcmd:: set service https certificates ca-certificate <name>
-
- Use CA certificate from PKI subsystem
-
-.. cfgcmd:: set service https certificates certificate <name>
-
- Use certificate from PKI subsystem
-
-.. cfgcmd:: set service https certificates dh-params <name>
-
- Use :abbr:`DH (Diffie–Hellman)` parameters from PKI subsystem.
- Must be at least 2048 bits in length.
-
-.. cfgcmd:: set service https listen-address <address>
-
- Webserver should only listen on specified IP address
-
-.. cfgcmd:: set service https port <number>
-
- Webserver should listen on specified port.
-
- Default: 443
-
-.. cfgcmd:: set service https enable-http-redirect
-
- Enable automatic redirect from http to https.
-
-.. cfgcmd:: set service https tls-version <1.2 | 1.3>
-
- Select TLS version used.
-
- This defaults to both 1.2 and 1.3.
-
-.. cfgcmd:: set service https vrf <name>
-
- Start Webserver in given VRF.
-
-API
-===
-
-.. cfgcmd:: set service https api keys id <name> key <apikey>
-
- Set a named api key. Every key has the same, full permissions
- on the system.
-
-.. cfgcmd:: set service https api debug
-
- To enable debug messages. Available via :opcmd:`show log` or
- :opcmd:`monitor log`
-
-.. cfgcmd:: set service https api strict
-
- Enforce strict path checking
-
-*********************
-Example Configuration
-*********************
-
-Set an API-KEY is the minimal configuration to get a working API Endpoint.
-
-.. code-block:: none
-
- set service https api keys id MY-HTTPS-API-ID key MY-HTTPS-API-PLAINTEXT-KEY