upstream/opnsense-docs
1
0
Fork 0
mirror of https://github.com/opnsense/docs.git synced 2026-04-22 06:37:36 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
1473 commits 10 branches 0 tags 276 MiB
Commit graph

204 commits

Author SHA1 Message Date
Franco Fichtner
ebbe8bfdd4 development: document newwanip_map and some related things 2024-08-23 09:20:54 +02:00
TotalGriffLock
934a9d810b
Update helloworld.rst (#593) 
Correct a coding error in an example. The correct code is present in the example github repo, but incorrect in the docs.
 2024-08-20 08:48:45 +02:00
Stephan de Wit
55a3e6a7ab dashboard: update development documentation 2024-08-19 13:24:57 +02:00
Ad Schellevis
5e92a50d40
Dashboard: merge pending changes (#583) 
* development: add dashboard framework documentation

* dashboard: duplicate link

* dashboard: update development documentation

---------

Co-authored-by: Stephan de Wit <stephan.de.wit@deciso.com>
 2024-08-03 16:05:31 +02:00
Ad Schellevis
cb7e43f85c api docs 2024-07-24 15:36:58 +02:00
Ad Schellevis
13bb3d908c update api docs 2024-05-04 10:03:42 +02:00
Monviech
94ee5e68e6
Update models_fieldtypes.rst - Add example to display multiple fields (#551) 2024-04-05 14:40:09 +02:00
Ad Schellevis
e88821a9e1 development - add csv import/export helpers. closes https://github.com/opnsense/docs/issues/541 2024-03-17 19:51:39 +01:00
Ad Schellevis
2795d75201 development/frontend/models - add volatile option. closes https://github.com/opnsense/docs/issues/542 2024-03-17 19:02:18 +01:00
Ad Schellevis
6c154cfaeb api endpoints (plugins) 2024-02-20 15:52:06 +01:00
Ad Schellevis
9728f6cf56 api endpoints (core) 2024-02-20 15:51:39 +01:00
Ad Schellevis
5dfe37f0d6 development - add "special model types" 2024-02-19 11:13:30 +01:00
Ad Schellevis
f3522bd358 frontend/models_fieldtypes : HostnameField add IsDNSName parameter 2024-01-23 20:44:31 +01:00
Ad Schellevis
c5bed41355 development/configd - add documentation for new config imports introduced in a1b0dd8071 , closes https://github.com/opnsense/docs/issues/532 2024-01-23 16:42:44 +01:00
Stephan de Wit
ca43be6a7c Development: Frontend: add documentation for DescriptionField and IPPortField types 2024-01-11 16:05:55 +01:00
Stephan de Wit
7bba0a44a5 Development: Field Types: Add MacAddressField and update HostnameField 2024-01-08 10:53:10 +01:00
Vangsguard
943811aede
Resolved duplicates, organized requests in alphabetical order, and corrected inconsistencies. (#519) 2023-11-21 11:36:11 +01:00
Ad Schellevis
b5a0d6fe10 update api endpoints 2023-11-20 10:51:24 +01:00
Ad Schellevis
ea8d486124 Development manual/API reference - reading reference about parameters and expected responses. https://github.com/opnsense/core/issues/7014 2023-11-20 09:51:06 +01:00
Ad Schellevis
e99395a565 Development, remove monitor event from the list as discussed with @fichtner 2023-10-23 19:56:10 +02:00
Franco Fichtner
753cfb7f25 backend: "monitor" syshook is deprecated 2023-10-17 08:39:15 +02:00
Ad Schellevis
f5271e3014 Development/Backup - add Overview page explaining hooks and their order. closes https://github.com/opnsense/docs/issues/505 2023-10-16 16:27:09 +02:00
Ad Schellevis
a78a9e1333 Development Manual / Frontend / Fieldtypes - explain the new optgroup introduced in bc195308be , 9206823d60 2023-10-15 14:57:42 +02:00
Ad Schellevis
de581eef5c update api docs (using scripts) 2023-09-18 13:23:23 +02:00
Ad Schellevis
e747ad1300 manually update firmware page, closes https://github.com/opnsense/core/issues/6655 2023-07-07 12:05:15 +02:00
Ad Schellevis
8f5ea3663c update API docs 2023-07-07 10:59:17 +02:00
Ad Schellevis
9ea2587fae Development/ArrayField - add note for 3408cbf661 (getStaticChildren()) 2023-07-03 17:48:26 +02:00
Franco Fichtner
cd4ea75820 backend: add new "upgrade" facility and clarifications 2023-06-05 12:34:37 +02:00
Ad Schellevis
4fa1982188 Development manual / Frontend / Controllers - explain the use of searchRecordsetBase() 2023-05-09 17:00:17 +02:00
Ad Schellevis
4de4e97f44 update api endpoints 2023-03-28 08:58:44 +02:00
Stephan
cb798bef36 Field types: update new options for CSVListField and NetworkField 2023-03-06 10:37:21 +01:00
Ad Schellevis
f50316737e update api docs 2023-01-24 11:35:30 +01:00
Ad Schellevis
37acfd706b Development / API / ACL - fix compile issue 2022-12-29 16:59:21 +01:00
Ad Schellevis
9434789845 development/examples/api_enable_services - explain the use of invokeInterfaceRegistration to plugin interfaces when applicable. 2022-12-22 09:59:14 +01:00
Ad Schellevis
073d1e8cc9 Development / API / ACL - make people aware of access constraints and cleanup the old ACL page a bit. closes https://github.com/opnsense/docs/pull/438 2022-12-18 16:58:34 +01:00
Ad Schellevis
b337e4b85c update API docs 2022-11-24 19:06:26 +01:00
Ad Schellevis
45e1b74f36 Development Manual / API reference - Firewall and firewall plugin additions. 
o point people seeking for an API to manage rules to the os-firewall plugin
o in the plugin, remove the quote about future plans as these might change and doesn't add much to the topic
o explain general plugin usage in case anyone missed that
o provide a general tip on how to debug issues with API's while explaining the scope of the work at hand.

closes https://github.com/opnsense/docs/pull/437
 2022-11-24 18:57:04 +01:00
Ad Schellevis
2574773e67 Development / JS form control - alhough not in stable yet, it doesn't hurt to document 528474372b in advance. closes https://github.com/opnsense/docs/issues/433 2022-10-20 11:38:03 +02:00
Ad Schellevis
0549395c2d API docs - update using script 2022-10-19 17:21:08 +02:00
Franco Fichtner
a8ca640c59 plugins: document device hooks 2022-09-30 14:40:52 +02:00
Klaus
9632467483
#423:add directory structure for HelloWorld example (#426) 2022-08-22 13:49:54 +02:00
Klaus
e22bf400f3
add some captions to HelloWorld example (#424) 2022-08-18 18:09:18 +02:00
Dalton Burke
cde27f8ed1
Adjust template doc to match current code style (#421) 2022-08-06 08:41:12 +02:00
Ad Schellevis
29b88fdb76 Syslog-NG: deprecate circular logs. closes https://github.com/opnsense/docs/issues/357 2022-05-24 20:23:24 +02:00
Ad Schellevis
bc854e83f5 Development - ModelRelationField. add documentation for display_format field. closes https://github.com/opnsense/docs/issues/394 2022-05-24 16:43:11 +02:00
mmetc
b3be4953d6
removed duplicate "ConfigdActionsField" section (#388) 2022-05-23 16:37:30 +02:00
Ad Schellevis
c2e4a99879 style - fix some compile warnings 2022-04-26 15:21:15 +02:00
Ad Schellevis
818dc0e123 Development - update api docs 2022-04-13 17:25:36 +02:00
KoS
bd11903c46
Update firmware.rst (#395) 
POST is needed for core/firmware/status to check for updates
 2022-04-13 17:24:56 +02:00
Ad Schellevis
89523d5911
Opncentral (#383) 
* OPNcentral - work in progress upcoming features§

* OPNcentral - work in progress upcoming features

* Development / API reference - Add BE core API descriptions
 2022-03-03 14:27:28 +01:00
Ad Schellevis
7691de4e9d Development / Models / Field types 
Document available options, move item in the menu for better navigation.
 2022-02-23 17:01:48 +01:00
Ad Schellevis
92ccde40ca releasenotes and api doc sweep 2022-01-27 11:45:11 +01:00
Ad Schellevis
3f5aeebdfb change os references 2022-01-25 16:33:23 +01:00
kulikov-a
deaab7382b
note the parent method call necessity (#374) 2022-01-17 13:14:02 +01:00
Ad Schellevis
a138e2a5d4 update core api 2021-09-28 09:48:48 +02:00
Ad Schellevis
230b360874 21.7 update api endpoints 2021-07-28 15:59:13 +02:00
Franco Fichtner
0a5f23c70b development: +POST_INSTALL is automatic 
PR: https://forum.opnsense.org/index.php?topic=23921.0
 2021-07-14 09:05:50 +02:00
Franco Fichtner
c26b17f0c1 development: renamed earlybootup -> early for 21.7 2021-07-13 11:27:08 +02:00
Ad Schellevis
8f35702d44 source/development/workflow - add emacs as well 2021-04-08 10:02:27 +02:00
Gareth Owen
77a05b38a4
vim-tiny was renamed vim-console (#312) 
Replace reference to the `vim-tiny` package that was renamed to `vim-console` about 3 years ago.
 2021-04-08 09:55:02 +02:00
Ad Schellevis
334e1bdd82 XMLRPC (HA) sync: add optional services attribute 2021-03-24 14:01:39 +01:00
Franco Fichtner
70166cc650 firmware: update relevant docs to 21.1.3 state 2021-03-10 10:15:04 +01:00
Ad Schellevis
ae58540f44 api: update core 2021-03-08 12:23:28 +01:00
Ad Schellevis
d67cdbbc47 api: update plugins 2021-03-08 12:22:38 +01:00
Stephan de Wit
25995b591e
API: Add a note for postman users (#318) 2021-03-04 17:55:48 +01:00
Stephan de Wit
caeb04abb7
Fix typo (#311) 2021-02-12 16:07:46 +01:00
Ad Schellevis
4720f8ffbf update api docs, closes https://github.com/opnsense/docs/issues/310 2021-02-11 11:34:32 +01:00
Ad Schellevis
793f2418a6 build errors 2021-01-28 16:09:18 +01:00
Ad Schellevis
2766dd5f6f fix types, as suggested by @8191 2021-01-13 11:34:13 +01:00
Stephan de Wit
c466abda73
Add documentation for using dtrace on opnsense (#299) 2021-01-11 17:14:56 +01:00
Ad Schellevis
5629f2c7c5 Development: add documentation for Javascript helpers (https://github.com/opnsense/docs/issues/241) dialog wrappers 2020-12-21 18:25:36 +01:00
Ad Schellevis
aca5f2412c Development: add documentation for Javascript helpers (https://github.com/opnsense/docs/issues/241) $.UIBootgrid 2020-12-21 15:52:19 +01:00
Ad Schellevis
746d27f3ab Development: javascript helper docs for https://github.com/opnsense/docs/issues/241 (work in progress) 2020-12-18 10:52:12 +01:00
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