You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Franco Fichtner 5edd0b2122 system: regenerate DH params 1 day ago
.github/ISSUE_TEMPLATE src: whitespace sweep 3 months ago
Keywords Keywords: do not hint at deleting files needed 1 year ago
Mk system: replace syslog-ng version via build 2 months ago
Scripts cleanup, remove some helpers that where useful back in 2015 to search dependencies in legacy files. Don't want to upgrade them to python3, since we don't use this anymore. 7 months ago
contrib Switch backup to Google api php client v2 (#3778) 1 month ago
src system: regenerate DH params 1 day ago
work make: improve previous and add `upgrade' target while at it 3 years ago
+POST_INSTALL firmware: add update syshook; closes #3288 5 months ago
+PRE_DEINSTALL firmware: kill the firmware-product.last trick 1 year ago
.editorconfig accidentally removed .editorconfig 2 years ago
.gitignore firmware: rename "opnsense" version file to "core" 1 year ago
CONTRIBUTING.md Update CONTRIBUTING.md 1 month ago
LICENSE LICENSE: sync 2 months ago
Makefile pkg: suricata with RUST builtin doesn't work everywhere yet 1 month ago
README.md change os references to HardenedBSD 10 months ago
plist pkg: fix plist 1 day ago
ruleset.xml make: change to PSR12 standard style, lots of noise coming up 2 months ago

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.

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!

License

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

http://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 HardenedBSD compatible package/ports origin
  • FLAVOUR: can be set to “OpenSSL” (default) or “LibreSSL”
  • 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

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 serveral syntax checks on the repository. This is recommended before issuing a pull request on GitHub.

make style

Run the PSR2 and PEP8 style checks on MVC PHP code and Python, respectively.

make sweep

Run Linux Kernel cleanfile whitespace sanitiser on all files.