2
0
mirror of https://github.com/opnsense/docs synced 2024-11-18 21:28:29 +00:00
Commit Graph

131 Commits

Author SHA1 Message Date
Ad Schellevis
aa9583fdcc add base64 fieldtype for https://github.com/opnsense/core/issues/4398 2020-10-22 20:26:19 +02:00
Ad Schellevis
bf004ac276 development / syshook: document new config change event. closes https://github.com/opnsense/core/issues/4388
sponsored by : Modirum (https://www.modirum.com/)
2020-10-02 18:05:59 +02:00
Ad Schellevis
6e247e7b88 guidelines/basics PSR-12 2020-08-10 17:49:24 +02:00
Ad Schellevis
e4170c05eb Development: add some JS functions for https://github.com/opnsense/docs/issues/241 2020-08-09 17:40:58 +02:00
Ad Schellevis
51a8ab63b0 Development: add some view help, work in progress for https://github.com/opnsense/docs/issues/241 2020-08-09 14:20:40 +02:00
Ad Schellevis
c6cfdd7dd7 Development: safeguard user input should be part of the basics. 2020-08-09 14:02:10 +02:00
Ad Schellevis
dadbd2ef14 api: sync plugins 2020-08-09 10:29:46 +02:00
Ad Schellevis
e09b314963 api: sync core 2020-08-09 10:29:12 +02:00
Ad Schellevis
665a5cab29 API: sync plugins (master) 2020-07-19 19:34:24 +02:00
Ad Schellevis
d35460ddd9 API: update core endpoints (from master) 2020-07-19 19:29:07 +02:00
Ad Schellevis
378aa6e2dc development/backend: syslog, remote keyword is not being used anymore 2020-05-18 11:54:29 +02:00
Ad Schellevis
da130a0598 Syslog-NG: add documentation for https://github.com/opnsense/core/issues/4068 2020-05-12 16:58:46 +02:00
Ad Schellevis
9b74bef4fe fix previous 2020-04-07 20:53:31 +02:00
Ad Schellevis
6588a2c064 API: core, add attached models in tables when using standard templates. 2020-04-07 20:49:44 +02:00
Ad Schellevis
2ec2ca7e86 API: plugins, add models for standard templates. 2020-04-07 20:48:40 +02:00
Ad Schellevis
6700e6c2ac os-firewall: add new endpoints (using extended template) for https://github.com/opnsense/plugins/issues/1749 2020-04-07 20:47:37 +02:00
Ad Schellevis
29a1e05df7 Shaper: add statistics endpoint for https://github.com/opnsense/core/issues/3994 2020-04-07 12:57:52 +02:00
Ad Schellevis
9d15b497f5 Firewall / alias: add listNetworkAliases endpoint 2020-04-07 12:56:02 +02:00
Ad Schellevis
9fd2e62d1e Interfaces / Diagnostics: add api endpoints for https://github.com/opnsense/core/issues/4013 2020-04-07 12:54:24 +02:00
Ad Schellevis
5372a5bcad PSR-12: add/format copy of https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-12-extended-coding-style-guide.md closes https://github.com/opnsense/docs/issues/244 2020-03-26 13:34:53 +01:00
Ad Schellevis
7b04b98f00 Development:MVC, add migration section. closes https://github.com/opnsense/docs/issues/246
ref: https://github.com/opnsense/plugins/issues/1749
2020-03-26 10:26:27 +01:00
Ad Schellevis
e52e381aed firewall add api docs and examples for https://github.com/opnsense/plugins/issues/1720 2020-03-12 17:47:10 +01:00
Ad Schellevis
0e8b82886d api: stylesweep using the new collect_api_endpoints.py script 2020-03-11 10:02:53 +01:00
Ad Schellevis
41186eb9cd MVC: add NetworkAliasField (introduced https://github.com/opnsense/plugins/issues/1720) 2020-03-09 12:42:12 +01:00
Ad Schellevis
35fea4c042 MVC: add ProtocolField (introduced https://github.com/opnsense/plugins/issues/1720) 2020-02-28 17:39:44 +01:00
ServiusHack
2b17226313
fix formatting (#240)
Move text out of literal block used for the file path.
2020-02-27 08:32:53 +01:00
Ad Schellevis
a5b3177774 MVC: explain new LegacyLinkField type 2020-02-24 13:41:20 +01:00
Ad Schellevis
db00ba0160 API/plugins: update to stable/20.1. closes https://github.com/opnsense/plugins/issues/1698 while there 2020-02-16 16:11:37 +01:00
Ad Schellevis
6d3dbaedfc API: core api's 20.1 update 2020-02-16 16:08:40 +01:00
Ad Schellevis
e9e70acc0e Development: explain ApiMutableServiceControllerBase and refer to examples from controller documentation (controller.rst contains the concepts, examples are more suited to explain the use in this case) 2020-02-04 14:28:38 +01:00
Michael
806a30c559 Update vnstat.rst (#230) 2020-01-10 16:05:18 +01:00
Ad Schellevis
69d4794747 cleanup previous 2019-11-14 18:14:49 +01:00
Ad Schellevis
3a7afc2e45 Models / explain custom fieldtypes. closes https://github.com/opnsense/docs/issues/215 2019-11-14 17:09:59 +01:00
Ad Schellevis
f4d9a1e44d models, minor fixes in previous 2019-11-04 21:51:37 +01:00
Ad Schellevis
849e3b391d add model constraints and field types, closes https://github.com/opnsense/docs/issues/212 2019-11-03 19:47:19 +01:00
Ad Schellevis
68f02106a7 move modelConstraints.rst 2019-11-03 17:52:16 +01:00
Fabian Franz
cc1561556c fix typo 2019-10-30 19:18:14 +01:00
Fabian Franz
cb43dedbb5 #212: add contraints by me to doc 2019-10-30 19:14:49 +01:00
Ad Schellevis
b03b837408 add carp_service_status documentation. closes https://github.com/opnsense/docs/issues/193 2019-08-19 14:37:12 +02:00
Ad Schellevis
31185cd649 fix typo in autorun.rst 2019-08-19 11:40:22 +02:00
Ad Schellevis
6939952f54 development/plugins, add hooks and extend documentation for the rest. 2019-08-12 14:04:58 +02:00
Ad Schellevis
d64f454fb2 add using_grids.rst 2019-07-18 13:55:23 +02:00
Ad Schellevis
44d3d7498a fix previous 2019-07-17 17:39:20 +02:00
Ad Schellevis
b4ddcc82c3 dev/helloworld, move locations to code-blocks 2019-07-17 17:19:52 +02:00
Ad Schellevis
3dff72d456 dev/helloworld, reference ui_devtools for easy frontend development 2019-07-17 13:13:48 +02:00
Ad Schellevis
2c5f2bc3ea dev/helloworld missing file in filelist 2019-07-17 13:10:36 +02:00
Ad Schellevis
88422dbd0c devel/helloworld example. add ApiMutableModelControllerBase into the mix 2019-07-17 11:55:02 +02:00
Franco Fichtner
45900e23db document https://github.com/opnsense/core/issues/3288 2019-07-08 17:28:51 +02:00
fvanroie
7417ee1200 Add DnsCrypt API documentation (#172) 2019-05-30 15:34:53 +02:00
Franco Fichtner
b34106b025 dev: document monitor rc.syshook facility 2019-04-29 13:57:09 +02:00
Ad Schellevis
229c02dd73 minor build error, code-block type issue. 2019-04-28 18:28:42 +02:00
Ad Schellevis
9e3dde4c31 typo 2019-03-08 10:49:57 +01:00
Ad Schellevis
43c535e765 fix some build errors 2019-03-08 09:31:58 +01:00
Ad Schellevis
31944dd01b Development/how-to's add a simple doc about remote kernel debugging. 2019-03-07 17:52:33 +01:00
Michael Steenbeek
5cb6b3a325 Use consistent, RST menu notation; fix some build warnings (#144) 2019-03-06 18:27:21 +01:00
Franco Fichtner
fd642e2448 some tweaks to PAM doc 2019-02-27 17:27:28 +01:00
Ad Schellevis
3566ac7b85 align docs with new authentication scheme (https://github.com/opnsense/core/issues/3242) 2019-02-27 17:09:52 +01:00
Ad Schellevis
ed655c6002 authentication, process review comments 2019-02-21 21:22:03 +01:00
Ad Schellevis
53c89fb7da Development, let's shed some light on authentication. 2019-02-21 21:02:12 +01:00
Ad Schellevis
34b6ac99a1 change os references to HardenedBSD 2019-02-01 14:51:43 +01:00
Clément Ruiz
10ec243a53 Adding documentation for backup-api (#119) 2019-01-29 20:31:01 +01:00
MichaelDeciso
d1c5ac2798 Another round of corrections (#84) 2018-11-09 13:52:31 +01:00
MichaelDeciso
3756ed16fa More corrections (#82) 2018-11-09 12:18:28 +01:00
MichaelDeciso
020c7c74ec Many typo fixes and some rewording (#80) 2018-11-08 20:59:18 +01:00
MichaelDeciso
86a9787cf3 Fix scaling of small images, fix typos, clarify IPsec s2s (#78) 2018-11-07 17:45:54 +01:00
Michael
a704380a7c Add bind and frr to API (#50) 2018-09-30 12:13:51 +02:00
Michael
5759b351b2 new api docs (#48) 2018-09-22 11:27:11 +02:00
Franco Fichtner
407cf904a9 update rc.syshook usage, will change in 18.1.11 2018-06-23 19:29:01 +02:00
Franco Fichtner
7b0c44c6ac configd: avoid ||, clarify description even more 2018-05-18 10:41:29 +02:00
Ad Schellevis
632a173566 MVC, add note for non common fieldtypes 2018-05-12 18:23:20 +02:00
Franco Fichtner
147a482e62 hyphen is better for reading flow 2018-05-07 00:49:25 +02:00
Franco Fichtner
5dc0e7a619 finally document description side effect
PR: https://github.com/opnsense/core/issues/2395
2018-05-07 00:44:51 +02:00
Ad Schellevis
d9f2b20807 restructure api doc section https://github.com/opnsense/docs/pull/24 as agreed with @fvanroie 2018-05-06 15:25:26 +02:00
Ad Schellevis
e9f89baab9 fix some build warnings 2018-05-06 14:10:53 +02:00
CJ
fa2f7fd8de API Reference documentation (#24) 2018-05-06 13:58:33 +02:00
tpltnt
8eeefe7ec8 linked to PEP8 and style checker 2018-03-31 09:07:54 +02:00
tpltnt
f208b8b44d added wikipedia link for ABI 2018-03-31 09:06:46 +02:00
tpltnt
baab58c6df Basics links (#17) 2018-03-31 09:03:25 +02:00
Fabian Franz
bd03a82e80 remove title in tutorial - it is now set by the menu config 2018-02-12 07:19:26 +01:00
Franco Fichtner
9d86c3ce53 more tweaks like previous 2018-02-04 13:11:03 +01:00
jschellevis
9aa470246f Initial version of the freely available OPNsense documentation project, original commiters are listed in LICENSE file. 2018-01-30 11:40:13 +01:00