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 584f86570d firmware: move previous to v= since it special handling for it already exists 1 day ago
.github/ISSUE_TEMPLATE github: extend templates 1 year ago
Keywords Keywords: do not hint at deleting files needed 4 years ago
Mk make: populate CORE_MAKE command with proper env on stepping stones 6 months ago
Scripts pkg: fix plist, license and parsing thereof 8 months ago
contrib make: update parallel-lint to 1.3.2 3 months ago
src firmware: move previous to v= since it special handling for it already exists 1 day ago
work make: improve previous and add `upgrade' target while at it 6 years ago
+POST_INSTALL firmware: deal with *.pkgsave, offload post install bits to rc.syshook 1 year ago
+PRE_DEINSTALL firmware: kill the firmware-product.last trick 4 years ago
.editorconfig accidentally removed .editorconfig 5 years ago
.gitignore firmware: rename "opnsense" version file to "core" 4 years ago
CONTRIBUTING.md Update CONTRIBUTING.md 3 years ago
LICENSE src: fix typo and sync LICENSE 2 months ago
Makefile make: pkg 1.17 has a "unified suffix" 2 weeks ago
README.md firmware: switch to FreeBSD where appropriate 10 months ago
plist mvc: clean up previous 1 week ago
ruleset.xml make: change to PSR12 standard style, lots of noise coming up 3 years 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:

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_FLAVOUR: can be set to "OpenSSL" 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

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 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.