Go to file
Franco Fichtner e4401b420f mvc: for consistency 2024-05-29 09:17:49 +02:00
.github/ISSUE_TEMPLATE remove OpenSSL flavor from bug template (https://github.com/opnsense/src/pull/189) 2023-11-11 15:42:17 +01:00
Keywords src: strip all $FreeBSD$ tags to follow src.git 2023-09-06 08:20:29 +02:00
Mk make: bring version-specific code closer together 2024-04-30 08:21:19 +02:00
Scripts License: sort better 2022-10-27 09:07:44 +02:00
contrib IXR_Library.php - minor cleanups, partly borrowed from https://github.com/kissifrot/php-ixr. closes https://github.com/opnsense/core/issues/5911 2022-09-21 17:01:23 +02:00
src mvc: for consistency 2024-05-29 09:17:49 +02:00
work make: improve previous and add `upgrade' target while at it 2016-03-12 09:26:20 +01:00
+POST_INSTALL firmware: deal with *.pkgsave, offload post install bits to rc.syshook 2021-01-14 09:20:33 +01:00
+PRE_DEINSTALL firmware: kill the firmware-product.last trick 2018-09-16 20:42:49 +02:00
.editorconfig accidentally removed .editorconfig 2017-07-30 15:14:59 +02:00
.gitignore firmware: rename "opnsense" version file to "core" 2018-11-28 09:30:09 +01:00
CONTRIBUTING.md Improve CONTRIBUTING 2023-06-07 14:51:43 +02:00
LICENSE dhcrelay: migrate IPv6 data, consolidation cleanups #6983 2024-03-13 18:00:31 +01:00
Makefile make: add a little stable branch helper 2024-05-17 08:46:28 +02:00
README.md Improve CONTRIBUTING 2023-06-07 14:51:43 +02:00
SECURITY.md Fix some typos (#6598) 2023-06-04 10:38:04 +02:00
plist system: replace single-script backend call with a plugin configure hook 2024-05-29 07:57:34 +02:00
ruleset.xml make: change to PSR12 standard style, lots of noise coming up 2019-10-07 16:17:37 +02:00

README.md

OPNsense GUI and system management

The OPNsense project invites developers to start contributing to the code base. For your own purposes or even better to join us in creating the best open source firewall available.

The build process has been designed to make it easy for anyone to build and write code. The main outline of the new codebase is available at:

https://docs.opnsense.org/development/architecture.html

Our aim is to gradually evolve to a new codebase instead of using a big bang approach into something new.

Coverity Scan Build Status

Build tools

To create working software like OPNsense you need the sources and the tools to build it. The build tools for OPNsense are freely available.

Notes on how to build OPNsense can be found in the tools repository:

https://github.com/opnsense/tools

Contribute

You can contribute to the project in many ways, e.g. testing functionality, sending in bug reports or creating pull requests directly via GitHub. Any help is always very welcome!

You can learn more about contributing on CONTRIBUTING.md.

License

OPNsense is and will always be available under the 2-Clause BSD license:

https://opensource.org/licenses/BSD-2-Clause

Every contribution made to the project must be licensed under the same conditions in order to keep OPNsense truly free and accessible for everybody.

Makefile targets

The repository offers a couple of targets that either tie into tools.git build processes or are aimed at fast development.

make package

A package of the current state of the repository can be created using this target. It may require several packages to be installed. The target will try to assist in case of failure, e.g. when a missing file needs to be fetched from an external location.

Several OPTIONS exist to customise the package, e.g.:

  • CORE_DEPENDS: a list of required dependencies for the package
  • CORE_DEPENDS_ARCH: a list of special -required packages
  • CORE_ORIGIN: sets a FreeBSD compatible package/ports origin
  • CORE_COMMENT: a short description of the package
  • CORE_MAINTAINER: email of the package maintainer
  • CORE_WWW: web url of the package
  • CORE_NAME: sets a package name

Options are passed in the following form:

# make package CORE_NAME=my_new_name

In general, options are either set to sane defaults or automatically detected at runtime.

make update

Update will pull the latest commits from the current branch from the upstream repository.

make upgrade

Upgrade will run the package build and replace the currently installed package in the system.

make collect

Fetch changes from the running system for all known files.

make lint

Run several syntax checks on the repository. This is recommended before issuing a pull request on GitHub.

make style

Run the PSR12 and PEP8 style checks on MVC PHP code and Python, respectively. For php code you will need to have phpcs and phpcbf installed.

You can use the package php-codesniffer on Debian/Ubuntu. Python code will require pycodestyle.

For easier development you may want to use an OPNsense VM and run: pkg install os-debug that will install all the necessary tools.

make sweep

Run Linux Kernel cleanfile whitespace sanitiser on all files.