Developers Documentation

×

Warning

301 error for file:https://clearos.com/dokuwiki2/lib/exe/css.php?t=dokuwiki&tseed=82873f9c9a1f5784b951644363f20ef8

User Tools

Site Tools


Developer - Installing the Development Tools

Before getting underway, the first thing you need to do is install a ClearOS system. Thanks to the age of virtual machines, you no longer need dedicated hardware. Go ahead and install ClearOS on your favorite virtual machine (or dedicated hardware) and get it up and running.

Once you have the system up and running, login as 'root' through SSH instead of at the console. This will give you lots of advantages including the ability to scroll back easier and copy and paste information from this guide. For Windows workstations accessing the 'dev' environment, you can use PuTTY. For Mac, use the Terminal program located in the Utilities folder of your Applications. We will use root for now but will use a named user account later. Since you are maintaining a development environment, we recommend you keep the ClearOS Developer and EPEL software repositories enabled since most of the development tools live there:

yum-config-manager --enable clearos-developer

You can then install a basic set of development tools with the following commands:

yum upgrade
yum install clearos-devel app-devel

Don't forget to install the text editor of your choice, for example:

yum install vim-enhanced

For the legacy ClearOS 6 release, use:

 yum-config-manager --enable clearos-core clearos-centos clearos-epel clearos-developer
 yum upgrade
 yum --enablerepo=clearos-core,clearos-developer,clearos-epel install clearos-devel app-devel

Create the Environment

Now that all the development packages are installed, it is time to prep the following:

  • User Account Creation
  • Environment Variables
  • RPM Packaging Directories
  • Permissions and Sudoers
  • Development/Sandboxed Webconfig

You can find the technical details of each of the above steps in the Development Environment Reference - the following command performs all the necessary steps:

clearos setup

You will need to specify a username, password and default text editor.

In the clearos setup command, please specify a new user account instead of using an existing account in LDAP. In development mode, LDAP may not always be available so it is not advisable to use an LDAP user.

Now What

Framework - ClearOS Apps

If you are primarily interested in building web-based apps for ClearOS, then your next step is to continue building out your development environment. Continue your journey by reviewing Getting Started with ClearOS App Development.

Packaging - RPMs

If you are primarily interested in packaging and maintaining RPMs, you can jump right into the following Packaging documentation.

content/en_us/dev_development_environment.txt · Last modified: 2021/02/24 04:16 by nickh

https://clearos.com/dokuwiki2/lib/exe/indexer.php?id=content%3Aen_us%3Adev_development_environment&1710839890